]> git.saurik.com Git - wxWidgets.git/blame - include/wx/gdicmn.h
Corrected spelling of 'unrecognized'
[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
RR
265// this doesn't compile
266#if 0
267 bool Inside(int cx, int cy) const;
dcb44466
JS
268 wxRect operator + (const wxRect& rect) const;
269 const wxRect& operator += (const wxRect& rect);
7742598f
RR
270#endif
271
f03fc89f
VZ
272public:
273 long x, y, width, height;
274};
c801d85f 275
f03fc89f 276// ---------------------------------------------------------------------------
c801d85f 277// Management of pens, brushes and fonts
f03fc89f
VZ
278// ---------------------------------------------------------------------------
279
280class WXDLLEXPORT wxPenList : public wxList
c801d85f 281{
f03fc89f
VZ
282 DECLARE_DYNAMIC_CLASS(wxPenList)
283
284public:
285 wxPenList() { }
286 ~wxPenList();
287
288 void AddPen(wxPen *pen);
289 void RemovePen(wxPen *pen);
290 wxPen *FindOrCreatePen(const wxColour& colour, int width, int style);
c801d85f
KB
291};
292
f03fc89f 293class WXDLLEXPORT wxBrushList : public wxList
c801d85f 294{
f03fc89f
VZ
295 DECLARE_DYNAMIC_CLASS(wxBrushList)
296
297public:
298 wxBrushList() { }
299 ~wxBrushList();
300
301 void AddBrush(wxBrush *brush);
302 void RemoveBrush(wxBrush *brush);
303 wxBrush *FindOrCreateBrush(const wxColour& colour, int style);
c801d85f
KB
304};
305
9d2f3c71 306WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
c801d85f 307
f03fc89f 308class WXDLLEXPORT wxFontList : public wxList
c801d85f 309{
f03fc89f
VZ
310 DECLARE_DYNAMIC_CLASS(wxFontList)
311
312public:
313 wxFontList() { }
314 ~wxFontList();
315
316 void AddFont(wxFont *font);
317 void RemoveFont(wxFont *font);
318 wxFont *FindOrCreateFont(int pointSize, int family, int style, int weight,
319 bool underline = FALSE,
320 const wxString& face = wxEmptyString);
c801d85f
KB
321};
322
f03fc89f 323class WXDLLEXPORT wxColourDatabase : public wxList
c801d85f 324{
f03fc89f
VZ
325 DECLARE_CLASS(wxColourDatabase)
326
327public:
328 wxColourDatabase(int type);
329 ~wxColourDatabase() ;
330
331 // Not const because it may add a name to the database
332 wxColour *FindColour(const wxString& colour) ;
333 wxString FindName(const wxColour& colour) const;
334 void Initialize();
c801d85f
KB
335};
336
f03fc89f 337class WXDLLEXPORT wxBitmapList : public wxList
c801d85f 338{
f03fc89f 339 DECLARE_DYNAMIC_CLASS(wxBitmapList)
c801d85f 340
f03fc89f
VZ
341public:
342 wxBitmapList();
343 ~wxBitmapList();
344
345 void AddBitmap(wxBitmap *bitmap);
346 void RemoveBitmap(wxBitmap *bitmap);
c801d85f
KB
347};
348
f03fc89f
VZ
349class WXDLLEXPORT wxResourceCache: public wxList
350{
351public:
352 wxResourceCache() { }
353 wxResourceCache(const unsigned int keyType) : wxList(keyType) { }
354 ~wxResourceCache();
355
356private:
357 DECLARE_DYNAMIC_CLASS(wxResourceCache)
358};
359
360// ---------------------------------------------------------------------------
361// global variables
362// ---------------------------------------------------------------------------
363
c801d85f 364// Lists of GDI objects
f03fc89f
VZ
365WXDLLEXPORT_DATA(extern wxPenList*) wxThePenList;
366WXDLLEXPORT_DATA(extern wxBrushList*) wxTheBrushList;
367WXDLLEXPORT_DATA(extern wxFontList*) wxTheFontList;
368WXDLLEXPORT_DATA(extern wxBitmapList*) wxTheBitmapList;
c801d85f
KB
369
370// Stock objects
f03fc89f
VZ
371WXDLLEXPORT_DATA(extern wxFont*) wxNORMAL_FONT;
372WXDLLEXPORT_DATA(extern wxFont*) wxSMALL_FONT;
373WXDLLEXPORT_DATA(extern wxFont*) wxITALIC_FONT;
374WXDLLEXPORT_DATA(extern wxFont*) wxSWISS_FONT;
375
376WXDLLEXPORT_DATA(extern wxPen*) wxRED_PEN;
377WXDLLEXPORT_DATA(extern wxPen*) wxCYAN_PEN;
378WXDLLEXPORT_DATA(extern wxPen*) wxGREEN_PEN;
379WXDLLEXPORT_DATA(extern wxPen*) wxBLACK_PEN;
380WXDLLEXPORT_DATA(extern wxPen*) wxWHITE_PEN;
381WXDLLEXPORT_DATA(extern wxPen*) wxTRANSPARENT_PEN;
382WXDLLEXPORT_DATA(extern wxPen*) wxBLACK_DASHED_PEN;
383WXDLLEXPORT_DATA(extern wxPen*) wxGREY_PEN;
384WXDLLEXPORT_DATA(extern wxPen*) wxMEDIUM_GREY_PEN;
385WXDLLEXPORT_DATA(extern wxPen*) wxLIGHT_GREY_PEN;
386
387WXDLLEXPORT_DATA(extern wxBrush*) wxBLUE_BRUSH;
388WXDLLEXPORT_DATA(extern wxBrush*) wxGREEN_BRUSH;
389WXDLLEXPORT_DATA(extern wxBrush*) wxWHITE_BRUSH;
390WXDLLEXPORT_DATA(extern wxBrush*) wxBLACK_BRUSH;
391WXDLLEXPORT_DATA(extern wxBrush*) wxGREY_BRUSH;
392WXDLLEXPORT_DATA(extern wxBrush*) wxMEDIUM_GREY_BRUSH;
393WXDLLEXPORT_DATA(extern wxBrush*) wxLIGHT_GREY_BRUSH;
394WXDLLEXPORT_DATA(extern wxBrush*) wxTRANSPARENT_BRUSH;
395WXDLLEXPORT_DATA(extern wxBrush*) wxCYAN_BRUSH;
396WXDLLEXPORT_DATA(extern wxBrush*) wxRED_BRUSH;
397
398WXDLLEXPORT_DATA(extern wxColour*) wxBLACK;
399WXDLLEXPORT_DATA(extern wxColour*) wxWHITE;
400WXDLLEXPORT_DATA(extern wxColour*) wxRED;
401WXDLLEXPORT_DATA(extern wxColour*) wxBLUE;
402WXDLLEXPORT_DATA(extern wxColour*) wxGREEN;
403WXDLLEXPORT_DATA(extern wxColour*) wxCYAN;
404WXDLLEXPORT_DATA(extern wxColour*) wxLIGHT_GREY;
c801d85f
KB
405
406// 'Null' objects
f03fc89f
VZ
407WXDLLEXPORT_DATA(extern wxBitmap) wxNullBitmap;
408WXDLLEXPORT_DATA(extern wxIcon) wxNullIcon;
409WXDLLEXPORT_DATA(extern wxCursor) wxNullCursor;
410WXDLLEXPORT_DATA(extern wxPen) wxNullPen;
411WXDLLEXPORT_DATA(extern wxBrush) wxNullBrush;
412WXDLLEXPORT_DATA(extern wxPalette) wxNullPalette;
413WXDLLEXPORT_DATA(extern wxFont) wxNullFont;
414WXDLLEXPORT_DATA(extern wxColour) wxNullColour;
c801d85f
KB
415
416// Stock cursors types
f03fc89f
VZ
417WXDLLEXPORT_DATA(extern wxCursor*) wxSTANDARD_CURSOR;
418WXDLLEXPORT_DATA(extern wxCursor*) wxHOURGLASS_CURSOR;
419WXDLLEXPORT_DATA(extern wxCursor*) wxCROSS_CURSOR;
420
421WXDLLEXPORT_DATA(extern wxColourDatabase*) wxTheColourDatabase;
422
423WXDLLEXPORT_DATA(extern const wxChar*) wxPanelNameStr;
c801d85f 424
f03fc89f
VZ
425WXDLLEXPORT_DATA(extern const wxSize) wxDefaultSize;
426WXDLLEXPORT_DATA(extern const wxPoint) wxDefaultPosition;
427
428// The list of objects which should be deleted
429WXDLLEXPORT_DATA(extern wxList) wxPendingDelete;
430
431// ---------------------------------------------------------------------------
432// global functions
433// ---------------------------------------------------------------------------
434
435// resource management
6a6c0a8b 436extern void WXDLLEXPORT wxInitializeStockObjects();
a3622daa 437extern void WXDLLEXPORT wxInitializeStockLists();
6a6c0a8b 438extern void WXDLLEXPORT wxDeleteStockObjects();
a3622daa 439extern void WXDLLEXPORT wxDeleteStockLists();
c801d85f 440
f03fc89f 441// is the display colour (or monochrome)?
6a6c0a8b 442extern bool WXDLLEXPORT wxColourDisplay();
c801d85f
KB
443
444// Returns depth of screen
6a6c0a8b
JS
445extern int WXDLLEXPORT wxDisplayDepth();
446#define wxGetDisplayDepth wxDisplayDepth
c801d85f 447
f03fc89f 448// get the diaplay size
c801d85f 449extern void WXDLLEXPORT wxDisplaySize(int *width, int *height);
6a6c0a8b 450extern wxSize WXDLLEXPORT wxGetDisplaySize();
c801d85f 451
f03fc89f 452// set global cursor
c801d85f
KB
453extern void WXDLLEXPORT wxSetCursor(const wxCursor& cursor);
454
c801d85f 455#endif
34138703 456 // _WX_GDICMNH__