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 d6c4d632b8d4a39941f2f22f410c5ba10f4bee60..724b9b7920a72a82295f6a050b9f9a5beb649269 100644 (file)
--- a/include/wx/gtk1/pen.h
+++ b/include/wx/gtk1/pen.h
@@ -1,21 +1,15 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        pen.h
+// Name:        wx/gtk1/pen.h
 // 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 __GTKPENH__
 #define __GTKPENH__
 
-#ifdef __GNUG__
-#pragma interface
-#endif
-
 #include "wx/defs.h"
 #include "wx/object.h"
 #include "wx/string.h"
@@ -26,45 +20,60 @@
 // classes
 //-----------------------------------------------------------------------------
 
-class wxPen;
+class WXDLLIMPEXP_FWD_CORE wxPen;
+
+#if defined(__WXGTK127__)
+typedef signed char wxGTKDash;
+#else
+typedef char wxGTKDash;
+#endif
 
 //-----------------------------------------------------------------------------
 // wxPen
 //-----------------------------------------------------------------------------
 
-class wxPen: public wxGDIObject
+class WXDLLIMPEXP_CORE wxPen: public wxPenBase
 {
-  DECLARE_DYNAMIC_CLASS(wxPen)
+public:
+    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); }
 
-  public:
-  
-    wxPen(void);
-    wxPen( const wxColour &colour, int width, int style );
-    wxPen( const wxString &colourName, int width, int style );
-    wxPen( const wxPen& pen );
-    wxPen( const wxPen* pen );
-    ~wxPen(void);
-    wxPen& operator = ( const wxPen& pen );
-    bool operator == ( const wxPen& pen );
-    bool operator != ( const wxPen& pen );
-    
     void SetColour( const wxColour &colour );
-    void SetColour( const wxString &colourName );
-    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 );
-    wxColour &GetColour(void) const;
-    int GetCap(void) const;
-    int GetJoin(void) const;
-    int GetStyle(void) const;
-    int GetWidth(void) const;
-    bool Ok(void) const;
-    
-    void Unshare(void);
-    
-    // no data :-)
+    void SetDashes( int number_of_dashes, const wxDash *dash );
+    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;
+    wxBitmap *GetStipple() const;
+
+#if FUTURE_WXWIN_COMPATIBILITY_3_0
+    wxDEPRECATED_FUTURE( void SetStyle(int style) )
+        { SetStyle((wxPenStyle)style); }
+#endif
+
+private:
+    virtual wxGDIRefData *CreateGDIRefData() const;
+    virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
+
+    DECLARE_DYNAMIC_CLASS(wxPen)
 };
 
 #endif // __GTKPENH__