X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e45689df6ca927c2105dd27cd57847a4fad45669..52170c5b4419c63d6e0083df411aad420395ec98:/include/wx/colour.h?ds=inline diff --git a/include/wx/colour.h b/include/wx/colour.h index b736ad8bbe..afe6371475 100644 --- a/include/wx/colour.h +++ b/include/wx/colour.h @@ -1,8 +1,8 @@ ///////////////////////////////////////////////////////////////////////////// // Name: wx/colour.h -// Purpose: Includes platform-specific wxColour file +// Purpose: wxColourBase definition // Author: Julian Smart -// Modified by: +// Modified by: Francesco Montorsi // Created: // RCS-ID: $Id$ // Copyright: Julian Smart @@ -13,30 +13,145 @@ #define _WX_COLOUR_H_BASE_ #include "wx/defs.h" +#include "wx/gdiobj.h" + + +class WXDLLIMPEXP_FWD_CORE wxColour; + +// the standard wxColour constructors; +// this macro avoids to repeat these lines across all colour.h files, since +// Set() is a virtual function and thus cannot be called by wxColourBase +// constructors +#define DEFINE_STD_WXCOLOUR_CONSTRUCTORS \ + wxColour( ChannelType red, ChannelType green, ChannelType blue, \ + ChannelType alpha = wxALPHA_OPAQUE ) \ + { Set(red, green, blue, alpha); } \ + wxColour( unsigned long colRGB ) { Set(colRGB); } \ + wxColour(const wxString& colourName) { Set(colourName); } \ + wxColour(const char *colourName) { Set(colourName); } \ + wxColour(const wchar_t *colourName) { Set(colourName); } + + +// flags for wxColour -> wxString conversion (see wxColour::GetAsString) +#define wxC2S_NAME 1 // return colour name, when possible +#define wxC2S_CSS_SYNTAX 2 // return colour in rgb(r,g,b) syntax +#define wxC2S_HTML_SYNTAX 4 // return colour in #rrggbb syntax + + +const unsigned char wxALPHA_TRANSPARENT = 0; +const unsigned char wxALPHA_OPAQUE = 0xff; + +// ---------------------------------------------------------------------------- +// wxVariant support +// ---------------------------------------------------------------------------- + +#if wxUSE_VARIANT +#include "wx/variant.h" +DECLARE_VARIANT_OBJECT_EXPORTED(wxColour,WXDLLEXPORT) +#endif + +//----------------------------------------------------------------------------- +// wxColourBase: this class has no data members, just some functions to avoid +// code redundancy in all native wxColour implementations +//----------------------------------------------------------------------------- + +class WXDLLEXPORT wxColourBase : public wxGDIObject +{ +public: + // type of a single colour component + typedef unsigned char ChannelType; + + wxColourBase() {} + virtual ~wxColourBase() {} + + + // Set() functions + // --------------- + + void Set(ChannelType red, + ChannelType green, + ChannelType blue, + ChannelType alpha = wxALPHA_OPAQUE) + { InitRGBA(red,green,blue, alpha); } + + // implemented in colourcmn.cpp + bool Set(const wxString &str) + { return FromString(str); } + + void Set(unsigned long colRGB) + { + // we don't need to know sizeof(long) here because we assume that the three + // least significant bytes contain the R, G and B values + Set((ChannelType)(0xFF & colRGB), + (ChannelType)(0xFF & (colRGB >> 8)), + (ChannelType)(0xFF & (colRGB >> 16))); + } + + + + // accessors + // --------- + + virtual bool Ok() const { return IsOk(); } + virtual bool IsOk() const = 0; + + virtual ChannelType Red() const = 0; + virtual ChannelType Green() const = 0; + virtual ChannelType Blue() const = 0; + virtual ChannelType Alpha() const + { return wxALPHA_OPAQUE ; } + + // implemented in colourcmn.cpp + virtual wxString GetAsString(long flags = wxC2S_NAME | wxC2S_CSS_SYNTAX) const; + + + + // old, deprecated + // --------------- + +#if WXWIN_COMPATIBILITY_2_6 + wxDEPRECATED( static wxColour CreateByName(const wxString& name) ); + wxDEPRECATED( void InitFromName(const wxString& col) ); +#endif + +protected: + virtual void + InitRGBA(ChannelType r, ChannelType g, ChannelType b, ChannelType a) = 0; + + virtual bool FromString(const wxString& s); +}; + + +// wxColour <-> wxString utilities, used by wxConfig, defined in colourcmn.cpp +WXDLLIMPEXP_CORE wxString wxToString(const wxColourBase& col); +WXDLLIMPEXP_CORE bool wxFromString(const wxString& str, wxColourBase* col); + + #if defined(__WXPALMOS__) -#include "wx/palmos/colour.h" + #include "wx/generic/colour.h" #elif defined(__WXMSW__) -#include "wx/msw/colour.h" + #include "wx/msw/colour.h" #elif defined(__WXMOTIF__) -#include "wx/motif/colour.h" + #include "wx/motif/colour.h" #elif defined(__WXGTK20__) -#include "wx/gtk/colour.h" + #include "wx/gtk/colour.h" #elif defined(__WXGTK__) -#include "wx/gtk1/colour.h" + #include "wx/gtk1/colour.h" #elif defined(__WXMGL__) -#include "wx/mgl/colour.h" + #include "wx/generic/colour.h" +#elif defined(__WXDFB__) + #include "wx/generic/colour.h" #elif defined(__WXX11__) -#include "wx/x11/colour.h" + #include "wx/x11/colour.h" #elif defined(__WXMAC__) -#include "wx/mac/colour.h" + #include "wx/mac/colour.h" #elif defined(__WXCOCOA__) -#include "wx/cocoa/colour.h" + #include "wx/cocoa/colour.h" #elif defined(__WXPM__) -#include "wx/os2/colour.h" + #include "wx/os2/colour.h" #endif #define wxColor wxColour -#endif - // _WX_COLOUR_H_BASE_ +#endif // _WX_COLOUR_H_BASE_