]> git.saurik.com Git - wxWidgets.git/blame - include/wx/gdicmn.h
Ignore erase failures
[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,
ae53c98c
KB
103#ifdef __WXGTK__
104 wxCURSOR_DEFAULT, // standard X11 cursor
105#endif
c801d85f 106#ifdef __X__
f03fc89f
VZ
107 // Not yet implemented for Windows
108 wxCURSOR_CROSS_REVERSE,
109 wxCURSOR_DOUBLE_ARROW,
110 wxCURSOR_BASED_ARROW_UP,
ea804aad 111 wxCURSOR_BASED_ARROW_DOWN,
f03fc89f
VZ
112#endif // X11
113
114 wxCURSOR_MAX
115};
116
117// ---------------------------------------------------------------------------
118// macros
119// ---------------------------------------------------------------------------
120
121/* Useful macro for creating icons portably, for example:
122
123 wxIcon *icon = new wxICON(mondrian);
124
125 expands into:
126
127 wxIcon *icon = new wxIcon("mondrian"); // On wxMSW
128 wxIcon *icon = new wxIcon(mondrian_xpm); // On wxGTK
129 */
130
131#ifdef __WXMSW__
132 // Load from a resource
133 #define wxICON(X) wxIcon("" #X "")
134#elif defined(__WXGTK__)
135 // Initialize from an included XPM
136 #define wxICON(X) wxIcon( (const char**) X##_xpm )
137#elif defined(__WXMOTIF__)
138 // Initialize from an included XPM
139 #define wxICON(X) wxIcon( X##_xpm )
140#else
141 // This will usually mean something on any platform
142 #define wxICON(X) wxIcon("" #X "")
143#endif // platform
144
145// ===========================================================================
146// classes
147// ===========================================================================
c801d85f 148
f03fc89f
VZ
149// ---------------------------------------------------------------------------
150// wxSize
151// ---------------------------------------------------------------------------
6a6c0a8b 152class WXDLLEXPORT wxSize
c801d85f
KB
153{
154public:
cc775580
VZ
155 // members are public for compatibility (don't use them directly,
156 // especially that there names were chosen very unfortunately - they should
157 // have been called width and height)
f03fc89f
VZ
158 long x;
159 long y;
160
161 // constructors
162 wxSize() { x = y = 0; }
163 wxSize(long xx, long yy) { Set(xx, yy); }
164
165 // no copy ctor or assignment operator - the defaults are ok
f03fc89f
VZ
166 bool operator==(const wxSize& sz) const { return x == sz.x && y == sz.y; }
167
168 // FIXME are these really useful? If they're, we should have += &c as well
169 wxSize operator+(const wxSize& sz) { return wxSize(x + sz.x, y + sz.y); }
170 wxSize operator-(const wxSize& sz) { return wxSize(x - sz.x, y - sz.y); }
171
cc775580 172 // accessors
f03fc89f 173 void Set(long xx, long yy) { x = xx; y = yy; }
cc775580
VZ
174 void SetWidth(long w) { x = w; }
175 void SetHeight(long h) { y = h; }
176
177 long GetWidth() const { return x; }
178 long GetHeight() const { return y; }
f03fc89f 179
cc775580 180 // compatibility
f03fc89f
VZ
181 long GetX() const { return x; }
182 long GetY() const { return y; }
c801d85f
KB
183};
184
f03fc89f
VZ
185// ---------------------------------------------------------------------------
186// Point classes: with real or integer coordinates
187// ---------------------------------------------------------------------------
764a3a49 188
6a6c0a8b 189class WXDLLEXPORT wxRealPoint
c801d85f 190{
f03fc89f
VZ
191public:
192 double x;
193 double y;
194
195 wxRealPoint() { x = y = 0.0; };
196 wxRealPoint(double xx, double yy) { x = xx; y = yy; };
197
198 wxRealPoint operator+(const wxRealPoint& pt) { return wxRealPoint(x + pt.x, y + pt.y); }
199 wxRealPoint operator-(const wxRealPoint& pt) { return wxRealPoint(x - pt.x, y - pt.y); }
200
201 bool operator==(const wxRealPoint& pt) const { return x == pt.x && y == pt.y; }
c801d85f
KB
202};
203
6a6c0a8b 204class WXDLLEXPORT wxPoint
c801d85f 205{
f03fc89f 206public:
2049ba38 207#if defined(__WXMSW__) && !defined(__WIN32__)
f03fc89f
VZ
208 int x;
209 int y;
6a6c0a8b 210#else
f03fc89f
VZ
211 long x;
212 long y;
6a6c0a8b
JS
213#endif
214
f03fc89f
VZ
215 wxPoint() { x = y = 0; };
216 wxPoint(long xx, long yy) { x = xx; y = yy; };
217
218 // no copy ctor or assignment operator - the defaults are ok
6a6c0a8b 219
764a3a49
VZ
220 // comparison
221 bool operator==(const wxPoint& p) const { return x == p.x && y == p.y; }
222 bool operator!=(const wxPoint& p) const { return !(*this == p); }
223
224 // arithmetic operations (component wise)
225 wxPoint operator+(const wxPoint& p) { return wxPoint(x + p.x, y + p.y); }
226 wxPoint operator-(const wxPoint& p) { return wxPoint(x - p.x, y - p.y); }
f03fc89f 227
764a3a49
VZ
228 wxPoint& operator+=(const wxPoint& p) { x += p.x; y += p.y; return *this; }
229 wxPoint& operator-=(const wxPoint& p) { x -= p.x; y -= p.y; return *this; }
c801d85f
KB
230};
231
232#if WXWIN_COMPATIBILITY
f03fc89f
VZ
233 #define wxIntPoint wxPoint
234 #define wxRectangle wxRect
235#endif // WXWIN_COMPATIBILITY
236
237// ---------------------------------------------------------------------------
238// wxRect
239// ---------------------------------------------------------------------------
c801d85f 240
6a6c0a8b
JS
241class WXDLLEXPORT wxRect
242{
c801d85f 243public:
a23fd0e1
VZ
244 wxRect() { x = y = width = height = 0; }
245 wxRect(long xx, long yy, long ww, long hh)
246 { x = xx; y = yy; width = ww; height = hh; }
f03fc89f
VZ
247 wxRect(const wxPoint& topLeft, const wxPoint& bottomRight);
248 wxRect(const wxPoint& pos, const wxSize& size);
a23fd0e1
VZ
249
250 // default copy ctor and assignment operators ok
c801d85f 251
f03fc89f
VZ
252 long GetX() const { return x; }
253 void SetX(long xx) { x = xx; }
c801d85f 254
f03fc89f
VZ
255 long GetY() const { return y; }
256 void SetY(long yy) { y = yy; }
c801d85f 257
f03fc89f
VZ
258 long GetWidth() const { return width; }
259 void SetWidth(long w) { width = w; }
c801d85f 260
f03fc89f
VZ
261 long GetHeight() const { return height; }
262 void SetHeight(long h) { height = h; }
263
dcb44466
JS
264 wxPoint GetPosition() const { return wxPoint(x, y); }
265 wxSize GetSize() const { return wxSize(width, height); }
f03fc89f 266
f3c0f9e7
JS
267 // MFC-like functions
268
f03fc89f
VZ
269 long GetLeft() const { return x; }
270 long GetTop() const { return y; }
f3c0f9e7
JS
271 long GetBottom() const { return y + height - 1; }
272 long GetRight() const { return x + width - 1; }
f03fc89f 273
f3c0f9e7
JS
274 void SetLeft(long left) { x = left; }
275 void SetRight(long right) { width = right - x + 1; }
276 void SetTop(long top) { y = top; }
277 void SetBottom(long bottom) { height = bottom - y + 1; }
dcb44466 278
764a3a49
VZ
279 bool operator==(const wxRect& rect) const;
280 bool operator!=(const wxRect& rect) const { return !(*this == rect); }
f03fc89f 281
7742598f 282 bool Inside(int cx, int cy) const;
dcb44466
JS
283 wxRect operator + (const wxRect& rect) const;
284 const wxRect& operator += (const wxRect& rect);
7742598f 285
f03fc89f
VZ
286public:
287 long x, y, width, height;
288};
c801d85f 289
f03fc89f 290// ---------------------------------------------------------------------------
c801d85f 291// Management of pens, brushes and fonts
f03fc89f
VZ
292// ---------------------------------------------------------------------------
293
294class WXDLLEXPORT wxPenList : public wxList
c801d85f 295{
f03fc89f
VZ
296 DECLARE_DYNAMIC_CLASS(wxPenList)
297
298public:
299 wxPenList() { }
300 ~wxPenList();
301
302 void AddPen(wxPen *pen);
303 void RemovePen(wxPen *pen);
304 wxPen *FindOrCreatePen(const wxColour& colour, int width, int style);
c801d85f
KB
305};
306
f03fc89f 307class WXDLLEXPORT wxBrushList : public wxList
c801d85f 308{
f03fc89f
VZ
309 DECLARE_DYNAMIC_CLASS(wxBrushList)
310
311public:
312 wxBrushList() { }
313 ~wxBrushList();
314
315 void AddBrush(wxBrush *brush);
316 void RemoveBrush(wxBrush *brush);
317 wxBrush *FindOrCreateBrush(const wxColour& colour, int style);
c801d85f
KB
318};
319
9d2f3c71 320WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
c801d85f 321
f03fc89f 322class WXDLLEXPORT wxFontList : public wxList
c801d85f 323{
f03fc89f
VZ
324 DECLARE_DYNAMIC_CLASS(wxFontList)
325
326public:
327 wxFontList() { }
328 ~wxFontList();
329
330 void AddFont(wxFont *font);
331 void RemoveFont(wxFont *font);
332 wxFont *FindOrCreateFont(int pointSize, int family, int style, int weight,
333 bool underline = FALSE,
334 const wxString& face = wxEmptyString);
c801d85f
KB
335};
336
f03fc89f 337class WXDLLEXPORT wxColourDatabase : public wxList
c801d85f 338{
f03fc89f
VZ
339 DECLARE_CLASS(wxColourDatabase)
340
341public:
342 wxColourDatabase(int type);
343 ~wxColourDatabase() ;
344
345 // Not const because it may add a name to the database
346 wxColour *FindColour(const wxString& colour) ;
347 wxString FindName(const wxColour& colour) const;
348 void Initialize();
c801d85f
KB
349};
350
f03fc89f 351class WXDLLEXPORT wxBitmapList : public wxList
c801d85f 352{
f03fc89f 353 DECLARE_DYNAMIC_CLASS(wxBitmapList)
c801d85f 354
f03fc89f
VZ
355public:
356 wxBitmapList();
357 ~wxBitmapList();
358
359 void AddBitmap(wxBitmap *bitmap);
360 void RemoveBitmap(wxBitmap *bitmap);
c801d85f
KB
361};
362
f03fc89f
VZ
363class WXDLLEXPORT wxResourceCache: public wxList
364{
365public:
366 wxResourceCache() { }
367 wxResourceCache(const unsigned int keyType) : wxList(keyType) { }
368 ~wxResourceCache();
369
370private:
371 DECLARE_DYNAMIC_CLASS(wxResourceCache)
372};
373
374// ---------------------------------------------------------------------------
375// global variables
376// ---------------------------------------------------------------------------
377
c801d85f 378// Lists of GDI objects
f03fc89f
VZ
379WXDLLEXPORT_DATA(extern wxPenList*) wxThePenList;
380WXDLLEXPORT_DATA(extern wxBrushList*) wxTheBrushList;
381WXDLLEXPORT_DATA(extern wxFontList*) wxTheFontList;
382WXDLLEXPORT_DATA(extern wxBitmapList*) wxTheBitmapList;
c801d85f
KB
383
384// Stock objects
f03fc89f
VZ
385WXDLLEXPORT_DATA(extern wxFont*) wxNORMAL_FONT;
386WXDLLEXPORT_DATA(extern wxFont*) wxSMALL_FONT;
387WXDLLEXPORT_DATA(extern wxFont*) wxITALIC_FONT;
388WXDLLEXPORT_DATA(extern wxFont*) wxSWISS_FONT;
389
390WXDLLEXPORT_DATA(extern wxPen*) wxRED_PEN;
391WXDLLEXPORT_DATA(extern wxPen*) wxCYAN_PEN;
392WXDLLEXPORT_DATA(extern wxPen*) wxGREEN_PEN;
393WXDLLEXPORT_DATA(extern wxPen*) wxBLACK_PEN;
394WXDLLEXPORT_DATA(extern wxPen*) wxWHITE_PEN;
395WXDLLEXPORT_DATA(extern wxPen*) wxTRANSPARENT_PEN;
396WXDLLEXPORT_DATA(extern wxPen*) wxBLACK_DASHED_PEN;
397WXDLLEXPORT_DATA(extern wxPen*) wxGREY_PEN;
398WXDLLEXPORT_DATA(extern wxPen*) wxMEDIUM_GREY_PEN;
399WXDLLEXPORT_DATA(extern wxPen*) wxLIGHT_GREY_PEN;
400
401WXDLLEXPORT_DATA(extern wxBrush*) wxBLUE_BRUSH;
402WXDLLEXPORT_DATA(extern wxBrush*) wxGREEN_BRUSH;
403WXDLLEXPORT_DATA(extern wxBrush*) wxWHITE_BRUSH;
404WXDLLEXPORT_DATA(extern wxBrush*) wxBLACK_BRUSH;
405WXDLLEXPORT_DATA(extern wxBrush*) wxGREY_BRUSH;
406WXDLLEXPORT_DATA(extern wxBrush*) wxMEDIUM_GREY_BRUSH;
407WXDLLEXPORT_DATA(extern wxBrush*) wxLIGHT_GREY_BRUSH;
408WXDLLEXPORT_DATA(extern wxBrush*) wxTRANSPARENT_BRUSH;
409WXDLLEXPORT_DATA(extern wxBrush*) wxCYAN_BRUSH;
410WXDLLEXPORT_DATA(extern wxBrush*) wxRED_BRUSH;
411
412WXDLLEXPORT_DATA(extern wxColour*) wxBLACK;
413WXDLLEXPORT_DATA(extern wxColour*) wxWHITE;
414WXDLLEXPORT_DATA(extern wxColour*) wxRED;
415WXDLLEXPORT_DATA(extern wxColour*) wxBLUE;
416WXDLLEXPORT_DATA(extern wxColour*) wxGREEN;
417WXDLLEXPORT_DATA(extern wxColour*) wxCYAN;
418WXDLLEXPORT_DATA(extern wxColour*) wxLIGHT_GREY;
c801d85f
KB
419
420// 'Null' objects
f03fc89f
VZ
421WXDLLEXPORT_DATA(extern wxBitmap) wxNullBitmap;
422WXDLLEXPORT_DATA(extern wxIcon) wxNullIcon;
423WXDLLEXPORT_DATA(extern wxCursor) wxNullCursor;
424WXDLLEXPORT_DATA(extern wxPen) wxNullPen;
425WXDLLEXPORT_DATA(extern wxBrush) wxNullBrush;
426WXDLLEXPORT_DATA(extern wxPalette) wxNullPalette;
427WXDLLEXPORT_DATA(extern wxFont) wxNullFont;
428WXDLLEXPORT_DATA(extern wxColour) wxNullColour;
c801d85f
KB
429
430// Stock cursors types
f03fc89f
VZ
431WXDLLEXPORT_DATA(extern wxCursor*) wxSTANDARD_CURSOR;
432WXDLLEXPORT_DATA(extern wxCursor*) wxHOURGLASS_CURSOR;
433WXDLLEXPORT_DATA(extern wxCursor*) wxCROSS_CURSOR;
434
435WXDLLEXPORT_DATA(extern wxColourDatabase*) wxTheColourDatabase;
436
437WXDLLEXPORT_DATA(extern const wxChar*) wxPanelNameStr;
c801d85f 438
f03fc89f
VZ
439WXDLLEXPORT_DATA(extern const wxSize) wxDefaultSize;
440WXDLLEXPORT_DATA(extern const wxPoint) wxDefaultPosition;
441
442// The list of objects which should be deleted
443WXDLLEXPORT_DATA(extern wxList) wxPendingDelete;
444
445// ---------------------------------------------------------------------------
446// global functions
447// ---------------------------------------------------------------------------
448
449// resource management
6a6c0a8b 450extern void WXDLLEXPORT wxInitializeStockObjects();
a3622daa 451extern void WXDLLEXPORT wxInitializeStockLists();
6a6c0a8b 452extern void WXDLLEXPORT wxDeleteStockObjects();
a3622daa 453extern void WXDLLEXPORT wxDeleteStockLists();
c801d85f 454
f03fc89f 455// is the display colour (or monochrome)?
6a6c0a8b 456extern bool WXDLLEXPORT wxColourDisplay();
c801d85f
KB
457
458// Returns depth of screen
6a6c0a8b
JS
459extern int WXDLLEXPORT wxDisplayDepth();
460#define wxGetDisplayDepth wxDisplayDepth
c801d85f 461
f03fc89f 462// get the diaplay size
c801d85f 463extern void WXDLLEXPORT wxDisplaySize(int *width, int *height);
6a6c0a8b 464extern wxSize WXDLLEXPORT wxGetDisplaySize();
c801d85f 465
f03fc89f 466// set global cursor
c801d85f
KB
467extern void WXDLLEXPORT wxSetCursor(const wxCursor& cursor);
468
c801d85f 469#endif
34138703 470 // _WX_GDICMNH__