do platform-specific checks after ensuring that the symbols we use are defined; extra...

[wxWidgets.git] / include / wx / colour.h

diff --git a/include/wx/colour.h b/include/wx/colour.h
index 15833968a46d03d6d1698c33223f408d91618e8a..ecce9a4943cb8fb9cd9b3aa0a033c0a30cff7e8e 100644 (file)
--- a/include/wx/colour.h
+++ b/include/wx/colour.h
@@ -16,16 +16,20 @@
 #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( unsigned char red, unsigned char green, unsigned char blue )      \
-        { Set(red, green, blue); }                                              \
-    wxColour( unsigned long colRGB ) { Set(colRGB); }                           \
-    wxColour(const wxString &colourName) { Set(colourName); }                   \
-    wxColour(const wxChar *colourName) { Set(colourName); }
+#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)
@@ -34,8 +38,17 @@
 #define wxC2S_HTML_SYNTAX       4   // return colour in #rrggbb syntax
 
 
-class WXDLLEXPORT wxColour;
+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
@@ -44,12 +57,10 @@ class WXDLLEXPORT wxColour;
 
 class WXDLLEXPORT wxColourBase : public wxGDIObject
 {
-protected:
-
-    virtual void InitWith(unsigned char red, unsigned char green, unsigned char blue) = 0;
-    virtual bool FromString(const wxChar *);
-
 public:
+    // type of a single colour component
+    typedef unsigned char ChannelType;
+
     wxColourBase() {}
     virtual ~wxColourBase() {}
 
@@ -57,23 +68,23 @@ public:
     // Set() functions
     // ---------------
 
-    void Set(unsigned char red, unsigned char green, unsigned char blue)
-        { InitWith(red,green,blue); }
+    void Set(ChannelType red,
+             ChannelType green,
+             ChannelType blue,
+             ChannelType alpha = wxALPHA_OPAQUE)
+        { InitRGBA(red,green,blue, alpha); }
 
     // implemented in colourcmn.cpp
-    bool Set(const wxChar *str)
-        { return FromString(str); }
-
     bool Set(const wxString &str)
-        { return Set((const wxChar *)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((unsigned char)colRGB,
-            (unsigned char)(colRGB >> 8),
-            (unsigned char)(colRGB >> 16));
+        Set((ChannelType)(0xFF & colRGB),
+            (ChannelType)(0xFF & (colRGB >> 8)),
+            (ChannelType)(0xFF & (colRGB >> 16)));
     }
 
 
@@ -81,11 +92,14 @@ public:
     // accessors
     // ---------
 
-    virtual bool Ok() const = 0;
+    virtual bool Ok() const { return IsOk(); }
+    virtual bool IsOk() const = 0;
 
-    virtual unsigned char Red() const = 0;
-    virtual unsigned char Green() const = 0;
-    virtual unsigned char Blue() 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;
@@ -99,33 +113,40 @@ public:
     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);
 };
 
 
 
 #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_