Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/gtk1/pen.h b/include/wx/gtk1/pen.h
index 20d09c2ed4c541d9a72cb7782f49b8705fa64d74..724b9b7920a72a82295f6a050b9f9a5beb649269 100644 (file)
--- a/include/wx/gtk1/pen.h
+++ b/include/wx/gtk1/pen.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        pen.h
+// Name:        wx/gtk1/pen.h
 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$
@@ -7,14 +7,9 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-
 #ifndef __GTKPENH__
 #define __GTKPENH__
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
 #include "wx/defs.h"
 #include "wx/object.h"
 #include "wx/string.h"
@@ -25,51 +20,59 @@
 // classes
 //-----------------------------------------------------------------------------
 
-class wxPen;
+class WXDLLIMPEXP_FWD_CORE wxPen;
 
-#if defined(__WXGTK127__) || defined(__WXGTK20__)
-typedef    gint8 wxGTKDash;
+#if defined(__WXGTK127__)
+typedef signed char wxGTKDash;
 #else
-typedef    gchar wxGTKDash;
+typedef char wxGTKDash;
 #endif
 
 //-----------------------------------------------------------------------------
 // wxPen
 //-----------------------------------------------------------------------------
 
-class wxPen: public wxGDIObject
+class WXDLLIMPEXP_CORE wxPen: public wxPenBase
 {
 public:
-    wxPen();
-    wxPen( const wxColour &colour, int width, int style );
-    wxPen( const wxPen& pen );
-    ~wxPen();
-    wxPen& operator = ( const wxPen& pen );
-    bool operator == ( const wxPen& pen ) const;
-    bool operator != ( const wxPen& pen ) const;
+    wxPen() { }
+
+    wxPen( const wxColour &colour, int width = 1, wxPenStyle style = wxPENSTYLE_SOLID );
+#if FUTURE_WXWIN_COMPATIBILITY_3_0
+    wxDEPRECATED_FUTURE( wxPen(const wxColour& col, int width, int style) );
+#endif
+
+    bool operator==(const wxPen& pen) const;
+    bool operator!=(const wxPen& pen) const { return !(*this == pen); }
 
     void SetColour( const wxColour &colour );
-    void SetColour( int red, int green, int blue );
-    void SetCap( int capStyle );
-    void SetJoin( int joinStyle );
-    void SetStyle( int style );
+    void SetColour( unsigned char red, unsigned char green, unsigned char blue );
+    void SetCap( wxPenCap capStyle );
+    void SetJoin( wxPenJoin joinStyle );
+    void SetStyle( wxPenStyle style );
     void SetWidth( int width );
     void SetDashes( int number_of_dashes, const wxDash *dash );
-    
-    wxColour &GetColour() const;
-    int GetCap() const;
-    int GetJoin() const;
-    int GetStyle() const;
+    void SetStipple(const wxBitmap& stipple);
+
+    wxColour GetColour() const;
+    wxPenCap GetCap() const;
+    wxPenJoin GetJoin() const;
+    wxPenStyle GetStyle() const;
     int GetWidth() const;
     int GetDashes(wxDash **ptr) const;
     int GetDashCount() const;
     wxDash* GetDash() const;
-    
-    bool Ok() const;
+    wxBitmap *GetStipple() const;
+
+#if FUTURE_WXWIN_COMPATIBILITY_3_0
+    wxDEPRECATED_FUTURE( void SetStyle(int style) )
+        { SetStyle((wxPenStyle)style); }
+#endif
 
-    void Unshare();
+private:
+    virtual wxGDIRefData *CreateGDIRefData() const;
+    virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
 
-private:    
     DECLARE_DYNAMIC_CLASS(wxPen)
 };