Reformatted Motif headers; added __WXX11__ symbol support to common headers;
[wxWidgets.git] / include / wx / gdicmn.h
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)
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_GDICMNH__
13 #define _WX_GDICMNH__
14
15 // ---------------------------------------------------------------------------
16 // headers
17 // ---------------------------------------------------------------------------
18
19 #ifdef __GNUG__
20 #pragma interface "gdicmn.h"
21 #endif
22
23 #include "wx/object.h"
24 #include "wx/list.h"
25 #include "wx/hash.h"
26 #include "wx/string.h"
27 #include "wx/setup.h"
28 #include "wx/colour.h"
29 #include "wx/font.h"
30
31 // ---------------------------------------------------------------------------
32 // forward declarations
33 // ---------------------------------------------------------------------------
34
35 class WXDLLEXPORT wxBitmap;
36 class WXDLLEXPORT wxBrush;
37 class WXDLLEXPORT wxColour;
38 class WXDLLEXPORT wxCursor;
39 class WXDLLEXPORT wxFont;
40 class WXDLLEXPORT wxIcon;
41 class WXDLLEXPORT wxPalette;
42 class WXDLLEXPORT wxPen;
43 class WXDLLEXPORT wxRegion;
44 class WXDLLEXPORT wxString;
45
46 // ---------------------------------------------------------------------------
47 // constants
48 // ---------------------------------------------------------------------------
49
50 // Bitmap flags
51 enum wxBitmapType
52 {
53 wxBITMAP_TYPE_INVALID, // should be == 0 for compatibility!
54 wxBITMAP_TYPE_BMP,
55 wxBITMAP_TYPE_BMP_RESOURCE,
56 wxBITMAP_TYPE_RESOURCE = wxBITMAP_TYPE_BMP_RESOURCE,
57 wxBITMAP_TYPE_ICO,
58 wxBITMAP_TYPE_ICO_RESOURCE,
59 wxBITMAP_TYPE_CUR,
60 wxBITMAP_TYPE_CUR_RESOURCE,
61 wxBITMAP_TYPE_XBM,
62 wxBITMAP_TYPE_XBM_DATA,
63 wxBITMAP_TYPE_XPM,
64 wxBITMAP_TYPE_XPM_DATA,
65 wxBITMAP_TYPE_TIF,
66 wxBITMAP_TYPE_TIF_RESOURCE,
67 wxBITMAP_TYPE_GIF,
68 wxBITMAP_TYPE_GIF_RESOURCE,
69 wxBITMAP_TYPE_PNG,
70 wxBITMAP_TYPE_PNG_RESOURCE,
71 wxBITMAP_TYPE_JPEG,
72 wxBITMAP_TYPE_JPEG_RESOURCE,
73 wxBITMAP_TYPE_PNM,
74 wxBITMAP_TYPE_PNM_RESOURCE,
75 wxBITMAP_TYPE_PCX,
76 wxBITMAP_TYPE_PCX_RESOURCE,
77 wxBITMAP_TYPE_PICT,
78 wxBITMAP_TYPE_PICT_RESOURCE,
79 wxBITMAP_TYPE_ICON,
80 wxBITMAP_TYPE_ICON_RESOURCE,
81 wxBITMAP_TYPE_ANI,
82 wxBITMAP_TYPE_IFF,
83 wxBITMAP_TYPE_MACCURSOR,
84 wxBITMAP_TYPE_MACCURSOR_RESOURCE,
85 wxBITMAP_TYPE_ANY = 50
86 };
87
88 // Standard cursors
89 enum wxStockCursor
90 {
91 wxCURSOR_NONE, // should be 0
92 wxCURSOR_ARROW,
93 wxCURSOR_BULLSEYE,
94 wxCURSOR_CHAR,
95 wxCURSOR_CROSS,
96 wxCURSOR_HAND,
97 wxCURSOR_IBEAM,
98 wxCURSOR_LEFT_BUTTON,
99 wxCURSOR_MAGNIFIER,
100 wxCURSOR_MIDDLE_BUTTON,
101 wxCURSOR_NO_ENTRY,
102 wxCURSOR_PAINT_BRUSH,
103 wxCURSOR_PENCIL,
104 wxCURSOR_POINT_LEFT,
105 wxCURSOR_POINT_RIGHT,
106 wxCURSOR_QUESTION_ARROW,
107 wxCURSOR_RIGHT_BUTTON,
108 wxCURSOR_SIZENESW,
109 wxCURSOR_SIZENS,
110 wxCURSOR_SIZENWSE,
111 wxCURSOR_SIZEWE,
112 wxCURSOR_SIZING,
113 wxCURSOR_SPRAYCAN,
114 wxCURSOR_WAIT,
115 wxCURSOR_WATCH,
116 wxCURSOR_BLANK,
117 #ifdef __WXGTK__
118 wxCURSOR_DEFAULT, // standard X11 cursor
119 #endif
120 #ifdef __X__
121 // Not yet implemented for Windows
122 wxCURSOR_CROSS_REVERSE,
123 wxCURSOR_DOUBLE_ARROW,
124 wxCURSOR_BASED_ARROW_UP,
125 wxCURSOR_BASED_ARROW_DOWN,
126 #endif // X11
127
128 wxCURSOR_ARROWWAIT,
129
130 wxCURSOR_MAX
131 };
132
133 #ifndef __WXGTK__
134 #define wxCURSOR_DEFAULT wxCURSOR_ARROW
135 #endif
136
137 // ---------------------------------------------------------------------------
138 // macros
139 // ---------------------------------------------------------------------------
140
141 /* Useful macro for creating icons portably, for example:
142
143 wxIcon *icon = new wxICON(mondrian);
144
145 expands into:
146
147 wxIcon *icon = new wxIcon("mondrian"); // On wxMSW
148 wxIcon *icon = new wxIcon(mondrian_xpm); // On wxGTK
149 */
150
151 #ifdef __WXMSW__
152 // Load from a resource
153 #define wxICON(X) wxIcon("" #X "")
154 #elif defined(__WXPM__)
155 // Load from a resource
156 #define wxICON(X) wxIcon("" #X "")
157 #elif defined(__WXMGL__)
158 // Initialize from an included XPM
159 #define wxICON(X) wxIcon( (const char**) X##_xpm )
160 #elif defined(__WXGTK__)
161 // Initialize from an included XPM
162 #define wxICON(X) wxIcon( (const char**) X##_xpm )
163 #elif defined(__WXMAC__)
164 // Initialize from an included XPM
165 #define wxICON(X) wxIcon( (const char**) X##_xpm )
166 #elif defined(__WXMOTIF__)
167 // Initialize from an included XPM
168 #define wxICON(X) wxIcon( X##_xpm )
169 #elif defined(__WXX11__)
170 // Initialize from an included XPM
171 #define wxICON(X) wxIcon( X##_xpm )
172 #else
173 // This will usually mean something on any platform
174 #define wxICON(X) wxIcon("" #X "")
175 #endif // platform
176
177 /* Another macro: this one is for portable creation of bitmaps. We assume that
178 under Unix bitmaps live in XPMs and under Windows they're in ressources.
179 */
180
181 #if defined(__WXMSW__) || defined(__WXPM__)
182 #define wxBITMAP(name) wxBitmap(#name, wxBITMAP_TYPE_RESOURCE)
183 #elif defined(__WXGTK__) || defined(__WXMOTIF__) || defined(__WXX11__) || defined(__WXMAC__) || defined(__WXMGL__)
184 // Initialize from an included XPM
185 #define wxBITMAP(name) wxBitmap( (const char**) name##_xpm )
186 #else // other platforms
187 #define wxBITMAP(name) wxBitmap(name##_xpm, wxBITMAP_TYPE_XPM)
188 #endif // platform
189
190 // ===========================================================================
191 // classes
192 // ===========================================================================
193
194 // ---------------------------------------------------------------------------
195 // wxSize
196 // ---------------------------------------------------------------------------
197
198 class WXDLLEXPORT wxSize
199 {
200 public:
201 // members are public for compatibility (don't use them directly,
202 // especially that there names were chosen very unfortunately - they should
203 // have been called width and height)
204 int x, y;
205
206 // constructors
207 wxSize() { x = y = 0; }
208 wxSize(int xx, int yy) { Set(xx, yy); }
209
210 // no copy ctor or assignment operator - the defaults are ok
211
212 bool operator==(const wxSize& sz) const { return x == sz.x && y == sz.y; }
213 bool operator!=(const wxSize& sz) const { return x != sz.x || y != sz.y; }
214
215 // FIXME are these really useful? If they're, we should have += &c as well
216 wxSize operator+(const wxSize& sz) { return wxSize(x + sz.x, y + sz.y); }
217 wxSize operator-(const wxSize& sz) { return wxSize(x - sz.x, y - sz.y); }
218
219 // accessors void Set(int xx, int yy) { x = xx; y = yy; }
220 void SetWidth(int w) { x = w; }
221 void SetHeight(int h) { y = h; }
222
223 int GetWidth() const { return x; }
224 int GetHeight() const { return y; }
225
226 // compatibility
227 int GetX() const { return x; }
228 int GetY() const { return y; }
229 };
230
231 // ---------------------------------------------------------------------------
232 // Point classes: with real or integer coordinates
233 // ---------------------------------------------------------------------------
234
235 class WXDLLEXPORT wxRealPoint
236 {
237 public:
238 double x;
239 double y;
240
241 wxRealPoint() { x = y = 0.0; };
242 wxRealPoint(double xx, double yy) { x = xx; y = yy; };
243
244 wxRealPoint operator+(const wxRealPoint& pt) const { return wxRealPoint(x + pt.x, y + pt.y); }
245 wxRealPoint operator-(const wxRealPoint& pt) const { return wxRealPoint(x - pt.x, y - pt.y); }
246
247 bool operator==(const wxRealPoint& pt) const { return x == pt.x && y == pt.y; }
248 };
249
250 class WXDLLEXPORT wxPoint
251 {
252 public:
253 int x, y;
254
255 wxPoint() { x = y = 0; };
256 wxPoint(int xx, int yy) { x = xx; y = yy; };
257
258 // no copy ctor or assignment operator - the defaults are ok
259
260 // comparison
261 bool operator==(const wxPoint& p) const { return x == p.x && y == p.y; }
262 bool operator!=(const wxPoint& p) const { return !(*this == p); }
263
264 // arithmetic operations (component wise)
265 wxPoint operator+(const wxPoint& p) const { return wxPoint(x + p.x, y + p.y); }
266 wxPoint operator-(const wxPoint& p) const { return wxPoint(x - p.x, y - p.y); }
267
268 wxPoint& operator+=(const wxPoint& p) { x += p.x; y += p.y; return *this; }
269 wxPoint& operator-=(const wxPoint& p) { x -= p.x; y -= p.y; return *this; }
270 };
271
272 #if WXWIN_COMPATIBILITY
273 #define wxIntPoint wxPoint
274 #define wxRectangle wxRect
275 #endif // WXWIN_COMPATIBILITY
276
277 // ---------------------------------------------------------------------------
278 // wxRect
279 // ---------------------------------------------------------------------------
280
281 class WXDLLEXPORT wxRect
282 {
283 public:
284 wxRect() { x = y = width = height = 0; }
285 wxRect(int xx, int yy, int ww, int hh)
286 { x = xx; y = yy; width = ww; height = hh; }
287 wxRect(const wxPoint& topLeft, const wxPoint& bottomRight);
288 wxRect(const wxPoint& pos, const wxSize& size);
289
290 // default copy ctor and assignment operators ok
291
292 int GetX() const { return x; }
293 void SetX(int xx) { x = xx; }
294
295 int GetY() const { return y; }
296 void SetY(int yy) { y = yy; }
297
298 int GetWidth() const { return width; }
299 void SetWidth(int w) { width = w; }
300
301 int GetHeight() const { return height; }
302 void SetHeight(int h) { height = h; }
303
304 wxPoint GetPosition() const { return wxPoint(x, y); }
305 wxSize GetSize() const { return wxSize(width, height); }
306
307 int GetLeft() const { return x; }
308 int GetTop() const { return y; }
309 int GetBottom() const { return y + height - 1; }
310 int GetRight() const { return x + width - 1; }
311
312 void SetLeft(int left) { x = left; }
313 void SetRight(int right) { width = right - x + 1; }
314 void SetTop(int top) { y = top; }
315 void SetBottom(int bottom) { height = bottom - y + 1; }
316
317 // operations with rect
318 wxRect& Inflate(wxCoord dx, wxCoord dy);
319 wxRect& Inflate(wxCoord d) { return Inflate(d, d); }
320 wxRect Inflate(wxCoord dx, wxCoord dy) const
321 {
322 wxRect r = *this;
323 r.Inflate(dx, dy);
324 return r;
325 }
326
327 wxRect& Deflate(wxCoord dx, wxCoord dy) { return Inflate(-dx, -dy); }
328 wxRect& Deflate(wxCoord d) { return Inflate(-d); }
329 wxRect Deflate(wxCoord dx, wxCoord dy) const
330 {
331 wxRect r = *this;
332 r.Deflate(dx, dy);
333 return r;
334 }
335
336 void Offset(wxCoord dx, wxCoord dy) { x += dx; y += dy; }
337 void Offset(const wxPoint& pt) { Offset(pt.x, pt.y); }
338
339 wxRect& Intersect(const wxRect& rect);
340 wxRect Intersect(const wxRect& rect) const
341 {
342 wxRect r = *this;
343 r.Intersect(rect);
344 return r;
345 }
346
347 wxRect operator+(const wxRect& rect) const;
348 wxRect& operator+=(const wxRect& rect);
349
350 // compare rectangles
351 bool operator==(const wxRect& rect) const;
352 bool operator!=(const wxRect& rect) const { return !(*this == rect); }
353
354 // return TRUE if the point is (not strcitly) inside the rect
355 bool Inside(int x, int y) const;
356 bool Inside(const wxPoint& pt) const { return Inside(pt.x, pt.y); }
357
358 // return TRUE if the rectangles have a non empty intersection
359 bool Intersects(const wxRect& rect) const;
360
361 public:
362 int x, y, width, height;
363 };
364
365 // ---------------------------------------------------------------------------
366 // Management of pens, brushes and fonts
367 // ---------------------------------------------------------------------------
368
369 typedef wxInt8 wxDash;
370
371 class WXDLLEXPORT wxPenList : public wxList
372 {
373 DECLARE_DYNAMIC_CLASS(wxPenList)
374
375 public:
376 wxPenList() { }
377 ~wxPenList();
378
379 void AddPen(wxPen *pen);
380 void RemovePen(wxPen *pen);
381 wxPen *FindOrCreatePen(const wxColour& colour, int width, int style);
382 };
383
384 class WXDLLEXPORT wxBrushList : public wxList
385 {
386 DECLARE_DYNAMIC_CLASS(wxBrushList)
387
388 public:
389 wxBrushList() { }
390 ~wxBrushList();
391
392 void AddBrush(wxBrush *brush);
393 void RemoveBrush(wxBrush *brush);
394 wxBrush *FindOrCreateBrush(const wxColour& colour, int style);
395 };
396
397 WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
398
399 class WXDLLEXPORT wxFontList : public wxList
400 {
401 DECLARE_DYNAMIC_CLASS(wxFontList)
402
403 public:
404 wxFontList() { }
405 ~wxFontList();
406
407 void AddFont(wxFont *font);
408 void RemoveFont(wxFont *font);
409 wxFont *FindOrCreateFont(int pointSize, int family, int style, int weight,
410 bool underline = FALSE,
411 const wxString& face = wxEmptyString,
412 wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
413 };
414
415 class WXDLLEXPORT wxColourDatabase : public wxList
416 {
417 DECLARE_CLASS(wxColourDatabase)
418
419 public:
420 wxColourDatabase(int type);
421 ~wxColourDatabase() ;
422
423 // Not const because it may add a name to the database
424 wxColour *FindColour(const wxString& colour) ;
425 wxString FindName(const wxColour& colour) const;
426 void Initialize();
427 #ifdef __WXPM__
428 // PM keeps its own type of colour table
429 long* m_palTable;
430 size_t m_nSize;
431 #endif
432 };
433
434 class WXDLLEXPORT wxBitmapList : public wxList
435 {
436 DECLARE_DYNAMIC_CLASS(wxBitmapList)
437
438 public:
439 wxBitmapList();
440 ~wxBitmapList();
441
442 void AddBitmap(wxBitmap *bitmap);
443 void RemoveBitmap(wxBitmap *bitmap);
444 };
445
446 class WXDLLEXPORT wxResourceCache: public wxList
447 {
448 public:
449 wxResourceCache() { }
450 wxResourceCache(const unsigned int keyType) : wxList(keyType) { }
451 ~wxResourceCache();
452
453 private:
454 DECLARE_DYNAMIC_CLASS(wxResourceCache)
455 };
456
457 // ---------------------------------------------------------------------------
458 // global variables
459 // ---------------------------------------------------------------------------
460
461 // Lists of GDI objects
462 WXDLLEXPORT_DATA(extern wxPenList*) wxThePenList;
463 WXDLLEXPORT_DATA(extern wxBrushList*) wxTheBrushList;
464 WXDLLEXPORT_DATA(extern wxFontList*) wxTheFontList;
465 WXDLLEXPORT_DATA(extern wxBitmapList*) wxTheBitmapList;
466
467 // Stock objects
468 WXDLLEXPORT_DATA(extern wxFont*) wxNORMAL_FONT;
469 WXDLLEXPORT_DATA(extern wxFont*) wxSMALL_FONT;
470 WXDLLEXPORT_DATA(extern wxFont*) wxITALIC_FONT;
471 WXDLLEXPORT_DATA(extern wxFont*) wxSWISS_FONT;
472
473 WXDLLEXPORT_DATA(extern wxPen*) wxRED_PEN;
474 WXDLLEXPORT_DATA(extern wxPen*) wxCYAN_PEN;
475 WXDLLEXPORT_DATA(extern wxPen*) wxGREEN_PEN;
476 WXDLLEXPORT_DATA(extern wxPen*) wxBLACK_PEN;
477 WXDLLEXPORT_DATA(extern wxPen*) wxWHITE_PEN;
478 WXDLLEXPORT_DATA(extern wxPen*) wxTRANSPARENT_PEN;
479 WXDLLEXPORT_DATA(extern wxPen*) wxBLACK_DASHED_PEN;
480 WXDLLEXPORT_DATA(extern wxPen*) wxGREY_PEN;
481 WXDLLEXPORT_DATA(extern wxPen*) wxMEDIUM_GREY_PEN;
482 WXDLLEXPORT_DATA(extern wxPen*) wxLIGHT_GREY_PEN;
483
484 WXDLLEXPORT_DATA(extern wxBrush*) wxBLUE_BRUSH;
485 WXDLLEXPORT_DATA(extern wxBrush*) wxGREEN_BRUSH;
486 WXDLLEXPORT_DATA(extern wxBrush*) wxWHITE_BRUSH;
487 WXDLLEXPORT_DATA(extern wxBrush*) wxBLACK_BRUSH;
488 WXDLLEXPORT_DATA(extern wxBrush*) wxGREY_BRUSH;
489 WXDLLEXPORT_DATA(extern wxBrush*) wxMEDIUM_GREY_BRUSH;
490 WXDLLEXPORT_DATA(extern wxBrush*) wxLIGHT_GREY_BRUSH;
491 WXDLLEXPORT_DATA(extern wxBrush*) wxTRANSPARENT_BRUSH;
492 WXDLLEXPORT_DATA(extern wxBrush*) wxCYAN_BRUSH;
493 WXDLLEXPORT_DATA(extern wxBrush*) wxRED_BRUSH;
494
495 WXDLLEXPORT_DATA(extern wxColour*) wxBLACK;
496 WXDLLEXPORT_DATA(extern wxColour*) wxWHITE;
497 WXDLLEXPORT_DATA(extern wxColour*) wxRED;
498 WXDLLEXPORT_DATA(extern wxColour*) wxBLUE;
499 WXDLLEXPORT_DATA(extern wxColour*) wxGREEN;
500 WXDLLEXPORT_DATA(extern wxColour*) wxCYAN;
501 WXDLLEXPORT_DATA(extern wxColour*) wxLIGHT_GREY;
502
503 // 'Null' objects
504 WXDLLEXPORT_DATA(extern wxBitmap) wxNullBitmap;
505 WXDLLEXPORT_DATA(extern wxIcon) wxNullIcon;
506 WXDLLEXPORT_DATA(extern wxCursor) wxNullCursor;
507 WXDLLEXPORT_DATA(extern wxPen) wxNullPen;
508 WXDLLEXPORT_DATA(extern wxBrush) wxNullBrush;
509 WXDLLEXPORT_DATA(extern wxPalette) wxNullPalette;
510 WXDLLEXPORT_DATA(extern wxFont) wxNullFont;
511 WXDLLEXPORT_DATA(extern wxColour) wxNullColour;
512
513 // Stock cursors types
514 WXDLLEXPORT_DATA(extern wxCursor*) wxSTANDARD_CURSOR;
515 WXDLLEXPORT_DATA(extern wxCursor*) wxHOURGLASS_CURSOR;
516 WXDLLEXPORT_DATA(extern wxCursor*) wxCROSS_CURSOR;
517
518 WXDLLEXPORT_DATA(extern wxColourDatabase*) wxTheColourDatabase;
519
520 WXDLLEXPORT_DATA(extern const wxChar*) wxPanelNameStr;
521
522 WXDLLEXPORT_DATA(extern const wxSize) wxDefaultSize;
523 WXDLLEXPORT_DATA(extern const wxPoint) wxDefaultPosition;
524
525 // The list of objects which should be deleted
526 WXDLLEXPORT_DATA(extern wxList) wxPendingDelete;
527
528 // ---------------------------------------------------------------------------
529 // global functions
530 // ---------------------------------------------------------------------------
531
532 // resource management
533 extern void WXDLLEXPORT wxInitializeStockObjects();
534 extern void WXDLLEXPORT wxInitializeStockLists();
535 extern void WXDLLEXPORT wxDeleteStockObjects();
536 extern void WXDLLEXPORT wxDeleteStockLists();
537
538 // is the display colour (or monochrome)?
539 extern bool WXDLLEXPORT wxColourDisplay();
540
541 // Returns depth of screen
542 extern int WXDLLEXPORT wxDisplayDepth();
543 #define wxGetDisplayDepth wxDisplayDepth
544
545 // get the display size
546 extern void WXDLLEXPORT wxDisplaySize(int *width, int *height);
547 extern wxSize WXDLLEXPORT wxGetDisplaySize();
548 extern void WXDLLEXPORT wxDisplaySizeMM(int *width, int *height);
549 extern wxSize WXDLLEXPORT wxGetDisplaySizeMM();
550
551 // Get position and size of the display workarea
552 extern void WXDLLEXPORT wxClientDisplayRect(int *x, int *y, int *width, int *height);
553 extern wxRect WXDLLEXPORT wxGetClientDisplayRect();
554
555 // set global cursor
556 extern void WXDLLEXPORT wxSetCursor(const wxCursor& cursor);
557
558 #endif
559 // _WX_GDICMNH__