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