supporting clang memory management annotations

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

diff --git a/include/wx/colour.h b/include/wx/colour.h
index b0296e860ed1d64088e535f72ddfcb5bd566d792..eac59a6bd77f675a95370605abfc98bbf428d440 100644 (file)
--- a/include/wx/colour.h
+++ b/include/wx/colour.h
@@ -15,7 +15,6 @@
 #include "wx/defs.h"
 #include "wx/gdiobj.h"
 
-
 class WXDLLIMPEXP_FWD_CORE wxColour;
 
 // A macro to define the standard wxColour constructors:
@@ -36,21 +35,26 @@ class WXDLLIMPEXP_FWD_CORE wxColour;
 
 
 // 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
-
+enum {
+    wxC2S_NAME             = 1,   // return colour name, when possible
+    wxC2S_CSS_SYNTAX       = 2,   // return colour in rgb(r,g,b) syntax
+    wxC2S_HTML_SYNTAX      = 4    // return colour in #rrggbb syntax
+};
 
 const unsigned char wxALPHA_TRANSPARENT = 0;
 const unsigned char wxALPHA_OPAQUE = 0xff;
 
+// a valid but fully transparent colour
+#define wxTransparentColour wxColour(0, 0, 0, wxALPHA_TRANSPARENT)
+#define wxTransparentColor wxTransparentColour
+
 // ----------------------------------------------------------------------------
 // wxVariant support
 // ----------------------------------------------------------------------------
 
 #if wxUSE_VARIANT
 #include "wx/variant.h"
-DECLARE_VARIANT_OBJECT_EXPORTED(wxColour,WXDLLEXPORT)
+DECLARE_VARIANT_OBJECT_EXPORTED(wxColour,WXDLLIMPEXP_CORE)
 #endif
 
 //-----------------------------------------------------------------------------
@@ -58,13 +62,17 @@ DECLARE_VARIANT_OBJECT_EXPORTED(wxColour,WXDLLEXPORT)
 //               code redundancy in all native wxColour implementations
 //-----------------------------------------------------------------------------
 
-#if defined( __WXMAC__ ) || defined( __WXMSW__ )
+/*  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 WXDLLEXPORT wxColourBase : public 
+class WXDLLIMPEXP_CORE wxColourBase : public
 #if wxCOLOUR_IS_GDIOBJECT
     wxGDIObject
 #else
@@ -86,7 +94,7 @@ public:
              ChannelType green,
              ChannelType blue,
              ChannelType alpha = wxALPHA_OPAQUE)
-        { InitRGBA(red,green,blue, alpha); }
+        { InitRGBA(red, green, blue, alpha); }
 
     // implemented in colourcmn.cpp
     bool Set(const wxString &str)
@@ -115,19 +123,56 @@ public:
     // implemented in colourcmn.cpp
     virtual wxString GetAsString(long flags = wxC2S_NAME | wxC2S_CSS_SYNTAX) const;
 
+    void SetRGB(wxUint32 colRGB)
+    {
+        Set((ChannelType)(0xFF & colRGB),
+            (ChannelType)(0xFF & (colRGB >> 8)),
+            (ChannelType)(0xFF & (colRGB >> 16)));
+    }
+
+    void SetRGBA(wxUint32 colRGBA)
+    {
+        Set((ChannelType)(0xFF & colRGBA),
+            (ChannelType)(0xFF & (colRGBA >> 8)),
+            (ChannelType)(0xFF & (colRGBA >> 16)),
+            (ChannelType)(0xFF & (colRGBA >> 24)));
+    }
+
+    wxUint32 GetRGB() const
+        { return Red() | (Green() << 8) | (Blue() << 16); }
+
+    wxUint32 GetRGBA() const
+        { return Red() | (Green() << 8) | (Blue() << 16) | (Alpha() << 24); }
+
 #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
 
+    // manipulation
+    // ------------
+
+    // These methods are static because they are mostly used
+    // within tight loops (where we don't want to instantiate wxColour's)
+
+    static void          MakeMono    (unsigned char* r, unsigned char* g, unsigned char* b, bool on);
+    static void          MakeDisabled(unsigned char* r, unsigned char* g, unsigned char* b, unsigned char brightness = 255);
+    static void          MakeGrey    (unsigned char* r, unsigned char* g, unsigned char* b); // integer version
+    static void          MakeGrey    (unsigned char* r, unsigned char* g, unsigned char* b,
+                                      double weight_r, double weight_g, double weight_b); // floating point version
+    static unsigned char AlphaBlend  (unsigned char fg, unsigned char bg, double alpha);
+    static void          ChangeLightness(unsigned char* r, unsigned char* g, unsigned char* b, int ialpha);
+
+    wxColour ChangeLightness(int ialpha) const;
+
     // old, deprecated
     // ---------------
 
 #if WXWIN_COMPATIBILITY_2_6
-    wxDEPRECATED( static wxColour CreateByName(const wxString& name) );
+    static wxDEPRECATED( wxColour CreateByName(const wxString& name) );
     wxDEPRECATED( void InitFromName(const wxString& col) );
 #endif
 
@@ -168,9 +213,7 @@ WXDLLIMPEXP_CORE bool wxFromString(const wxString& str, wxColourBase* col);
 
 
 
-#if defined(__WXPALMOS__)
-    #include "wx/generic/colour.h"
-#elif defined(__WXMSW__)
+#if defined(__WXMSW__)
     #include "wx/msw/colour.h"
 #elif defined(__WXMOTIF__)
     #include "wx/motif/colour.h"
@@ -178,14 +221,12 @@ WXDLLIMPEXP_CORE bool wxFromString(const wxString& str, wxColourBase* col);
     #include "wx/gtk/colour.h"
 #elif defined(__WXGTK__)
     #include "wx/gtk1/colour.h"
-#elif defined(__WXMGL__)
-    #include "wx/generic/colour.h"
 #elif defined(__WXDFB__)
     #include "wx/generic/colour.h"
 #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__)