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