]> git.saurik.com Git - wxWidgets.git/blob - wxPython/src/_stockobjs.i
Added docstrings
[wxWidgets.git] / wxPython / src / _stockobjs.i
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: _stockobjs.i
3 // Purpose: SWIG interface defining "stock" GDI objects
4 //
5 // Author: Robin Dunn
6 //
7 // Created: 13-Sept-2003
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
20 // See also wxPy_ReinitStockObjects in helpers.cpp
21 %immutable;
22
23 wxFont* const wxNORMAL_FONT;
24 wxFont* const wxSMALL_FONT;
25 wxFont* const wxITALIC_FONT;
26 wxFont* const wxSWISS_FONT;
27
28 wxPen* const wxRED_PEN;
29 wxPen* const wxCYAN_PEN;
30 wxPen* const wxGREEN_PEN;
31 wxPen* const wxBLACK_PEN;
32 wxPen* const wxWHITE_PEN;
33 wxPen* const wxTRANSPARENT_PEN;
34 wxPen* const wxBLACK_DASHED_PEN;
35 wxPen* const wxGREY_PEN;
36 wxPen* const wxMEDIUM_GREY_PEN;
37 wxPen* const wxLIGHT_GREY_PEN;
38
39 wxBrush* const wxBLUE_BRUSH;
40 wxBrush* const wxGREEN_BRUSH;
41 wxBrush* const wxWHITE_BRUSH;
42 wxBrush* const wxBLACK_BRUSH;
43 wxBrush* const wxTRANSPARENT_BRUSH;
44 wxBrush* const wxCYAN_BRUSH;
45 wxBrush* const wxRED_BRUSH;
46 wxBrush* const wxGREY_BRUSH;
47 wxBrush* const wxMEDIUM_GREY_BRUSH;
48 wxBrush* const wxLIGHT_GREY_BRUSH;
49
50 wxColour* const wxBLACK;
51 wxColour* const wxWHITE;
52 wxColour* const wxRED;
53 wxColour* const wxBLUE;
54 wxColour* const wxGREEN;
55 wxColour* const wxCYAN;
56 wxColour* const wxLIGHT_GREY;
57
58 wxCursor* const wxSTANDARD_CURSOR;
59 wxCursor* const wxHOURGLASS_CURSOR;
60 wxCursor* const wxCROSS_CURSOR;
61
62
63 const wxBitmap wxNullBitmap;
64 const wxIcon wxNullIcon;
65 const wxCursor wxNullCursor;
66 const wxPen wxNullPen;
67 const wxBrush wxNullBrush;
68 const wxPalette wxNullPalette;
69 const wxFont wxNullFont;
70 const wxColour wxNullColour;
71
72 %mutable;
73
74
75 //---------------------------------------------------------------------------
76
77 class wxPenList : public wxObject {
78 public:
79
80 void AddPen(wxPen* pen);
81 wxPen* FindOrCreatePen(const wxColour& colour, int width, int style);
82 void RemovePen(wxPen* pen);
83
84 int GetCount();
85 };
86
87
88 //---------------------------------------------------------------------------
89
90 class wxBrushList : public wxObject {
91 public:
92
93 void AddBrush(wxBrush *brush);
94 wxBrush * FindOrCreateBrush(const wxColour& colour, int style);
95 void RemoveBrush(wxBrush *brush);
96
97 int GetCount();
98 };
99
100 //---------------------------------------------------------------------------
101
102 class wxColourDatabase : public wxObject {
103 public:
104 wxColourDatabase();
105 ~wxColourDatabase();
106
107 // find colour by name or name for the given colour
108 wxColour Find(const wxString& name) const;
109 wxString FindName(const wxColour& colour) const;
110 %pythoncode { FindColour = Find }
111
112 // add a new colour to the database
113 void AddColour(const wxString& name, const wxColour& colour);
114
115 %extend {
116 void Append(const wxString& name, int red, int green, int blue) {
117 self->AddColour(name, wxColour(red, green, blue));
118 }
119 }
120 };
121
122 //---------------------------------------------------------------------------
123
124 class wxFontList : public wxObject {
125 public:
126
127 void AddFont(wxFont* font);
128 wxFont * FindOrCreateFont(int point_size, int family, int style, int weight,
129 bool underline = False, const wxString& facename = wxPyEmptyString,
130 wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
131 void RemoveFont(wxFont *font);
132
133 int GetCount();
134 };
135
136 //---------------------------------------------------------------------------
137 %newgroup
138
139
140
141 // See also wxPy_ReinitStockObjects in helpers.cpp
142 %immutable;
143
144 wxFontList* const wxTheFontList;
145 wxPenList* const wxThePenList;
146 wxBrushList* const wxTheBrushList;
147 wxColourDatabase* const wxTheColourDatabase;
148
149 %mutable;
150
151
152 //---------------------------------------------------------------------------
153
154 %pythoncode { NullColor = NullColour }
155
156
157
158