Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/osx/pen.h b/include/wx/osx/pen.h
index 0307ce4a33793c9f15edc8b816e014c770203bf5..243714ac7e1e33bb88f2a4abffec8ce9755342ce 100644 (file)
--- a/include/wx/osx/pen.h
+++ b/include/wx/osx/pen.h
@@ -1,5 +1,77 @@
-#ifdef __WXMAC_CLASSIC__
-#include "wx/osx/classic/pen.h"
-#else
-#include "wx/osx/carbon/pen.h"
+/////////////////////////////////////////////////////////////////////////////
+// Name:        wx/osx/pen.h
+// Purpose:     wxPen class
+// Author:      Stefan Csomor
+// Modified by:
+// Created:     1998-01-01
+// RCS-ID:      $Id$
+// Copyright:   (c) Stefan Csomor
+// Licence:     wxWindows licence
+/////////////////////////////////////////////////////////////////////////////
+
+#ifndef _WX_PEN_H_
+#define _WX_PEN_H_
+
+#include "wx/gdiobj.h"
+#include "wx/colour.h"
+#include "wx/bitmap.h"
+
+// Pen
+class WXDLLIMPEXP_CORE wxPen : public wxPenBase
+{
+public:
+    wxPen();
+    wxPen(const wxColour& col, int width = 1, wxPenStyle style = wxPENSTYLE_SOLID);
+#if FUTURE_WXWIN_COMPATIBILITY_3_0
+    wxDEPRECATED_FUTURE( wxPen(const wxColour& col, int width, int style) );
 #endif
+
+    wxPen(const wxBitmap& stipple, int width);
+    virtual ~wxPen();
+
+    bool operator==(const wxPen& pen) const;
+    bool operator!=(const wxPen& pen) const { return !(*this == pen); }
+
+    // Override in order to recreate the pen
+    void SetColour(const wxColour& col) ;
+    void SetColour(unsigned char r, unsigned char g, unsigned char b) ;
+
+    void SetWidth(int width)  ;
+    void SetStyle(wxPenStyle style)  ;
+    void SetStipple(const wxBitmap& stipple)  ;
+    void SetDashes(int nb_dashes, const wxDash *dash)  ;
+    void SetJoin(wxPenJoin join)  ;
+    void SetCap(wxPenCap cap)  ;
+
+    wxColour GetColour() const ;
+    int GetWidth() const;
+    wxPenStyle GetStyle() const;
+    wxPenJoin GetJoin() const;
+    wxPenCap GetCap() const;
+    int GetDashes(wxDash **ptr) const;
+    int GetDashCount() const;
+
+    wxBitmap *GetStipple() const ;
+
+#if FUTURE_WXWIN_COMPATIBILITY_3_0
+    wxDEPRECATED_FUTURE( void SetStyle(int style) )
+        { SetStyle((wxPenStyle)style); }
+#endif
+
+    // Implementation
+
+    // Useful helper: create the brush resource
+    bool RealizeResource();
+
+protected:
+    virtual wxGDIRefData *CreateGDIRefData() const;
+    virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
+
+private:
+    void Unshare();
+
+    DECLARE_DYNAMIC_CLASS(wxPen)
+};
+
+#endif
+    // _WX_PEN_H_