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 e399d074b27af718fec1eb9b7a9b06356701ccd2..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$
 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$


@@ -7,90 +7,54 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // 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
 
 #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
 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------
 // wxColour
 //-----------------------------------------------------------------------------
 

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

 {
 public:
 {
 public:

-    wxColour() { }
-  
-    // Construct 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); }
-
-    wxColour( const wxColour& col )
-        : wxGDIObject()
-        { Ref(col); }
-    wxColour& operator = ( const wxColour& col ) { Ref(col); return *this; }
-
-    ~wxColour();
+    // constructors
+    // ------------
+    DEFINE_STD_WXCOLOUR_CONSTRUCTORS
+    wxColour(const GdkColor& gdkColor);
+#ifdef __WXGTK3__
+    wxColour(const GdkRGBA& gdkRGBA);
+#endif

 
 

-    bool Ok() const { return m_refData != NULL; }
-  
-    bool operator == ( const wxColour& col ) const;
-    bool operator != ( const wxColour& col ) const { return !(*this == col); }
+    virtual ~wxColour();

 
 

-    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;
 
     unsigned char Red() const;
     unsigned char Green() const;
     unsigned char Blue() const;

-
+    unsigned char Alpha() const;

 
     // Implementation part
 
     // Implementation part

+#ifdef __WXGTK3__
+    operator const GdkRGBA*() const;
+#else

     void CalcPixel( GdkColormap *cmap );
     int GetPixel() const;
     void CalcPixel( GdkColormap *cmap );
     int GetPixel() const;

-    GdkColor *GetColor() const;
+#endif
+    const GdkColor *GetColor() const;

 
 protected:
 
 protected:

-    // ref counting code
-    virtual wxObjectRefData *CreateRefData() const;
-    virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const;
-    
-    // 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_