]> git.saurik.com Git - wxWidgets.git/blob - wxPython/src/_brush.i
Added docstrings
[wxWidgets.git] / wxPython / src / _brush.i
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: _brush.i
3 // Purpose: SWIG interface for wxPen
4 //
5 // Author: Robin Dunn
6 //
7 // Created: 7-July-1997
8 // RCS-ID: $Id$
9 // Copyright: (c) 2003 by Total Control Software
10 // Licence: wxWindows license
11 /////////////////////////////////////////////////////////////////////////////
12
13 // Not a %module
14
15
16 //---------------------------------------------------------------------------
17 %newgroup
18
19 DocStr(wxBrush,
20 "A brush is a drawing tool for filling in areas. It is used for painting the\n"
21 "background of rectangles, ellipses, etc. It has a colour and a style.");
22
23 class wxBrush : public wxGDIObject {
24 public:
25 DocStr(wxBrush, "Constructs a brush from a colour object and style.");
26 wxBrush(const wxColour& colour, int style=wxSOLID);
27 ~wxBrush();
28
29
30 virtual void SetColour(const wxColour& col);
31 virtual void SetStyle(int style);
32 virtual void SetStipple(const wxBitmap& stipple);
33
34 wxColour GetColour() const;
35 int GetStyle() const;
36 wxBitmap *GetStipple() const;
37
38 bool Ok();
39
40 #ifdef __WXMAC__
41 short GetMacTheme();
42 void SetMacTheme(short macThemeBrush);
43 #endif
44
45 %pythoncode { def __nonzero__(self): return self.Ok() }
46 };
47
48 //---------------------------------------------------------------------------