]> git.saurik.com Git - wxWidgets.git/blob - include/wx/cocoa/brush.h
Fix missing documentation for several GDI functions.
[wxWidgets.git] / include / wx / cocoa / brush.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/cocoa/brush.h
3 // Purpose: wxBrush class
4 // Author: David Elliott <dfe@cox.net>
5 // Modified by:
6 // Created: 2003/07/03
7 // RCS-ID: $Id$
8 // Copyright: (c) 2003 David Elliott
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef __WX_COCOA_BRUSH_H__
13 #define __WX_COCOA_BRUSH_H__
14
15 #include "wx/gdicmn.h"
16 #include "wx/gdiobj.h"
17 #include "wx/bitmap.h"
18
19 class WXDLLIMPEXP_FWD_CORE wxBrush;
20
21 // ========================================================================
22 // wxBrush
23 // ========================================================================
24 class WXDLLIMPEXP_CORE wxBrush: public wxBrushBase
25 {
26 DECLARE_DYNAMIC_CLASS(wxBrush)
27 // ------------------------------------------------------------------------
28 // initialization
29 // ------------------------------------------------------------------------
30 public:
31 wxBrush();
32 wxBrush(const wxColour& col, wxBrushStyle style = wxBRUSHSTYLE_SOLID);
33 #if FUTURE_WXWIN_COMPATIBILITY_3_0
34 wxDEPRECATED_FUTURE( wxBrush(const wxColour& col, int style) );
35 #endif
36 wxBrush(const wxBitmap& stipple);
37 virtual ~wxBrush();
38
39 // ------------------------------------------------------------------------
40 // Implementation
41 // ------------------------------------------------------------------------
42 virtual void SetColour(const wxColour& col) ;
43 virtual void SetColour(unsigned char r, unsigned char g, unsigned char b) ;
44 virtual void SetStyle(wxBrushStyle style) ;
45 virtual void SetStipple(const wxBitmap& stipple) ;
46
47 // comparison
48 bool operator == (const wxBrush& brush) const
49 { return m_refData == brush.m_refData; }
50 bool operator != (const wxBrush& brush) const
51 { return m_refData != brush.m_refData; }
52
53 // accessors
54 wxColour GetColour() const;
55 virtual wxBrushStyle GetStyle() const;
56 wxBitmap *GetStipple() const;
57
58 #if FUTURE_WXWIN_COMPATIBILITY_3_0
59 wxDEPRECATED_FUTURE( void SetStyle(int style) )
60 { SetStyle((wxBrushStyle)style); }
61 #endif
62
63 // wxCocoa
64 WX_NSColor GetNSColor();
65
66 protected:
67 wxGDIRefData *CreateGDIRefData() const;
68 wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const;
69 };
70
71 #endif // __WX_COCOA_BRUSH_H__