Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/cocoa/colour.h b/include/wx/cocoa/colour.h
index 3b1fe9706a4d6d620793c7eaba5d8ceb94ef0e14..3209d94f0c55224db144d640a13f7d16477bf8c8 100644 (file)
--- a/include/wx/cocoa/colour.h
+++ b/include/wx/cocoa/colour.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        colour.h
+// Name:        wx/cocoa/colour.h

 // Purpose:     wxColour class
 // Author:      David Elliott
 // Modified by:
 // Purpose:     wxColour class
 // Author:      David Elliott
 // Modified by:


@@ -18,24 +18,16 @@
 // ========================================================================
 // wxColour
 // ========================================================================
 // ========================================================================
 // wxColour
 // ========================================================================

-class WXDLLEXPORT wxColour: public wxObject
+
+class WXDLLIMPEXP_CORE wxColour : public wxColourBase

 {
 public:
 {
 public:

-    wxColour() { Init(); }
-
-    // from RGB
-    wxColour( unsigned char red, unsigned char green, unsigned char blue )
-    :   m_cocoaNSColor(NULL)
-    {   Set(red,green,blue); }
-    wxColour( unsigned long colRGB )
-    :   m_cocoaNSColor(NULL)
-    {   Set(colRGB); }
-
-    // implicit conversion from the colour name
-    wxColour( const wxString &colourName )
-    {   InitFromName(colourName); }
-    wxColour( const char *colourName )
-    {   InitFromName(wxString::FromAscii(colourName)); }
+    // constructors
+    // ------------
+    DEFINE_STD_WXCOLOUR_CONSTRUCTORS
+
+    // initialization using existing NSColor
+    wxColour( WX_NSColor aColor );

 
     // copy ctors and assignment operators
     wxColour( const wxColour& col );
 
     // copy ctors and assignment operators
     wxColour( const wxColour& col );


@@ -44,48 +36,56 @@ public:
     virtual ~wxColour();
 
     // accessors
     virtual ~wxColour();
 
     // accessors

-    bool Ok() const { return m_cocoaNSColor; }
+    virtual bool IsOk() const { return m_cocoaNSColor; }

     WX_NSColor GetNSColor() { return m_cocoaNSColor; }
     WX_NSColor GetNSColor() { return m_cocoaNSColor; }

+    WX_NSColor GetNSColor() const { return m_cocoaNSColor; }

 
     unsigned char Red() const { return m_red; }
     unsigned char Green() const { return m_green; }
     unsigned char Blue() const { return m_blue; }
 
     unsigned char Red() const { return m_red; }
     unsigned char Green() const { return m_green; }
     unsigned char Blue() const { return m_blue; }

+    unsigned char Alpha() const { return m_alpha; }

 
     // comparison
     bool operator == (const wxColour& colour) const
     {
 
     // comparison
     bool operator == (const wxColour& colour) const
     {

-        // VZ: sure we want to compare NSColor objects for equality here?
-        return (m_cocoaNSColor == colour.m_cocoaNSColor
-            && m_red == colour.m_red
-            && m_green == colour.m_green
-            && m_blue == colour.m_blue);
+        return m_cocoaNSColor == colour.m_cocoaNSColor ||
+               (m_red == colour.m_red &&
+                m_green == colour.m_green &&
+                m_blue == colour.m_blue &&
+                m_alpha == colour.m_alpha);

     }
     bool operator != (const wxColour& colour) const
     }
     bool operator != (const wxColour& colour) const

-    {   return !(*this == colour); }
+        { return !(*this == colour); }

 
     // Set() functions
 
     // Set() functions

-    void Set( unsigned char red, unsigned char green, unsigned char blue );
-    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));
-    }
+    void Set( WX_NSColor aColor );
+
+    // reroute the inherited ones
+    void Set(unsigned char red,
+             unsigned char green,
+             unsigned char blue,
+             unsigned char alpha = wxALPHA_OPAQUE)
+        { wxColourBase::Set(red, green, blue, alpha); }
+
+    bool Set(const wxString &str)
+        { return wxColourBase::Set(str); }
+
+    void Set(unsigned long colRGB)
+        { wxColourBase::Set(colRGB); }

 
 protected:
     // puts the object in an invalid, uninitialized state
     void Init();
 
 
 protected:
     // puts the object in an invalid, uninitialized state
     void Init();
 

-    // create the object from name, leaves it uninitialized if it failed
-    void InitFromName(const wxString& col);
+    virtual void
+    InitRGBA(unsigned char r, unsigned char g, unsigned char b, unsigned char a);

 
 private:
     WX_NSColor m_cocoaNSColor;
     unsigned char m_red;
     unsigned char m_green;
     unsigned char m_blue;
 
 private:
     WX_NSColor m_cocoaNSColor;
     unsigned char m_red;
     unsigned char m_green;
     unsigned char m_blue;

+    unsigned char m_alpha;

 
     DECLARE_DYNAMIC_CLASS(wxColour)
 };
 
     DECLARE_DYNAMIC_CLASS(wxColour)
 };