]> git.saurik.com Git - wxWidgets.git/blame - include/wx/gdicmn.h
1. wxWindow::IsTopLevel() added and documented
[wxWidgets.git] / include / wx / gdicmn.h
CommitLineData
c801d85f
KB
1/////////////////////////////////////////////////////////////////////////////
2// Name: gdicmn.h
3// Purpose: Common GDI classes, types and declarations
4// Author: Julian Smart
5// Modified by:
6// Created: 01/02/97
7// RCS-ID: $Id$
8// Copyright: (c)
f03fc89f 9// Licence: wxWindows licence
c801d85f
KB
10/////////////////////////////////////////////////////////////////////////////
11
34138703
JS
12#ifndef _WX_GDICMNH__
13#define _WX_GDICMNH__
c801d85f 14
f03fc89f
VZ
15// ---------------------------------------------------------------------------
16// headers
17// ---------------------------------------------------------------------------
18
c801d85f 19#ifdef __GNUG__
f03fc89f 20 #pragma interface "gdicmn.h"
c801d85f
KB
21#endif
22
23#include "wx/object.h"
24#include "wx/list.h"
25#include "wx/hash.h"
34138703 26#include "wx/string.h"
c801d85f 27#include "wx/setup.h"
34138703 28#include "wx/colour.h"
c801d85f 29
f03fc89f
VZ
30// ---------------------------------------------------------------------------
31// forward declarations
32// ---------------------------------------------------------------------------
33
34class WXDLLEXPORT wxBitmap;
35class WXDLLEXPORT wxBrush;
36class WXDLLEXPORT wxColour;
37class WXDLLEXPORT wxCursor;
38class WXDLLEXPORT wxFont;
39class WXDLLEXPORT wxIcon;
40class WXDLLEXPORT wxPalette;
41class WXDLLEXPORT wxPen;
42class WXDLLEXPORT wxRegion;
43class WXDLLEXPORT wxString;
44
45// ---------------------------------------------------------------------------
46// constants
47// ---------------------------------------------------------------------------
48
49// Bitmap flags
50enum
51{
52 wxBITMAP_TYPE_BMP = 1,
53 wxBITMAP_TYPE_BMP_RESOURCE,
54 wxBITMAP_TYPE_RESOURCE = wxBITMAP_TYPE_BMP_RESOURCE,
55 wxBITMAP_TYPE_ICO,
56 wxBITMAP_TYPE_ICO_RESOURCE,
57 wxBITMAP_TYPE_CUR,
58 wxBITMAP_TYPE_CUR_RESOURCE,
59 wxBITMAP_TYPE_XBM,
60 wxBITMAP_TYPE_XBM_DATA,
61 wxBITMAP_TYPE_XPM,
62 wxBITMAP_TYPE_XPM_DATA,
63 wxBITMAP_TYPE_TIF,
64 wxBITMAP_TYPE_TIF_RESOURCE,
65 wxBITMAP_TYPE_GIF,
66 wxBITMAP_TYPE_GIF_RESOURCE,
67 wxBITMAP_TYPE_PNG,
68 wxBITMAP_TYPE_PNG_RESOURCE,
69 wxBITMAP_TYPE_JPEG,
70 wxBITMAP_TYPE_JPEG_RESOURCE,
71 wxBITMAP_TYPE_ANY = 50
72};
73
c801d85f 74// Standard cursors
f03fc89f
VZ
75enum wxStockCursor
76{
77 wxCURSOR_NONE, // should be 0
78 wxCURSOR_ARROW,
79 wxCURSOR_BULLSEYE,
80 wxCURSOR_CHAR,
81 wxCURSOR_CROSS,
82 wxCURSOR_HAND,
83 wxCURSOR_IBEAM,
84 wxCURSOR_LEFT_BUTTON,
85 wxCURSOR_MAGNIFIER,
86 wxCURSOR_MIDDLE_BUTTON,
87 wxCURSOR_NO_ENTRY,
88 wxCURSOR_PAINT_BRUSH,
89 wxCURSOR_PENCIL,
90 wxCURSOR_POINT_LEFT,
91 wxCURSOR_POINT_RIGHT,
92 wxCURSOR_QUESTION_ARROW,
93 wxCURSOR_RIGHT_BUTTON,
94 wxCURSOR_SIZENESW,
95 wxCURSOR_SIZENS,
96 wxCURSOR_SIZENWSE,
97 wxCURSOR_SIZEWE,
98 wxCURSOR_SIZING,
99 wxCURSOR_SPRAYCAN,
100 wxCURSOR_WAIT,
101 wxCURSOR_WATCH,
102 wxCURSOR_BLANK,
c801d85f 103#ifdef __X__
f03fc89f
VZ
104 // Not yet implemented for Windows
105 wxCURSOR_CROSS_REVERSE,
106 wxCURSOR_DOUBLE_ARROW,
107 wxCURSOR_BASED_ARROW_UP,
ea804aad 108 wxCURSOR_BASED_ARROW_DOWN,
f03fc89f
VZ
109#endif // X11
110
111 wxCURSOR_MAX
112};
113
114// ---------------------------------------------------------------------------
115// macros
116// ---------------------------------------------------------------------------
117
118/* Useful macro for creating icons portably, for example:
119
120 wxIcon *icon = new wxICON(mondrian);
121
122 expands into:
123
124 wxIcon *icon = new wxIcon("mondrian"); // On wxMSW
125 wxIcon *icon = new wxIcon(mondrian_xpm); // On wxGTK
126 */
127
128#ifdef __WXMSW__
129 // Load from a resource
130 #define wxICON(X) wxIcon("" #X "")
131#elif defined(__WXGTK__)
132 // Initialize from an included XPM
133 #define wxICON(X) wxIcon( (const char**) X##_xpm )
134#elif defined(__WXMOTIF__)
135 // Initialize from an included XPM
136 #define wxICON(X) wxIcon( X##_xpm )
137#else
138 // This will usually mean something on any platform
139 #define wxICON(X) wxIcon("" #X "")
140#endif // platform
141
142// ===========================================================================
143// classes
144// ===========================================================================
c801d85f 145
f03fc89f
VZ
146// ---------------------------------------------------------------------------
147// wxSize
148// ---------------------------------------------------------------------------
6a6c0a8b 149class WXDLLEXPORT wxSize
c801d85f
KB
150{
151public:
f03fc89f
VZ
152 // members are public for compatibility
153 long x;
154 long y;
155
156 // constructors
157 wxSize() { x = y = 0; }
158 wxSize(long xx, long yy) { Set(xx, yy); }
159
160 // no copy ctor or assignment operator - the defaults are ok
161
162 bool operator==(const wxSize& sz) const { return x == sz.x && y == sz.y; }
163
164 // FIXME are these really useful? If they're, we should have += &c as well
165 wxSize operator+(const wxSize& sz) { return wxSize(x + sz.x, y + sz.y); }
166 wxSize operator-(const wxSize& sz) { return wxSize(x - sz.x, y - sz.y); }
167
168 void Set(long xx, long yy) { x = xx; y = yy; }
169
170 long GetX() const { return x; }
171 long GetY() const { return y; }
c801d85f
KB
172};
173
f03fc89f
VZ
174// ---------------------------------------------------------------------------
175// Point classes: with real or integer coordinates
176// ---------------------------------------------------------------------------
764a3a49 177
6a6c0a8b 178class WXDLLEXPORT wxRealPoint
c801d85f 179{
f03fc89f
VZ
180public:
181 double x;
182 double y;
183
184 wxRealPoint() { x = y = 0.0; };
185 wxRealPoint(double xx, double yy) { x = xx; y = yy; };
186
187 wxRealPoint operator+(const wxRealPoint& pt) { return wxRealPoint(x + pt.x, y + pt.y); }
188 wxRealPoint operator-(const wxRealPoint& pt) { return wxRealPoint(x - pt.x, y - pt.y); }
189
190 bool operator==(const wxRealPoint& pt) const { return x == pt.x && y == pt.y; }
c801d85f
KB
191};
192
6a6c0a8b 193class WXDLLEXPORT wxPoint
c801d85f 194{
f03fc89f 195public:
2049ba38 196#if defined(__WXMSW__) && !defined(__WIN32__)
f03fc89f
VZ
197 int x;
198 int y;
6a6c0a8b 199#else
f03fc89f
VZ
200 long x;
201 long y;
6a6c0a8b
JS
202#endif
203
f03fc89f
VZ
204 wxPoint() { x = y = 0; };
205 wxPoint(long xx, long yy) { x = xx; y = yy; };
206
207 // no copy ctor or assignment operator - the defaults are ok
6a6c0a8b 208
764a3a49
VZ
209 // comparison
210 bool operator==(const wxPoint& p) const { return x == p.x && y == p.y; }
211 bool operator!=(const wxPoint& p) const { return !(*this == p); }
212
213 // arithmetic operations (component wise)
214 wxPoint operator+(const wxPoint& p) { return wxPoint(x + p.x, y + p.y); }
215 wxPoint operator-(const wxPoint& p) { return wxPoint(x - p.x, y - p.y); }
f03fc89f 216
764a3a49
VZ
217 wxPoint& operator+=(const wxPoint& p) { x += p.x; y += p.y; return *this; }
218 wxPoint& operator-=(const wxPoint& p) { x -= p.x; y -= p.y; return *this; }
c801d85f
KB
219};
220
221#if WXWIN_COMPATIBILITY
f03fc89f
VZ
222 #define wxIntPoint wxPoint
223 #define wxRectangle wxRect
224#endif // WXWIN_COMPATIBILITY
225
226// ---------------------------------------------------------------------------
227// wxRect
228// ---------------------------------------------------------------------------
c801d85f 229
6a6c0a8b
JS
230class WXDLLEXPORT wxRect
231{
c801d85f 232public:
a23fd0e1
VZ
233 wxRect() { x = y = width = height = 0; }
234 wxRect(long xx, long yy, long ww, long hh)
235 { x = xx; y = yy; width = ww; height = hh; }
f03fc89f
VZ
236 wxRect(const wxPoint& topLeft, const wxPoint& bottomRight);
237 wxRect(const wxPoint& pos, const wxSize& size);
a23fd0e1
VZ
238
239 // default copy ctor and assignment operators ok
c801d85f 240
f03fc89f
VZ
241 long GetX() const { return x; }
242 void SetX(long xx) { x = xx; }
c801d85f 243
f03fc89f
VZ
244 long GetY() const { return y; }
245 void SetY(long yy) { y = yy; }
c801d85f 246
f03fc89f
VZ
247 long GetWidth() const { return width; }
248 void SetWidth(long w) { width = w; }
c801d85f 249
f03fc89f
VZ
250 long GetHeight() const { return height; }
251 void SetHeight(long h) { height = h; }
252
dcb44466
JS
253 wxPoint GetPosition() const { return wxPoint(x, y); }
254 wxSize GetSize() const { return wxSize(width, height); }
f03fc89f
VZ
255
256 long GetLeft() const { return x; }
257 long GetTop() const { return y; }
258 long GetBottom() const { return y + height; }
259 long GetRight() const { return x + width; }
260
dcb44466 261
764a3a49
VZ
262 bool operator==(const wxRect& rect) const;
263 bool operator!=(const wxRect& rect) const { return !(*this == rect); }
f03fc89f 264
7742598f 265 bool Inside(int cx, int cy) const;
dcb44466
JS
266 wxRect operator + (const wxRect& rect) const;
267 const wxRect& operator += (const wxRect& rect);
7742598f 268
f03fc89f
VZ
269public:
270 long x, y, width, height;
271};
c801d85f 272
f03fc89f 273// ---------------------------------------------------------------------------
c801d85f 274// Management of pens, brushes and fonts
f03fc89f
VZ
275// ---------------------------------------------------------------------------
276
277class WXDLLEXPORT wxPenList : public wxList
c801d85f 278{
f03fc89f
VZ
279 DECLARE_DYNAMIC_CLASS(wxPenList)
280
281public:
282 wxPenList() { }
283 ~wxPenList();
284
285 void AddPen(wxPen *pen);
286 void RemovePen(wxPen *pen);
287 wxPen *FindOrCreatePen(const wxColour& colour, int width, int style);
c801d85f
KB
288};
289
f03fc89f 290class WXDLLEXPORT wxBrushList : public wxList
c801d85f 291{
f03fc89f
VZ
292 DECLARE_DYNAMIC_CLASS(wxBrushList)
293
294public:
295 wxBrushList() { }
296 ~wxBrushList();
297
298 void AddBrush(wxBrush *brush);
299 void RemoveBrush(wxBrush *brush);
300 wxBrush *FindOrCreateBrush(const wxColour& colour, int style);
c801d85f
KB
301};
302
9d2f3c71 303WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
c801d85f 304
f03fc89f 305class WXDLLEXPORT wxFontList : public wxList
c801d85f 306{
f03fc89f
VZ
307 DECLARE_DYNAMIC_CLASS(wxFontList)
308
309public:
310 wxFontList() { }
311 ~wxFontList();
312
313 void AddFont(wxFont *font);
314 void RemoveFont(wxFont *font);
315 wxFont *FindOrCreateFont(int pointSize, int family, int style, int weight,
316 bool underline = FALSE,
317 const wxString& face = wxEmptyString);
c801d85f
KB
318};
319
f03fc89f 320class WXDLLEXPORT wxColourDatabase : public wxList
c801d85f 321{
f03fc89f
VZ
322 DECLARE_CLASS(wxColourDatabase)
323
324public:
325 wxColourDatabase(int type);
326 ~wxColourDatabase() ;
327
328 // Not const because it may add a name to the database
329 wxColour *FindColour(const wxString& colour) ;
330 wxString FindName(const wxColour& colour) const;
331 void Initialize();
c801d85f
KB
332};
333
f03fc89f 334class WXDLLEXPORT wxBitmapList : public wxList
c801d85f 335{
f03fc89f 336 DECLARE_DYNAMIC_CLASS(wxBitmapList)
c801d85f 337
f03fc89f
VZ
338public:
339 wxBitmapList();
340 ~wxBitmapList();
341
342 void AddBitmap(wxBitmap *bitmap);
343 void RemoveBitmap(wxBitmap *bitmap);
c801d85f
KB
344};
345
f03fc89f
VZ
346class WXDLLEXPORT wxResourceCache: public wxList
347{
348public:
349 wxResourceCache() { }
350 wxResourceCache(const unsigned int keyType) : wxList(keyType) { }
351 ~wxResourceCache();
352
353private:
354 DECLARE_DYNAMIC_CLASS(wxResourceCache)
355};
356
357// ---------------------------------------------------------------------------
358// global variables
359// ---------------------------------------------------------------------------
360
c801d85f 361// Lists of GDI objects
f03fc89f
VZ
362WXDLLEXPORT_DATA(extern wxPenList*) wxThePenList;
363WXDLLEXPORT_DATA(extern wxBrushList*) wxTheBrushList;
364WXDLLEXPORT_DATA(extern wxFontList*) wxTheFontList;
365WXDLLEXPORT_DATA(extern wxBitmapList*) wxTheBitmapList;
c801d85f
KB
366
367// Stock objects
f03fc89f
VZ
368WXDLLEXPORT_DATA(extern wxFont*) wxNORMAL_FONT;
369WXDLLEXPORT_DATA(extern wxFont*) wxSMALL_FONT;
370WXDLLEXPORT_DATA(extern wxFont*) wxITALIC_FONT;
371WXDLLEXPORT_DATA(extern wxFont*) wxSWISS_FONT;
372
373WXDLLEXPORT_DATA(extern wxPen*) wxRED_PEN;
374WXDLLEXPORT_DATA(extern wxPen*) wxCYAN_PEN;
375WXDLLEXPORT_DATA(extern wxPen*) wxGREEN_PEN;
376WXDLLEXPORT_DATA(extern wxPen*) wxBLACK_PEN;
377WXDLLEXPORT_DATA(extern wxPen*) wxWHITE_PEN;
378WXDLLEXPORT_DATA(extern wxPen*) wxTRANSPARENT_PEN;
379WXDLLEXPORT_DATA(extern wxPen*) wxBLACK_DASHED_PEN;
380WXDLLEXPORT_DATA(extern wxPen*) wxGREY_PEN;
381WXDLLEXPORT_DATA(extern wxPen*) wxMEDIUM_GREY_PEN;
382WXDLLEXPORT_DATA(extern wxPen*) wxLIGHT_GREY_PEN;
383
384WXDLLEXPORT_DATA(extern wxBrush*) wxBLUE_BRUSH;
385WXDLLEXPORT_DATA(extern wxBrush*) wxGREEN_BRUSH;
386WXDLLEXPORT_DATA(extern wxBrush*) wxWHITE_BRUSH;
387WXDLLEXPORT_DATA(extern wxBrush*) wxBLACK_BRUSH;
388WXDLLEXPORT_DATA(extern wxBrush*) wxGREY_BRUSH;
389WXDLLEXPORT_DATA(extern wxBrush*) wxMEDIUM_GREY_BRUSH;
390WXDLLEXPORT_DATA(extern wxBrush*) wxLIGHT_GREY_BRUSH;
391WXDLLEXPORT_DATA(extern wxBrush*) wxTRANSPARENT_BRUSH;
392WXDLLEXPORT_DATA(extern wxBrush*) wxCYAN_BRUSH;
393WXDLLEXPORT_DATA(extern wxBrush*) wxRED_BRUSH;
394
395WXDLLEXPORT_DATA(extern wxColour*) wxBLACK;
396WXDLLEXPORT_DATA(extern wxColour*) wxWHITE;
397WXDLLEXPORT_DATA(extern wxColour*) wxRED;
398WXDLLEXPORT_DATA(extern wxColour*) wxBLUE;
399WXDLLEXPORT_DATA(extern wxColour*) wxGREEN;
400WXDLLEXPORT_DATA(extern wxColour*) wxCYAN;
401WXDLLEXPORT_DATA(extern wxColour*) wxLIGHT_GREY;
c801d85f
KB
402
403// 'Null' objects
f03fc89f
VZ
404WXDLLEXPORT_DATA(extern wxBitmap) wxNullBitmap;
405WXDLLEXPORT_DATA(extern wxIcon) wxNullIcon;
406WXDLLEXPORT_DATA(extern wxCursor) wxNullCursor;
407WXDLLEXPORT_DATA(extern wxPen) wxNullPen;
408WXDLLEXPORT_DATA(extern wxBrush) wxNullBrush;
409WXDLLEXPORT_DATA(extern wxPalette) wxNullPalette;
410WXDLLEXPORT_DATA(extern wxFont) wxNullFont;
411WXDLLEXPORT_DATA(extern wxColour) wxNullColour;
c801d85f
KB
412
413// Stock cursors types
f03fc89f
VZ
414WXDLLEXPORT_DATA(extern wxCursor*) wxSTANDARD_CURSOR;
415WXDLLEXPORT_DATA(extern wxCursor*) wxHOURGLASS_CURSOR;
416WXDLLEXPORT_DATA(extern wxCursor*) wxCROSS_CURSOR;
417
418WXDLLEXPORT_DATA(extern wxColourDatabase*) wxTheColourDatabase;
419
420WXDLLEXPORT_DATA(extern const wxChar*) wxPanelNameStr;
c801d85f 421
f03fc89f
VZ
422WXDLLEXPORT_DATA(extern const wxSize) wxDefaultSize;
423WXDLLEXPORT_DATA(extern const wxPoint) wxDefaultPosition;
424
425// The list of objects which should be deleted
426WXDLLEXPORT_DATA(extern wxList) wxPendingDelete;
427
428// ---------------------------------------------------------------------------
429// global functions
430// ---------------------------------------------------------------------------
431
432// resource management
6a6c0a8b 433extern void WXDLLEXPORT wxInitializeStockObjects();
a3622daa 434extern void WXDLLEXPORT wxInitializeStockLists();
6a6c0a8b 435extern void WXDLLEXPORT wxDeleteStockObjects();
a3622daa 436extern void WXDLLEXPORT wxDeleteStockLists();
c801d85f 437
f03fc89f 438// is the display colour (or monochrome)?
6a6c0a8b 439extern bool WXDLLEXPORT wxColourDisplay();
c801d85f
KB
440
441// Returns depth of screen
6a6c0a8b
JS
442extern int WXDLLEXPORT wxDisplayDepth();
443#define wxGetDisplayDepth wxDisplayDepth
c801d85f 444
f03fc89f 445// get the diaplay size
c801d85f 446extern void WXDLLEXPORT wxDisplaySize(int *width, int *height);
6a6c0a8b 447extern wxSize WXDLLEXPORT wxGetDisplaySize();
c801d85f 448
f03fc89f 449// set global cursor
c801d85f
KB
450extern void WXDLLEXPORT wxSetCursor(const wxCursor& cursor);
451
c801d85f 452#endif
34138703 453 // _WX_GDICMNH__