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 26f30c60c4c88e66e6fdd755ded579a6e1b5b4ae..98287139fdc461901c6bfa7c90b2eb9c065d4e48 100644 (file)
--- a/include/wx/gtk/colour.h
+++ b/include/wx/gtk/colour.h
@@ -1,81 +1,60 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:
 // Author:      Robert Roebling
 // Purpose:
 // Author:      Robert Roebling

-// Created:     01/02/97
-// Id:
-// Copyright:   (c) 1998 Robert Roebling, Julian Smart and Markus Holzem
-// Licence:    wxWindows licence
+// Id:          $Id$
+// Copyright:   (c) 1998 Robert Roebling
+// 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:
+    // constructors
+    // ------------
+    DEFINE_STD_WXCOLOUR_CONSTRUCTORS
+    wxColour(const GdkColor& gdkColor);
+#ifdef __WXGTK3__
+    wxColour(const GdkRGBA& gdkRGBA);
+#endif
+
+    virtual ~wxColour();
+
+    bool operator==(const wxColour& col) const;
+    bool operator!=(const wxColour& col) const { return !(*this == col); }

 
 

-    wxColour();
-    wxColour( char red, char green, char blue );
-    wxColour( const wxString &colourName ) { InitFromName(colourName); }
-    wxColour( const char *colourName ) { InitFromName(colourName); }
-    wxColour( const wxColour& col );
-    wxColour( const wxColour* col );
-    ~wxColour();
-    wxColour& operator = ( const wxColour& col );
-    wxColour& operator = ( const wxString& colourName );
-    bool operator == ( const wxColour& col );
-    bool operator != ( const wxColour& col );
-    void Set( const unsigned char red, const unsigned char green, const unsigned char blue );

     unsigned char Red() const;
     unsigned char Green() const;
     unsigned char Blue() const;
     unsigned char Red() const;
     unsigned char Green() const;
     unsigned char Blue() const;

-    bool Ok() const;
+    unsigned char Alpha() const;

 
 

-  private:
-  public:
-  
-    friend wxDC;
-    friend wxPaintDC;
-    friend wxBitmap;
-    friend wxWindow;
-        
+    // 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:

-    // 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_