]> git.saurik.com Git - wxWidgets.git/blob - include/wx/mac/classic/pen.h
Fix for mistake with const for non pointer/reference with corrections in documentation.
[wxWidgets.git] / include / wx / mac / classic / pen.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/mac/classic/pen.h
3 // Purpose: wxPen class
4 // Author: Stefan Csomor
5 // Modified by:
6 // Created: 1998-01-01
7 // RCS-ID: $Id$
8 // Copyright: (c) Stefan Csomor
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_PEN_H_
13 #define _WX_PEN_H_
14
15 #include "wx/gdiobj.h"
16 #include "wx/colour.h"
17 #include "wx/bitmap.h"
18
19 class WXDLLEXPORT wxPen;
20
21 class WXDLLEXPORT wxPenRefData: public wxGDIRefData
22 {
23 friend class WXDLLEXPORT wxPen;
24 public:
25 wxPenRefData();
26 wxPenRefData(const wxPenRefData& data);
27 ~wxPenRefData();
28
29 wxPenRefData& operator=(const wxPenRefData& data);
30
31 protected:
32 int m_width;
33 int m_style;
34 int m_join ;
35 int m_cap ;
36 wxBitmap m_stipple ;
37 int m_nbDash ;
38 wxDash * m_dash ;
39 wxColour m_colour;
40 /* TODO: implementation
41 WXHPEN m_hPen;
42 */
43 };
44
45 #define M_PENDATA ((wxPenRefData *)m_refData)
46
47 // Pen
48 class WXDLLEXPORT wxPen: public wxGDIObject
49 {
50 DECLARE_DYNAMIC_CLASS(wxPen)
51 public:
52 wxPen();
53 wxPen(const wxColour& col, int width = 1, int style = wxSOLID);
54 wxPen(const wxBitmap& stipple, int width);
55 wxPen(const wxPen& pen)
56 : wxGDIObject()
57 { Ref(pen); }
58 ~wxPen();
59
60 inline wxPen& operator = (const wxPen& pen) { if (*this == pen) return (*this); Ref(pen); return *this; }
61 inline bool operator == (const wxPen& pen) const { return m_refData == pen.m_refData; }
62 inline bool operator != (const wxPen& pen) const { return m_refData != pen.m_refData; }
63
64 virtual bool Ok() const { return (m_refData != NULL) ; }
65
66 // Override in order to recreate the pen
67 void SetColour(const wxColour& col) ;
68 void SetColour(unsigned char r, unsigned char g, unsigned char b) ;
69
70 void SetWidth(int width) ;
71 void SetStyle(int style) ;
72 void SetStipple(const wxBitmap& stipple) ;
73 void SetDashes(int nb_dashes, const wxDash *dash) ;
74 void SetJoin(int join) ;
75 void SetCap(int cap) ;
76
77 inline wxColour& GetColour() const { return (M_PENDATA ? M_PENDATA->m_colour : wxNullColour); };
78 inline int GetWidth() const { return (M_PENDATA ? M_PENDATA->m_width : 0); };
79 inline int GetStyle() const { return (M_PENDATA ? M_PENDATA->m_style : 0); };
80 inline int GetJoin() const { return (M_PENDATA ? M_PENDATA->m_join : 0); };
81 inline int GetCap() const { return (M_PENDATA ? M_PENDATA->m_cap : 0); };
82 inline int GetDashes(wxDash **ptr) const {
83 *ptr = (M_PENDATA ? M_PENDATA->m_dash : (wxDash*) NULL); return (M_PENDATA ? M_PENDATA->m_nbDash : 0);
84 }
85
86 inline wxBitmap *GetStipple() const { return (M_PENDATA ? (& M_PENDATA->m_stipple) : (wxBitmap*) NULL); };
87
88 // Implementation
89
90 // Useful helper: create the brush resource
91 bool RealizeResource();
92
93 // When setting properties, we must make sure we're not changing
94 // another object
95 void Unshare();
96 };
97
98 #endif
99 // _WX_PEN_H_