capitalize the application name in GetAppDisplayName() by default; this results in...

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

diff --git a/include/wx/colour.h b/include/wx/colour.h
index 78204d1843c62c982d63fb3236f7e271ddceaabd..68f68457879c6f2d37c31eb12ae807bea6e6ca1c 100644 (file)
--- a/include/wx/colour.h
+++ b/include/wx/colour.h
@@ -16,17 +16,23 @@
 #include "wx/gdiobj.h"
 
 
 #include "wx/gdiobj.h"
 
 

-// 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
+class WXDLLIMPEXP_FWD_CORE wxColour;
+
+// A macro to define the standard wxColour constructors:
+//
+// It avoids the need to repeat these lines across all colour.h files, since
+// Set() is a virtual function and thus cannot be called by wxColourBase ctors

 #define DEFINE_STD_WXCOLOUR_CONSTRUCTORS                                      \
 #define DEFINE_STD_WXCOLOUR_CONSTRUCTORS                                      \

-    wxColour( unsigned char red, unsigned char green, unsigned char blue,     \
-              unsigned char alpha = wxALPHA_OPAQUE )                          \
-        { Set(red, green, blue, alpha); }                                     \
-    wxColour( unsigned long colRGB ) { Set(colRGB); }                         \
-    wxColour(const wxString &colourName) { Set(colourName); }                 \
-    wxColour(const wxChar *colourName) { Set(colourName); }
+    wxColour() { Init(); }                                                    \
+    wxColour(ChannelType red,                                                 \
+             ChannelType green,                                               \
+             ChannelType blue,                                                \
+             ChannelType alpha = wxALPHA_OPAQUE)                              \
+        { Init(); Set(red, green, blue, alpha); }                             \
+    wxColour(unsigned long colRGB) { Init(); Set(colRGB    ); }               \
+    wxColour(const wxString& colourName) { Init(); Set(colourName); }         \
+    wxColour(const char *colourName) { Init(); Set(colourName); }             \
+    wxColour(const wchar_t *colourName) { Init(); Set(colourName); }

 
 
 // flags for wxColour -> wxString conversion (see wxColour::GetAsString)
 
 
 // flags for wxColour -> wxString conversion (see wxColour::GetAsString)


@@ -35,31 +41,44 @@
 #define wxC2S_HTML_SYNTAX       4   // return colour in #rrggbb syntax
 
 
 #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;
 
 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,WXDLLIMPEXP_CORE)
+#endif
+

 //-----------------------------------------------------------------------------
 // wxColourBase: this class has no data members, just some functions to avoid
 //               code redundancy in all native wxColour implementations
 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------
 // wxColourBase: this class has no data members, just some functions to avoid
 //               code redundancy in all native wxColour implementations
 //-----------------------------------------------------------------------------
 

-class WXDLLEXPORT wxColourBase : public wxGDIObject
-{
-protected:
-
-    virtual void InitWith(unsigned char red, unsigned char green, unsigned char blue) = 0;
-
-    // this will be overridden in alpha supporting classes
-    virtual void InitWith(unsigned char red, unsigned char green, unsigned char blue, unsigned char WXUNUSED(alpha)) 
-    {
-        InitWith( red, green, blue ) ;
-    }
-
-    virtual bool FromString(const wxChar *);
+/*  Transition from wxGDIObject to wxObject is incomplete.  If your port does
+    not need the wxGDIObject machinery to handle colors, please add it to the
+    list of ports which do not need it.
+ */
+#if defined( __WXMAC__ ) || defined( __WXMSW__ ) || defined( __WXPM__ ) || defined( __WXCOCOA__ )
+#define wxCOLOUR_IS_GDIOBJECT 0
+#else
+#define wxCOLOUR_IS_GDIOBJECT 1
+#endif

 
 

+class WXDLLIMPEXP_CORE wxColourBase : public
+#if wxCOLOUR_IS_GDIOBJECT
+    wxGDIObject
+#else
+    wxObject
+#endif
+{

 public:
 public:

+    // type of a single colour component
+    typedef unsigned char ChannelType;
+

     wxColourBase() {}
     virtual ~wxColourBase() {}
 
     wxColourBase() {}
     virtual ~wxColourBase() {}
 


@@ -67,23 +86,23 @@ public:
     // Set() functions
     // ---------------
 
     // Set() functions
     // ---------------
 

-    void Set(unsigned char red, unsigned char green, unsigned char blue, unsigned char alpha = wxALPHA_OPAQUE)
-        { InitWith(red,green,blue, alpha); }
+    void Set(ChannelType red,
+             ChannelType green,
+             ChannelType blue,
+             ChannelType alpha = wxALPHA_OPAQUE)
+        { InitRGBA(red,green,blue, alpha); }

 
     // implemented in colourcmn.cpp
 
     // implemented in colourcmn.cpp

-    bool Set(const wxChar *str)
-        { return FromString(str); }
-

     bool Set(const wxString &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
 
     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)));

     }
 
 
     }
 
 


