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 // Copyright:   Julian Smart
   8 // Licence:     wxWindows licence
   9 /////////////////////////////////////////////////////////////////////////////
  10
  11 #ifndef _WX_COLOUR_H_BASE_
  12 #define _WX_COLOUR_H_BASE_
  13
  14 #include "wx/defs.h"
  15 #include "wx/gdiobj.h"
  16
  17 class WXDLLIMPEXP_FWD_CORE wxColour;
  18
  19 // A macro to define the standard wxColour constructors:
  20 //
  21 // It avoids the need to repeat these lines across all colour.h files, since
  22 // Set() is a virtual function and thus cannot be called by wxColourBase ctors
  23 #define DEFINE_STD_WXCOLOUR_CONSTRUCTORS                                      \
  24     wxColour() { Init(); }                                                    \
  25     wxColour(ChannelType red,                                                 \
  26              ChannelType green,                                               \
  27              ChannelType blue,                                                \
  28              ChannelType alpha = wxALPHA_OPAQUE)                              \
  29         { Init(); Set(red, green, blue, alpha); }                             \
  30     wxColour(unsigned long colRGB) { Init(); Set(colRGB    ); }               \
  31     wxColour(const wxString& colourName) { Init(); Set(colourName); }         \
  32     wxColour(const char *colourName) { Init(); Set(colourName); }             \
  33     wxColour(const wchar_t *colourName) { Init(); Set(colourName); }
  34
  35
  36 // flags for wxColour -> wxString conversion (see wxColour::GetAsString)
  37 enum {
  38     wxC2S_NAME             = 1,   // return colour name, when possible
  39     wxC2S_CSS_SYNTAX       = 2,   // return colour in rgb(r,g,b) syntax
  40     wxC2S_HTML_SYNTAX      = 4    // return colour in #rrggbb syntax
  41 };
  42
  43 const unsigned char wxALPHA_TRANSPARENT = 0;
  44 const unsigned char wxALPHA_OPAQUE = 0xff;
  45
  46 // a valid but fully transparent colour
  47 #define wxTransparentColour wxColour(0, 0, 0, wxALPHA_TRANSPARENT)
  48 #define wxTransparentColor wxTransparentColour
  49
  50 // ----------------------------------------------------------------------------
  51 // wxVariant support
  52 // ----------------------------------------------------------------------------
  53
  54 #if wxUSE_VARIANT
  55 #include "wx/variant.h"
  56 DECLARE_VARIANT_OBJECT_EXPORTED(wxColour,WXDLLIMPEXP_CORE)
  57 #endif
  58
  59 //-----------------------------------------------------------------------------
  60 // wxColourBase: this class has no data members, just some functions to avoid
  61 //               code redundancy in all native wxColour implementations
  62 //-----------------------------------------------------------------------------
  63
  64 /*  Transition from wxGDIObject to wxObject is incomplete.  If your port does
  65     not need the wxGDIObject machinery to handle colors, please add it to the
  66     list of ports which do not need it.
  67  */
  68 #if defined( __WXMAC__ ) || defined( __WXMSW__ ) || defined( __WXPM__ ) || defined( __WXCOCOA__ )
  69 #define wxCOLOUR_IS_GDIOBJECT 0
  70 #else
  71 #define wxCOLOUR_IS_GDIOBJECT 1
  72 #endif
  73
  74 class WXDLLIMPEXP_CORE wxColourBase : public
  75 #if wxCOLOUR_IS_GDIOBJECT
  76     wxGDIObject
  77 #else
  78     wxObject
  79 #endif
  80 {
  81 public:
  82     // type of a single colour component
  83     typedef unsigned char ChannelType;
  84
  85     wxColourBase() {}
  86     virtual ~wxColourBase() {}
  87
  88
  89     // Set() functions
  90     // ---------------
  91
  92     void Set(ChannelType red,
  93              ChannelType green,
  94              ChannelType blue,
  95              ChannelType alpha = wxALPHA_OPAQUE)
  96         { InitRGBA(red, green, blue, alpha); }
  97
  98     // implemented in colourcmn.cpp
  99     bool Set(const wxString &str)
 100         { return FromString(str); }
 101
 102     void Set(unsigned long colRGB)
 103     {
 104         // we don't need to know sizeof(long) here because we assume that the three
 105         // least significant bytes contain the R, G and B values
 106         Set((ChannelType)(0xFF & colRGB),
 107             (ChannelType)(0xFF & (colRGB >> 8)),
 108             (ChannelType)(0xFF & (colRGB >> 16)));
 109     }
 110
 111
 112
 113     // accessors
 114     // ---------
 115
 116     virtual ChannelType Red() const = 0;
 117     virtual ChannelType Green() const = 0;
 118     virtual ChannelType Blue() const = 0;
 119     virtual ChannelType Alpha() const
 120         { return wxALPHA_OPAQUE ; }
 121
 122     // implemented in colourcmn.cpp
 123     virtual wxString GetAsString(long flags = wxC2S_NAME | wxC2S_CSS_SYNTAX) const;
 124
 125     void SetRGB(wxUint32 colRGB)
 126     {
 127         Set((ChannelType)(0xFF & colRGB),
 128             (ChannelType)(0xFF & (colRGB >> 8)),
 129             (ChannelType)(0xFF & (colRGB >> 16)));
 130     }
 131
 132     void SetRGBA(wxUint32 colRGBA)
 133     {
 134         Set((ChannelType)(0xFF & colRGBA),
 135             (ChannelType)(0xFF & (colRGBA >> 8)),
 136             (ChannelType)(0xFF & (colRGBA >> 16)),
 137             (ChannelType)(0xFF & (colRGBA >> 24)));
 138     }
 139
 140     wxUint32 GetRGB() const
 141         { return Red() | (Green() << 8) | (Blue() << 16); }
 142
 143     wxUint32 GetRGBA() const
 144         { return Red() | (Green() << 8) | (Blue() << 16) | (Alpha() << 24); }
 145
 146 #if !wxCOLOUR_IS_GDIOBJECT
 147     virtual bool IsOk() const= 0;
 148
 149     // older version, for backwards compatibility only (but not deprecated
 150     // because it's still widely used)
 151     bool Ok() const { return IsOk(); }
 152 #endif
 153
 154     // manipulation
 155     // ------------
 156
 157     // These methods are static because they are mostly used
 158     // within tight loops (where we don't want to instantiate wxColour's)
 159
 160     static void          MakeMono    (unsigned char* r, unsigned char* g, unsigned char* b, bool on);
 161     static void          MakeDisabled(unsigned char* r, unsigned char* g, unsigned char* b, unsigned char brightness = 255);
 162     static void          MakeGrey    (unsigned char* r, unsigned char* g, unsigned char* b); // integer version
 163     static void          MakeGrey    (unsigned char* r, unsigned char* g, unsigned char* b,
 164                                       double weight_r, double weight_g, double weight_b); // floating point version
 165     static unsigned char AlphaBlend  (unsigned char fg, unsigned char bg, double alpha);
 166     static void          ChangeLightness(unsigned char* r, unsigned char* g, unsigned char* b, int ialpha);
 167
 168     wxColour ChangeLightness(int ialpha) const;
 169     wxColour& MakeDisabled(unsigned char brightness = 255);
 170
 171     // old, deprecated
 172     // ---------------
 173
 174 #if WXWIN_COMPATIBILITY_2_6
 175     static wxDEPRECATED( wxColour CreateByName(const wxString& name) );
 176     wxDEPRECATED( void InitFromName(const wxString& col) );
 177 #endif
 178
 179 protected:
 180     // Some ports need Init() and while we don't, provide a stub so that the
 181     // ports which don't need it are not forced to define it
 182     void Init() { }
 183
 184     virtual void
 185     InitRGBA(ChannelType r, ChannelType g, ChannelType b, ChannelType a) = 0;
 186
 187     virtual bool FromString(const wxString& s);
 188
 189 #if wxCOLOUR_IS_GDIOBJECT
 190     // wxColour doesn't use reference counted data (at least not in all ports)
 191     // so provide stubs for the functions which need to be defined if we do use
 192     // them
 193     virtual wxGDIRefData *CreateGDIRefData() const
 194     {
 195         wxFAIL_MSG( "must be overridden if used" );
 196
 197         return NULL;
 198     }
 199
 200     virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *WXUNUSED(data)) const
 201     {
 202         wxFAIL_MSG( "must be overridden if used" );
 203
 204         return NULL;
 205     }
 206 #endif
 207 };
 208
 209
 210 // wxColour <-> wxString utilities, used by wxConfig, defined in colourcmn.cpp
 211 WXDLLIMPEXP_CORE wxString wxToString(const wxColourBase& col);
 212 WXDLLIMPEXP_CORE bool wxFromString(const wxString& str, wxColourBase* col);
 213
 214
 215
 216 #if defined(__WXMSW__)
 217     #include "wx/msw/colour.h"
 218 #elif defined(__WXMOTIF__)
 219     #include "wx/motif/colour.h"
 220 #elif defined(__WXGTK20__)
 221     #include "wx/gtk/colour.h"
 222 #elif defined(__WXGTK__)
 223     #include "wx/gtk1/colour.h"
 224 #elif defined(__WXDFB__)
 225     #include "wx/generic/colour.h"
 226 #elif defined(__WXX11__)
 227     #include "wx/x11/colour.h"
 228 #elif defined(__WXMAC__)
 229     #include "wx/osx/colour.h"
 230 #elif defined(__WXCOCOA__)
 231     #include "wx/cocoa/colour.h"
 232 #elif defined(__WXPM__)
 233     #include "wx/os2/colour.h"
 234 #endif
 235
 236 #define wxColor wxColour
 237
 238 #endif // _WX_COLOUR_H_BASE_