fixed unused parameter warning

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

diff --git a/include/wx/cocoa/colour.h b/include/wx/cocoa/colour.h
index e7a64f7c2b97dab584db0d9da849751a949b9d32..17cb30210172fd81bdcf45fdd746f29af7805b59 100644 (file)
--- a/include/wx/cocoa/colour.h
+++ b/include/wx/cocoa/colour.h
@@ -1,103 +1,106 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:     wxColour class
 // Purpose:     wxColour class

-// Author:      AUTHOR
+// Author:      David Elliott

 // Modified by:
 // Modified by:

-// Created:     ??/??/98
+// Created:     2003/06/17

 // RCS-ID:      $Id$
 // RCS-ID:      $Id$

-// Copyright:   (c) AUTHOR
+// Copyright:   (c) 2003 David Elliott

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

-#ifndef _WX_COLOUR_H_
-#define _WX_COLOUR_H_
-
-#if defined(__GNUG__) && !defined(__APPLE__)
-#pragma interface "colour.h"
-#endif
+#ifndef __WX_COCOA_COLOUR_H__
+#define __WX_COCOA_COLOUR_H__

 
 #include "wx/object.h"
 #include "wx/string.h"
 
 
 #include "wx/object.h"
 #include "wx/string.h"
 

-// Colour
+// ========================================================================
+// wxColour
+// ========================================================================

 class WXDLLEXPORT wxColour: public wxObject
 {
 public:
 class WXDLLEXPORT wxColour: public wxObject
 {
 public:

-  // ctors
+    // constructors
+    // ------------
+

     // default
     // default

-  wxColour();
-    // from RGB
-  wxColour( unsigned char red, unsigned char green, unsigned char blue );
-  wxColour( unsigned long colRGB )
-      : m_isInit(FALSE), m_red(0), m_blue(0), m_green(0)
-      { Set(colRGB); }
-  
-    // implicit conversion from the colour name
-  wxColour( const wxString &colourName )
-      : m_isInit(FALSE), m_red(0), m_blue(0), m_green(0)
-      { InitFromName(colourName); }
-  wxColour( const char *colourName )
-      : m_isInit(FALSE), m_red(0), m_blue(0), m_green(0)
-      { InitFromName(colourName); }
+    wxColour() { Init(); }

 
 

-    // copy ctors and assignment operators
-  wxColour( const wxColour& col );
-  wxColour( const wxColour* col );
-  wxColour& operator = ( const wxColour& col );
-
-    // dtor
-  ~wxColour();
-
-  // 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));
-  }
-
-  // accessors
-  bool Ok() const {return m_isInit; }
-
-  // Let's remove this inelegant function
-#if WXWIN_COMPATIBILITY
-  void Get(unsigned char *r, unsigned char *g, unsigned char *b) const;
-#endif
+    // from separate RGB
+    wxColour( unsigned char red, unsigned char green, unsigned char blue )
+    :   m_cocoaNSColor(NULL)
+    {   Set(red,green,blue); }

 
 

-  unsigned char Red() const { return m_red; }
-  unsigned char Green() const { return m_green; }
-  unsigned char Blue() const { return m_blue; }
+    // from packed RGB
+    wxColour( unsigned long colRGB )
+    :   m_cocoaNSColor(NULL)
+    {   Set(colRGB); }

 
 

-  // comparison
-  bool operator == (const wxColour& colour) const
-  {
-    return (m_isInit == colour.m_isInit &&
-            m_red == colour.m_red && 
-            m_green == colour.m_green && 
-            m_blue == colour.m_blue);
-  }
-  bool operator != (const wxColour& colour) const { return !(*this == colour); }
+    // initialization using existing NSColor
+    wxColour( WX_NSColor aColor );

 
 

-  void InitFromName(const wxString& col);
+    // implicit conversion from the colour name
+    wxColour( const wxString &colourName )
+    {   InitFromName(colourName); }
+    wxColour( const char *colourName )
+    {   InitFromName(wxString::FromAscii(colourName)); }
+#if wxUSE_UNICODE
+    wxColour( const wxChar *colourName ) { InitFromName( wxString(colourName) ); }
+#endif

 
 

-//  const WXCOLORREF& GetPixel() const { return m_pixel; };
+    // copy ctors and assignment operators
+    wxColour( const wxColour& col );
+    wxColour& operator = ( const wxColour& col );
+
+    virtual ~wxColour();
+
+    // accessors
+    bool Ok() const { return m_cocoaNSColor; }
+    WX_NSColor GetNSColor() { return m_cocoaNSColor; }
+
+    unsigned char Red() const { return m_red; }
+    unsigned char Green() const { return m_green; }
+    unsigned char Blue() const { return m_blue; }
+
+    // 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));
+    }
+    bool operator != (const wxColour& colour) const
+    {   return !(*this == colour); }
+
+    // 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 );
+
+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);

 
 private:
 
 private:

-  bool          m_isInit;
-  unsigned char m_red;
-  unsigned char m_blue;
-  unsigned char m_green;
-
-public:
-//  WXCOLORREF m_pixel ;
-//  void Set( const WXCOLORREF* color ) ;
+    WX_NSColor m_cocoaNSColor;
+    unsigned char m_red;
+    unsigned char m_green;
+    unsigned char m_blue;

 
 

-private:
-  DECLARE_DYNAMIC_CLASS(wxColour)
+    DECLARE_DYNAMIC_CLASS(wxColour)

 };
 
 };
 

-#endif
-  // _WX_COLOUR_H_
+#endif // __WX_COCOA_COLOUR_H__