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 f0e3829a73ddfc03f8008ae074c191ca13dc756c..3209d94f0c55224db144d640a13f7d16477bf8c8 100644 (file)
--- a/include/wx/cocoa/colour.h
+++ b/include/wx/cocoa/colour.h
@@ -19,20 +19,16 @@
 // wxColour
 // ========================================================================
 
 // wxColour
 // ========================================================================
 

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

 {
 public:
     // constructors
     // ------------
 {
 public:
     // constructors
     // ------------

-
-    // default
-    wxColour() { Init(); }

     DEFINE_STD_WXCOLOUR_CONSTRUCTORS
 
     // initialization using existing NSColor
     wxColour( WX_NSColor aColor );
 
     DEFINE_STD_WXCOLOUR_CONSTRUCTORS
 
     // initialization using existing NSColor
     wxColour( WX_NSColor aColor );
 

-

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


@@ -40,53 +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
     {

-        // TODO: Really compare the NSColor
-        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
     void Set( WX_NSColor aColor );
 
     // Set() functions
     void Set( WX_NSColor aColor );

-    
+

     // reroute the inherited ones
     // reroute the inherited ones

-    void Set(unsigned char red, unsigned char green, unsigned char blue)
-    { wxColourBase::Set(red,green,blue); }
-    
-    // implemented in colourcmn.cpp
-    bool Set(const wxChar *str)
-    { return wxColourBase::Set(str); }
-    
+    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)
     bool Set(const wxString &str)

-    { return wxColourBase::Set(str); }
-    
+        { return wxColourBase::Set(str); }
+

     void Set(unsigned long colRGB)
     void Set(unsigned long colRGB)

-    { wxColourBase::Set(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();
 

-    virtual void InitWith( unsigned char red, unsigned char green, unsigned char blue );
+    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)
 };