include/wx/colour.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/colour.h
   3 // Purpose:     wxColourBase definition
   4 // Author:      Julian Smart
   5 // Modified by: Francesco Montorsi
   6 // Created:
   7 // RCS-ID:      $Id$
   8 // Copyright:   Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_COLOUR_H_BASE_
  13 #define _WX_COLOUR_H_BASE_
  14
  15 #include "wx/defs.h"
  16 #include "wx/gdiobj.h"
  17
  18
  19 class WXDLLIMPEXP_FWD_CORE wxColour;
  20
  21 // A macro to define the standard wxColour constructors:
  22 //
  23 // It avoids the need to repeat these lines across all colour.h files, since
  24 // Set() is a virtual function and thus cannot be called by wxColourBase ctors
  25 #define DEFINE_STD_WXCOLOUR_CONSTRUCTORS                                      \
  26     wxColour() { Init(); }                                                    \
  27     wxColour(ChannelType red,                                                 \
  28              ChannelType green,                                               \
  29              ChannelType blue,                                                \
  30              ChannelType alpha = wxALPHA_OPAQUE)                              \
  31         { Init(); Set(red, green, blue, alpha); }                             \
  32     wxColour(unsigned long colRGB) { Init(); Set(colRGB    ); }               \
  33     wxColour(const wxString& colourName) { Init(); Set(colourName); }         \
  34     wxColour(const char *colourName) { Init(); Set(colourName); }             \
  35     wxColour(const wchar_t *colourName) { Init(); Set(colourName); }
  36
  37
  38 // flags for wxColour -> wxString conversion (see wxColour::GetAsString)
  39 #define wxC2S_NAME              1   // return colour name, when possible
  40 #define wxC2S_CSS_SYNTAX        2   // return colour in rgb(r,g,b) syntax
  41 #define wxC2S_HTML_SYNTAX       4   // return colour in #rrggbb syntax
  42
  43
  44 const unsigned char wxALPHA_TRANSPARENT = 0;
  45 const unsigned char wxALPHA_OPAQUE = 0xff;
  46
  47 // ----------------------------------------------------------------------------
  48 // wxVariant support
  49 // ----------------------------------------------------------------------------
  50
  51 #if wxUSE_VARIANT
  52 #include "wx/variant.h"
  53 DECLARE_VARIANT_OBJECT_EXPORTED(wxColour,WXDLLEXPORT)
  54 #endif
  55
  56 //-----------------------------------------------------------------------------
  57 // wxColourBase: this class has no data members, just some functions to avoid
  58 //               code redundancy in all native wxColour implementations
  59 //-----------------------------------------------------------------------------
  60
  61 #if defined( __WXMAC__ ) || defined( __WXMSW__ ) || defined( __WXPM__ )
  62 #define wxCOLOUR_IS_GDIOBJECT 0
  63 #else
  64 #define wxCOLOUR_IS_GDIOBJECT 1
  65 #endif
  66
  67 class WXDLLEXPORT wxColourBase : public
  68 #if wxCOLOUR_IS_GDIOBJECT
  69     wxGDIObject
  70 #else
  71     wxObject
  72 #endif
  73 {
  74 public:
  75     // type of a single colour component
  76     typedef unsigned char ChannelType;
  77
  78     wxColourBase() {}
  79     virtual ~wxColourBase() {}
  80
  81
  82     // Set() functions
  83     // ---------------
  84
  85     void Set(ChannelType red,
  86              ChannelType green,
  87              ChannelType blue,
  88              ChannelType alpha = wxALPHA_OPAQUE)
  89         { InitRGBA(red,green,blue, alpha); }
  90
  91     // implemented in colourcmn.cpp
  92     bool Set(const wxString &str)
  93         { return FromString(str); }
  94
  95     void Set(unsigned long colRGB)
  96     {
  97         // we don't need to know sizeof(long) here because we assume that the three
  98         // least significant bytes contain the R, G and B values
  99         Set((ChannelType)(0xFF & colRGB),
 100             (ChannelType)(0xFF & (colRGB >> 8)),
 101             (ChannelType)(0xFF & (colRGB >> 16)));
 102     }
 103
 104
 105
 106     // accessors
 107     // ---------
 108
 109     virtual ChannelType Red() const = 0;
 110     virtual ChannelType Green() const = 0;
 111     virtual ChannelType Blue() const = 0;
 112     virtual ChannelType Alpha() const
 113         { return wxALPHA_OPAQUE ; }
 114
 115     // implemented in colourcmn.cpp
 116     virtual wxString GetAsString(long flags = wxC2S_NAME | wxC2S_CSS_SYNTAX) const;
 117
 118 #if !wxCOLOUR_IS_GDIOBJECT
 119     virtual bool IsOk() const= 0;
 120
 121     // older version, for backwards compatibility only (but not deprecated
 122     // because it's still widely used)
 123     bool Ok() const { return IsOk(); }
 124 #endif
 125
 126     // old, deprecated
 127     // ---------------
 128
 129 #if WXWIN_COMPATIBILITY_2_6
 130     wxDEPRECATED( static wxColour CreateByName(const wxString& name) );
 131     wxDEPRECATED( void InitFromName(const wxString& col) );
 132 #endif
 133
 134 protected:
 135     // Some ports need Init() and while we don't, provide a stub so that the
 136     // ports which don't need it are not forced to define it
 137     void Init() { }
 138
 139     virtual void
 140     InitRGBA(ChannelType r, ChannelType g, ChannelType b, ChannelType a) = 0;
 141
 142     virtual bool FromString(const wxString& s);
 143
 144 #if wxCOLOUR_IS_GDIOBJECT
 145     // wxColour doesn't use reference counted data (at least not in all ports)
 146     // so provide stubs for the functions which need to be defined if we do use
 147     // them
 148     virtual wxGDIRefData *CreateGDIRefData() const
 149     {
 150         wxFAIL_MSG( "must be overridden if used" );
 151
 152         return NULL;
 153     }
 154
 155     virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *WXUNUSED(data)) const
 156     {
 157         wxFAIL_MSG( "must be overridden if used" );
 158
 159         return NULL;
 160     }
 161 #endif
 162 };
 163
 164
 165 // wxColour <-> wxString utilities, used by wxConfig, defined in colourcmn.cpp
 166 WXDLLIMPEXP_CORE wxString wxToString(const wxColourBase& col);
 167 WXDLLIMPEXP_CORE bool wxFromString(const wxString& str, wxColourBase* col);
 168
 169
 170
 171 #if defined(__WXPALMOS__)
 172     #include "wx/generic/colour.h"
 173 #elif defined(__WXMSW__)
 174     #include "wx/msw/colour.h"
 175 #elif defined(__WXMOTIF__)
 176     #include "wx/motif/colour.h"
 177 #elif defined(__WXGTK20__)
 178     #include "wx/gtk/colour.h"
 179 #elif defined(__WXGTK__)
 180     #include "wx/gtk1/colour.h"
 181 #elif defined(__WXMGL__)
 182     #include "wx/generic/colour.h"
 183 #elif defined(__WXDFB__)
 184     #include "wx/generic/colour.h"
 185 #elif defined(__WXX11__)
 186     #include "wx/x11/colour.h"
 187 #elif defined(__WXMAC__)
 188     #include "wx/mac/colour.h"
 189 #elif defined(__WXCOCOA__)
 190     #include "wx/cocoa/colour.h"
 191 #elif defined(__WXPM__)
 192     #include "wx/os2/colour.h"
 193 #endif
 194
 195 #define wxColor wxColour
 196
 197 #endif // _WX_COLOUR_H_BASE_