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 20b673b39a07acf3625c3b40a7f653e30f37c21b..68f68457879c6f2d37c31eb12ae807bea6e6ca1c 100644 (file)
--- a/include/wx/colour.h
+++ b/include/wx/colour.h
@@ -16,19 +16,23 @@
 #include "wx/gdiobj.h"
 
 
-class WXDLLEXPORT wxColour;
+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
+// 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                                      \
-    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 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)
@@ -46,7 +50,7 @@ const unsigned char wxALPHA_OPAQUE = 0xff;
 
 #if wxUSE_VARIANT
 #include "wx/variant.h"
-DECLARE_VARIANT_OBJECT_EXPORTED(wxColour,WXDLLEXPORT)
+DECLARE_VARIANT_OBJECT_EXPORTED(wxColour,WXDLLIMPEXP_CORE)
 #endif
 
 //-----------------------------------------------------------------------------
@@ -54,7 +58,22 @@ DECLARE_VARIANT_OBJECT_EXPORTED(wxColour,WXDLLEXPORT)
 //               code redundancy in all native wxColour implementations
 //-----------------------------------------------------------------------------
 
-class WXDLLEXPORT wxColourBase : public wxGDIObject
+/*  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:
     // type of a single colour component
@@ -74,9 +93,6 @@ public:
         { InitRGBA(red,green,blue, alpha); }
 
     // implemented in colourcmn.cpp
-    bool Set(const wxChar *str)
-        { return FromString(str); }
-
     bool Set(const wxString &str)
         { return FromString(str); }
 
@@ -94,9 +110,6 @@ public:
     // 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;
@@ -106,7 +119,13 @@ public:
     // 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
     // ---------------
@@ -117,13 +136,41 @@ public:
 #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 wxChar *s);
+    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__)
     #include "wx/generic/colour.h"
@@ -142,7 +189,7 @@ protected:
 #elif defined(__WXX11__)
     #include "wx/x11/colour.h"
 #elif defined(__WXMAC__)
-    #include "wx/mac/colour.h"
+    #include "wx/osx/colour.h"
 #elif defined(__WXCOCOA__)
     #include "wx/cocoa/colour.h"
 #elif defined(__WXPM__)