Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/gtk1/colour.h b/include/wx/gtk1/colour.h
index 77e4155350d8447ca57fdb60cf651ce90c8a8833..b1d06275d5e6442dcad0f316e61b3932f539c5bd 100644 (file)
--- a/include/wx/gtk1/colour.h
+++ b/include/wx/gtk1/colour.h
@@ -1,20 +1,15 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        colour.h
+// Name:        wx/gtk1/colour.h
 // Purpose:
 // Author:      Robert Roebling
-// Id:          $id$
+// Id:          $Id$
 // Copyright:   (c) 1998 Robert Roebling
-// Licence:    wxWindows licence
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-
 #ifndef __GTKCOLOURH__
 #define __GTKCOLOURH__
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
 #include "wx/defs.h"
 #include "wx/object.h"
 #include "wx/string.h"
@@ -25,59 +20,51 @@
 // classes
 //-----------------------------------------------------------------------------
 
-class wxDC;
-class wxPaintDC;
-class wxBitmap;
-class wxWindow;
+class WXDLLIMPEXP_FWD_CORE wxDC;
+class WXDLLIMPEXP_FWD_CORE wxPaintDC;
+class WXDLLIMPEXP_FWD_CORE wxBitmap;
+class WXDLLIMPEXP_FWD_CORE wxWindow;
 
-class wxColour;
+class WXDLLIMPEXP_FWD_CORE wxColour;
 
 //-----------------------------------------------------------------------------
 // wxColour
 //-----------------------------------------------------------------------------
 
-class wxColour: public wxGDIObject
+class WXDLLIMPEXP_CORE wxColour : public wxColourBase
 {
 public:
-  // ctors
-    // default
-  wxColour();
-    // from RGB
-  wxColour( char red, char green, char blue );
-    // implicit conversion from the colour name
-  wxColour( const wxString &colourName ) { InitFromName(colourName); }
-  wxColour( const char *colourName ) { InitFromName(colourName); }
-
-    // copy ctors and assignment operators
-  wxColour( const wxColour& col );
-  wxColour( const wxColour* col );
-  wxColour& operator = ( const wxColour& col );
-
-    // dtor
-  ~wxColour();
-
-  // comparison
-  bool operator == ( const wxColour& col );
-  bool operator != ( const wxColour& col );
-  
-  // accessors
-  void Set( unsigned char red, unsigned char green, unsigned char blue );
-  unsigned char Red() const;
-  unsigned char Green() const;
-  unsigned char Blue() const;
-  bool Ok() const;
-
-  // implementation
-  void CalcPixel( GdkColormap *cmap );
-  int GetPixel() const;
-  GdkColor *GetColor() const;
+    // constructors
+    // ------------
+    DEFINE_STD_WXCOLOUR_CONSTRUCTORS
+
+    virtual ~wxColour();
+
+    virtual bool FromString(const wxString& str);
+
+    bool operator==(const wxColour& col) const;
+    bool operator!=(const wxColour& col) const { return !(*this == col); }
+
+    unsigned char Red() const;
+    unsigned char Green() const;
+    unsigned char Blue() const;
+
+
+    // Implementation part
+    void CalcPixel( GdkColormap *cmap );
+    int GetPixel() const;
+    GdkColor *GetColor() const;
 
 protected:
-  // helper functions
-  void InitFromName(const wxString& colourName);
+    // ref counting code
+    virtual wxGDIRefData *CreateGDIRefData() const;
+    virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
+
+    virtual void
+    InitRGBA(unsigned char r, unsigned char g, unsigned char b, unsigned char a);
 
 private:
-  DECLARE_DYNAMIC_CLASS(wxColour)
+    DECLARE_DYNAMIC_CLASS(wxColour)
 };
 
 #endif // __GTKCOLOURH__