]> git.saurik.com Git - wxWidgets.git/blob - include/wx/dfb/pen.h
Fix missing documentation for several GDI functions.
[wxWidgets.git] / include / wx / dfb / pen.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/dfb/pen.h
3 // Purpose: wxPen class declaration
4 // Author: Vaclav Slavik
5 // Created: 2006-08-04
6 // RCS-ID: $Id$
7 // Copyright: (c) 2006 REA Elektronik GmbH
8 // Licence: wxWindows licence
9 /////////////////////////////////////////////////////////////////////////////
10
11 #ifndef _WX_DFB_PEN_H_
12 #define _WX_DFB_PEN_H_
13
14 #include "wx/defs.h"
15 #include "wx/object.h"
16 #include "wx/string.h"
17 #include "wx/gdiobj.h"
18 #include "wx/gdicmn.h"
19
20 //-----------------------------------------------------------------------------
21 // classes
22 //-----------------------------------------------------------------------------
23
24 class WXDLLIMPEXP_FWD_CORE wxBitmap;
25 class WXDLLIMPEXP_FWD_CORE wxPen;
26
27 //-----------------------------------------------------------------------------
28 // wxPen
29 //-----------------------------------------------------------------------------
30
31 class WXDLLIMPEXP_CORE wxPen: public wxPenBase
32 {
33 public:
34 wxPen() {}
35 wxPen(const wxColour &colour, int width = 1, wxPenStyle style = wxPENSTYLE_SOLID);
36 #if FUTURE_WXWIN_COMPATIBILITY_3_0
37 wxDEPRECATED_FUTURE( wxPen(const wxColour& col, int width, int style) );
38 #endif
39
40 wxPen(const wxBitmap& stipple, int width);
41
42 bool operator==(const wxPen& pen) const;
43 bool operator!=(const wxPen& pen) const { return !(*this == pen); }
44
45 void SetColour(const wxColour &colour);
46 void SetColour(unsigned char red, unsigned char green, unsigned char blue);
47 void SetCap(wxPenCap capStyle);
48 void SetJoin(wxPenJoin joinStyle);
49 void SetStyle(wxPenStyle style);
50 void SetWidth(int width);
51 void SetDashes(int number_of_dashes, const wxDash *dash);
52 void SetStipple(const wxBitmap& stipple);
53
54 wxColour GetColour() const;
55 wxPenCap GetCap() const;
56 wxPenJoin GetJoin() const;
57 wxPenStyle GetStyle() const;
58 int GetWidth() const;
59 int GetDashes(wxDash **ptr) const;
60 int GetDashCount() const;
61 wxDash* GetDash() const;
62 wxBitmap *GetStipple() const;
63
64 #if FUTURE_WXWIN_COMPATIBILITY_3_0
65 wxDEPRECATED_FUTURE( void SetStyle(int style) )
66 { SetStyle((wxPenStyle)style); }
67 #endif
68
69 protected:
70 virtual wxGDIRefData *CreateGDIRefData() const;
71 virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
72
73 DECLARE_DYNAMIC_CLASS(wxPen)
74 };
75
76 #endif // _WX_DFB_PEN_H_