Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/gtk/pen.h b/include/wx/gtk/pen.h
index 7e6f2c733569e6884b0a61066b1fa292a85ae850..2437073efbe8e4236e4a0266dfc9c7e0da09cb56 100644 (file)
--- a/include/wx/gtk/pen.h
+++ b/include/wx/gtk/pen.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

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

 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$
 // Purpose:
 // Author:      Robert Roebling
 // Id:          $Id$


@@ -7,70 +7,59 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 

+#ifndef _WX_GTK_PEN_H_
+#define _WX_GTK_PEN_H_

 
 

-#ifndef __GTKPENH__
-#define __GTKPENH__
-
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "wx/defs.h"
-#include "wx/object.h"
-#include "wx/string.h"
-#include "wx/gdiobj.h"
-#include "wx/gdicmn.h"
+typedef signed char wxGTKDash;

 
 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------

-// classes
+// wxPen

 //-----------------------------------------------------------------------------
 
 //-----------------------------------------------------------------------------
 

-class wxPen;
+class WXDLLIMPEXP_CORE wxPen: public wxPenBase
+{
+public:
+    wxPen() { }

 
 

-#ifdef __WXGTK127__
-typedef    gint8 wxGTKDash;
-#else
-typedef    gchar wxGTKDash;
+    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
 
 #endif
 

-//-----------------------------------------------------------------------------
-// wxPen
-//-----------------------------------------------------------------------------
+    virtual ~wxPen();

 
 

-class wxPen: public wxGDIObject
-{
-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;
+    bool operator==(const wxPen& pen) const;
+    bool operator!=(const wxPen& pen) const { return !(*this == pen); }

 
     void SetColour( const wxColour &colour );
 
     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 );
     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;
     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();
+protected:
+    virtual wxGDIRefData *CreateGDIRefData() const;
+    virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;

 
 

-private:    

     DECLARE_DYNAMIC_CLASS(wxPen)
 };
 
     DECLARE_DYNAMIC_CLASS(wxPen)
 };
 

-#endif // __GTKPENH__
+#endif // _WX_GTK_PEN_H_