Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/gtk/colour.h b/include/wx/gtk/colour.h
index 9a6503eb418cdac055c277cf00c2caab1e3b5be7..98287139fdc461901c6bfa7c90b2eb9c065d4e48 100644 (file)
--- a/include/wx/gtk/colour.h
+++ b/include/wx/gtk/colour.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        colour.h
+// Name:        wx/gtk/colour.h
 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$
@@ -7,87 +7,54 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
+#ifndef _WX_GTK_COLOUR_H_
+#define _WX_GTK_COLOUR_H_
 
-#ifndef __GTKCOLOURH__
-#define __GTKCOLOURH__
-
-#ifdef __GNUG__
-#pragma interface
+#ifdef __WXGTK3__
+typedef struct _GdkRGBA GdkRGBA;
 #endif
 
-#include "wx/defs.h"
-#include "wx/object.h"
-#include "wx/string.h"
-#include "wx/gdiobj.h"
-#include "wx/palette.h"
-
-//-----------------------------------------------------------------------------
-// classes
-//-----------------------------------------------------------------------------
-
-class wxDC;
-class wxPaintDC;
-class wxBitmap;
-class wxWindow;
-
-class wxColour;
-
 //-----------------------------------------------------------------------------
 // wxColour
 //-----------------------------------------------------------------------------
 
-class wxColour: public wxGDIObject
+class WXDLLIMPEXP_CORE wxColour : public wxColourBase
 {
 public:
-  // ctors
-    // default
-  wxColour();
-    // from RGB
-  wxColour( unsigned char red, unsigned char green, unsigned char blue );
-  wxColour( unsigned long colRGB ) { Set(colRGB); }
-
-    // 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& operator = ( const wxColour& col );
-
-    // dtor
-  ~wxColour();
+    // constructors
+    // ------------
+    DEFINE_STD_WXCOLOUR_CONSTRUCTORS
+    wxColour(const GdkColor& gdkColor);
+#ifdef __WXGTK3__
+    wxColour(const GdkRGBA& gdkRGBA);
+#endif
 
-  // comparison
-  bool operator == ( const wxColour& col );
-  bool operator != ( const wxColour& col );
+    virtual ~wxColour();
 
-  // accessors
-  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));
-  }
+    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;
-  bool Ok() const;
+    unsigned char Red() const;
+    unsigned char Green() const;
+    unsigned char Blue() const;
+    unsigned char Alpha() const;
 
-  // implementation
-  void CalcPixel( GdkColormap *cmap );
-  int GetPixel() const;
-  GdkColor *GetColor() const;
+    // Implementation part
+#ifdef __WXGTK3__
+    operator const GdkRGBA*() const;
+#else
+    void CalcPixel( GdkColormap *cmap );
+    int GetPixel() const;
+#endif
+    const GdkColor *GetColor() const;
 
 protected:
-  // helper functions
-  void InitFromName(const wxString& colourName);
+    virtual void
+    InitRGBA(unsigned char r, unsigned char g, unsigned char b, unsigned char a);
+
+    virtual bool FromString(const wxString& str);
 
-private:
-  DECLARE_DYNAMIC_CLASS(wxColour)
+    DECLARE_DYNAMIC_CLASS(wxColour)
 };
 
-#endif // __GTKCOLOURH__
+#endif // _WX_GTK_COLOUR_H_