@@ -91,18 +110,22 @@ public:
     // accessors
     // ---------
 
     // accessors
     // ---------
 

-    virtual bool Ok() const = 0;
-
-    virtual unsigned char Red() const = 0;
-    virtual unsigned char Green() const = 0;
-    virtual unsigned char Blue() const = 0;
-    virtual unsigned char Alpha() const
+    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;
 
         { return wxALPHA_OPAQUE ; }
 
     // implemented in colourcmn.cpp
     virtual wxString GetAsString(long flags = wxC2S_NAME | wxC2S_CSS_SYNTAX) const;
 

+#if !wxCOLOUR_IS_GDIOBJECT
+    virtual bool IsOk() const= 0;

 
 

+    // older version, for backwards compatibility only (but not deprecated
+    // because it's still widely used)
+    bool Ok() const { return IsOk(); }
+#endif

 
     // old, deprecated
     // ---------------
 
     // old, deprecated
     // ---------------


@@ -111,35 +134,68 @@ public:
     wxDEPRECATED( static wxColour CreateByName(const wxString& name) );
     wxDEPRECATED( void InitFromName(const wxString& col) );
 #endif
     wxDEPRECATED( static wxColour CreateByName(const wxString& name) );
     wxDEPRECATED( void InitFromName(const wxString& col) );
 #endif

+
+protected:
+    // Some ports need Init() and while we don't, provide a stub so that the
+    // ports which don't need it are not forced to define it
+    void Init() { }
+
+    virtual void
+    InitRGBA(ChannelType r, ChannelType g, ChannelType b, ChannelType a) = 0;
+
+    virtual bool FromString(const wxString& s);
+
+#if wxCOLOUR_IS_GDIOBJECT
+    // wxColour doesn't use reference counted data (at least not in all ports)
+    // so provide stubs for the functions which need to be defined if we do use
+    // them
+    virtual wxGDIRefData *CreateGDIRefData() const
+    {
+        wxFAIL_MSG( "must be overridden if used" );
+
+        return NULL;
+    }
+
+    virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *WXUNUSED(data)) const
+    {
+        wxFAIL_MSG( "must be overridden if used" );
+
+        return NULL;
+    }
+#endif

 };
 
 
 };
 
 

+// 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__)
 
 #if defined(__WXPALMOS__)

-#include "wx/generic/colour.h"
+    #include "wx/generic/colour.h"

 #elif defined(__WXMSW__)
 #elif defined(__WXMSW__)

-#include "wx/msw/colour.h"
+    #include "wx/msw/colour.h"

 #elif defined(__WXMOTIF__)
 #elif defined(__WXMOTIF__)

-#include "wx/motif/colour.h"
+    #include "wx/motif/colour.h"

 #elif defined(__WXGTK20__)
 #elif defined(__WXGTK20__)

-#include "wx/gtk/colour.h"
+    #include "wx/gtk/colour.h"

 #elif defined(__WXGTK__)
 #elif defined(__WXGTK__)

-#include "wx/gtk1/colour.h"
+    #include "wx/gtk1/colour.h"

 #elif defined(__WXMGL__)
 #elif defined(__WXMGL__)

-#include "wx/generic/colour.h"
+    #include "wx/generic/colour.h"

 #elif defined(__WXDFB__)
 #elif defined(__WXDFB__)

-#include "wx/generic/colour.h"
+    #include "wx/generic/colour.h"

 #elif defined(__WXX11__)
 #elif defined(__WXX11__)

-#include "wx/x11/colour.h"
+    #include "wx/x11/colour.h"

 #elif defined(__WXMAC__)
 #elif defined(__WXMAC__)

-#include "wx/mac/colour.h"
+    #include "wx/osx/colour.h"

 #elif defined(__WXCOCOA__)
 #elif defined(__WXCOCOA__)

-#include "wx/cocoa/colour.h"
+    #include "wx/cocoa/colour.h"

 #elif defined(__WXPM__)
 #elif defined(__WXPM__)

-#include "wx/os2/colour.h"
+    #include "wx/os2/colour.h"

 #endif
 
 #define wxColor wxColour
 
 #endif
 
 #define wxColor wxColour
 

-#endif
-    // _WX_COLOUR_H_BASE_
+#endif // _WX_COLOUR_H_BASE_