]> git.saurik.com Git - wxWidgets.git/blob - include/wx/gdicmn.h
rewrote wxHtmlHelpFrame using sizers
[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
220 void Set(int xx, int yy) { x = xx; y = yy; }
221 void SetWidth(int w) { x = w; }
222 void SetHeight(int h) { y = h; }
223
224 int GetWidth() const { return x; }
225 int GetHeight() const { return y; }
226
227 // compatibility
228 int GetX() const { return x; }
229 int GetY() const { return y; }
230 };
231
232 // ---------------------------------------------------------------------------
233 // Point classes: with real or integer coordinates
234 // ---------------------------------------------------------------------------
235
236 class WXDLLEXPORT wxRealPoint
237 {
238 public:
239 double x;
240 double y;
241
242 wxRealPoint() { x = y = 0.0; };
243 wxRealPoint(double xx, double yy) { x = xx; y = yy; };
244
245 wxRealPoint operator+(const wxRealPoint& pt) const { return wxRealPoint(x + pt.x, y + pt.y); }
246 wxRealPoint operator-(const wxRealPoint& pt) const { return wxRealPoint(x - pt.x, y - pt.y); }
247
248 bool operator==(const wxRealPoint& pt) const { return x == pt.x && y == pt.y; }
249 };
250
251 class WXDLLEXPORT wxPoint
252 {
253 public:
254 int x, y;
255
256 wxPoint() { x = y = 0; };
257 wxPoint(int xx, int yy) { x = xx; y = yy; };
258
259 // no copy ctor or assignment operator - the defaults are ok
260
261 // comparison
262 bool operator==(const wxPoint& p) const { return x == p.x && y == p.y; }
263 bool operator!=(const wxPoint& p) const { return !(*this == p); }
264
265 // arithmetic operations (component wise)
266 wxPoint operator+(const wxPoint& p) const { return wxPoint(x + p.x, y + p.y); }
267 wxPoint operator-(const wxPoint& p) const { return wxPoint(x - p.x, y - p.y); }
268
269 wxPoint& operator+=(const wxPoint& p) { x += p.x; y += p.y; return *this; }
270 wxPoint& operator-=(const wxPoint& p) { x -= p.x; y -= p.y; return *this; }
271 };
272
273 #if WXWIN_COMPATIBILITY
274 #define wxIntPoint wxPoint
275 #define wxRectangle wxRect
276 #endif // WXWIN_COMPATIBILITY
277
278 // ---------------------------------------------------------------------------
279 // wxRect
280 // ---------------------------------------------------------------------------
281
282 class WXDLLEXPORT wxRect
283 {
284 public:
285 wxRect() { x = y = width = height = 0; }
286 wxRect(int xx, int yy, int ww, int hh)
287 { x = xx; y = yy; width = ww; height = hh; }
288 wxRect(const wxPoint& topLeft, const wxPoint& bottomRight);
289 wxRect(const wxPoint& pos, const wxSize& size);
290
291 // default copy ctor and assignment operators ok
292
293 int GetX() const { return x; }
294 void SetX(int xx) { x = xx; }
295
296 int GetY() const { return y; }
297 void SetY(int yy) { y = yy; }
298
299 int GetWidth() const { return width; }
300 void SetWidth(int w) { width = w; }
301
302 int GetHeight() const { return height; }
303 void SetHeight(int h) { height = h; }
304
305 wxPoint GetPosition() const { return wxPoint(x, y); }
306 wxSize GetSize() const { return wxSize(width, height); }
307
308 int GetLeft() const { return x; }
309 int GetTop() const { return y; }
310 int GetBottom() const { return y + height - 1; }
311 int GetRight() const { return x + width - 1; }
312
313 void SetLeft(int left) { x = left; }
314 void SetRight(int right) { width = right - x + 1; }
315 void SetTop(int top) { y = top; }
316 void SetBottom(int bottom) { height = bottom - y + 1; }
317
318 // operations with rect
319 wxRect& Inflate(wxCoord dx, wxCoord dy);
320 wxRect& Inflate(wxCoord d) { return Inflate(d, d); }
321 wxRect Inflate(wxCoord dx, wxCoord dy) const
322 {
323 wxRect r = *this;
324 r.Inflate(dx, dy);
325 return r;
326 }
327
328 wxRect& Deflate(wxCoord dx, wxCoord dy) { return Inflate(-dx, -dy); }
329 wxRect& Deflate(wxCoord d) { return Inflate(-d); }
330 wxRect Deflate(wxCoord dx, wxCoord dy) const
331 {
332 wxRect r = *this;
333 r.Deflate(dx, dy);
334 return r;
335 }
336
337 void Offset(wxCoord dx, wxCoord dy) { x += dx; y += dy; }
338 void Offset(const wxPoint& pt) { Offset(pt.x, pt.y); }
339
340 wxRect& Intersect(const wxRect& rect);
341 wxRect Intersect(const wxRect& rect) const
342 {
343 wxRect r = *this;
344 r.Intersect(rect);
345 return r;
346 }
347
348 wxRect operator+(const wxRect& rect) const;
349 wxRect& operator+=(const wxRect& rect);
350
351 // compare rectangles
352 bool operator==(const wxRect& rect) const;
353 bool operator!=(const wxRect& rect) const { return !(*this == rect); }
354
355 // return TRUE if the point is (not strcitly) inside the rect
356 bool Inside(int x, int y) const;
357 bool Inside(const wxPoint& pt) const { return Inside(pt.x, pt.y); }
358
359 // return TRUE if the rectangles have a non empty intersection
360 bool Intersects(const wxRect& rect) const;
361
362 public:
363 int x, y, width, height;
364 };
365
366 // ---------------------------------------------------------------------------
367 // Management of pens, brushes and fonts
368 // ---------------------------------------------------------------------------
369
370 typedef wxInt8 wxDash;
371
372 class WXDLLEXPORT wxPenList : public wxList
373 {
374 DECLARE_DYNAMIC_CLASS(wxPenList)
375
376 public:
377 wxPenList() { }
378 ~wxPenList();
379
380 void AddPen(wxPen *pen);
381 void RemovePen(wxPen *pen);
382 wxPen *FindOrCreatePen(const wxColour& colour, int width, int style);
383 };
384
385 class WXDLLEXPORT wxBrushList : public wxList
386 {
387 DECLARE_DYNAMIC_CLASS(wxBrushList)
388
389 public:
390 wxBrushList() { }
391 ~wxBrushList();
392
393 void AddBrush(wxBrush *brush);
394 void RemoveBrush(wxBrush *brush);
395 wxBrush *FindOrCreateBrush(const wxColour& colour, int style);
396 };
397
398 WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
399
400 class WXDLLEXPORT wxFontList : public wxList
401 {
402 DECLARE_DYNAMIC_CLASS(wxFontList)
403
404 public:
405 wxFontList() { }
406 ~wxFontList();
407
408 void AddFont(wxFont *font);
409 void RemoveFont(wxFont *font);
410 wxFont *FindOrCreateFont(int pointSize, int family, int style, int weight,
411 bool underline = FALSE,
412 const wxString& face = wxEmptyString,
413 wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
414 };
415
416 class WXDLLEXPORT wxColourDatabase : public wxList
417 {
418 DECLARE_CLASS(wxColourDatabase)
419
420 public:
421 wxColourDatabase(int type);
422 ~wxColourDatabase() ;
423
424 // Not const because it may add a name to the database
425 wxColour *FindColour(const wxString& colour) ;
426 wxString FindName(const wxColour& colour) const;
427 void Initialize();
428 #ifdef __WXPM__
429 // PM keeps its own type of colour table
430 long* m_palTable;
431 size_t m_nSize;
432 #endif
433 };
434
435 class WXDLLEXPORT wxBitmapList : public wxList
436 {
437 DECLARE_DYNAMIC_CLASS(wxBitmapList)
438
439 public:
440 wxBitmapList();
441 ~wxBitmapList();
442
443 void AddBitmap(wxBitmap *bitmap);
444 void RemoveBitmap(wxBitmap *bitmap);
445 };
446
447 class WXDLLEXPORT wxResourceCache: public wxList
448 {
449 public:
450 wxResourceCache() { }
451 wxResourceCache(const unsigned int keyType) : wxList(keyType) { }
452 ~wxResourceCache();
453
454 private:
455 DECLARE_DYNAMIC_CLASS(wxResourceCache)
456 };
457
458 // ---------------------------------------------------------------------------
459 // global variables
460 // ---------------------------------------------------------------------------
461
462 // Lists of GDI objects
463 WXDLLEXPORT_DATA(extern wxPenList*) wxThePenList;
464 WXDLLEXPORT_DATA(extern wxBrushList*) wxTheBrushList;
465 WXDLLEXPORT_DATA(extern wxFontList*) wxTheFontList;
466 WXDLLEXPORT_DATA(extern wxBitmapList*) wxTheBitmapList;
467
468 // Stock objects
469 WXDLLEXPORT_DATA(extern wxFont*) wxNORMAL_FONT;
470 WXDLLEXPORT_DATA(extern wxFont*) wxSMALL_FONT;
471 WXDLLEXPORT_DATA(extern wxFont*) wxITALIC_FONT;
472 WXDLLEXPORT_DATA(extern wxFont*) wxSWISS_FONT;
473
474 WXDLLEXPORT_DATA(extern wxPen*) wxRED_PEN;
475 WXDLLEXPORT_DATA(extern wxPen*) wxCYAN_PEN;
476 WXDLLEXPORT_DATA(extern wxPen*) wxGREEN_PEN;
477 WXDLLEXPORT_DATA(extern wxPen*) wxBLACK_PEN;
478 WXDLLEXPORT_DATA(extern wxPen*) wxWHITE_PEN;
479 WXDLLEXPORT_DATA(extern wxPen*) wxTRANSPARENT_PEN;
480 WXDLLEXPORT_DATA(extern wxPen*) wxBLACK_DASHED_PEN;
481 WXDLLEXPORT_DATA(extern wxPen*) wxGREY_PEN;
482 WXDLLEXPORT_DATA(extern wxPen*) wxMEDIUM_GREY_PEN;
483 WXDLLEXPORT_DATA(extern wxPen*) wxLIGHT_GREY_PEN;
484
485 WXDLLEXPORT_DATA(extern wxBrush*) wxBLUE_BRUSH;
486 WXDLLEXPORT_DATA(extern wxBrush*) wxGREEN_BRUSH;
487 WXDLLEXPORT_DATA(extern wxBrush*) wxWHITE_BRUSH;
488 WXDLLEXPORT_DATA(extern wxBrush*) wxBLACK_BRUSH;
489 WXDLLEXPORT_DATA(extern wxBrush*) wxGREY_BRUSH;
490 WXDLLEXPORT_DATA(extern wxBrush*) wxMEDIUM_GREY_BRUSH;
491 WXDLLEXPORT_DATA(extern wxBrush*) wxLIGHT_GREY_BRUSH;
492 WXDLLEXPORT_DATA(extern wxBrush*) wxTRANSPARENT_BRUSH;
493 WXDLLEXPORT_DATA(extern wxBrush*) wxCYAN_BRUSH;
494 WXDLLEXPORT_DATA(extern wxBrush*) wxRED_BRUSH;
495
496 WXDLLEXPORT_DATA(extern wxColour*) wxBLACK;
497 WXDLLEXPORT_DATA(extern wxColour*) wxWHITE;
498 WXDLLEXPORT_DATA(extern wxColour*) wxRED;
499 WXDLLEXPORT_DATA(extern wxColour*) wxBLUE;
500 WXDLLEXPORT_DATA(extern wxColour*) wxGREEN;
501 WXDLLEXPORT_DATA(extern wxColour*) wxCYAN;
502 WXDLLEXPORT_DATA(extern wxColour*) wxLIGHT_GREY;
503
504 // 'Null' objects
505 WXDLLEXPORT_DATA(extern wxBitmap) wxNullBitmap;
506 WXDLLEXPORT_DATA(extern wxIcon) wxNullIcon;
507 WXDLLEXPORT_DATA(extern wxCursor) wxNullCursor;
508 WXDLLEXPORT_DATA(extern wxPen) wxNullPen;
509 WXDLLEXPORT_DATA(extern wxBrush) wxNullBrush;
510 WXDLLEXPORT_DATA(extern wxPalette) wxNullPalette;
511 WXDLLEXPORT_DATA(extern wxFont) wxNullFont;
512 WXDLLEXPORT_DATA(extern wxColour) wxNullColour;
513
514 // Stock cursors types
515 WXDLLEXPORT_DATA(extern wxCursor*) wxSTANDARD_CURSOR;
516 WXDLLEXPORT_DATA(extern wxCursor*) wxHOURGLASS_CURSOR;
517 WXDLLEXPORT_DATA(extern wxCursor*) wxCROSS_CURSOR;
518
519 WXDLLEXPORT_DATA(extern wxColourDatabase*) wxTheColourDatabase;
520
521 WXDLLEXPORT_DATA(extern const wxChar*) wxPanelNameStr;
522
523 WXDLLEXPORT_DATA(extern const wxSize) wxDefaultSize;
524 WXDLLEXPORT_DATA(extern const wxPoint) wxDefaultPosition;
525
526 // The list of objects which should be deleted
527 WXDLLEXPORT_DATA(extern wxList) wxPendingDelete;
528
529 // ---------------------------------------------------------------------------
530 // global functions
531 // ---------------------------------------------------------------------------
532
533 // resource management
534 extern void WXDLLEXPORT wxInitializeStockObjects();
535 extern void WXDLLEXPORT wxInitializeStockLists();
536 extern void WXDLLEXPORT wxDeleteStockObjects();
537 extern void WXDLLEXPORT wxDeleteStockLists();
538
539 // is the display colour (or monochrome)?
540 extern bool WXDLLEXPORT wxColourDisplay();
541
542 // Returns depth of screen
543 extern int WXDLLEXPORT wxDisplayDepth();
544 #define wxGetDisplayDepth wxDisplayDepth
545
546 // get the display size
547 extern void WXDLLEXPORT wxDisplaySize(int *width, int *height);
548 extern wxSize WXDLLEXPORT wxGetDisplaySize();
549 extern void WXDLLEXPORT wxDisplaySizeMM(int *width, int *height);
550 extern wxSize WXDLLEXPORT wxGetDisplaySizeMM();
551
552 // Get position and size of the display workarea
553 extern void WXDLLEXPORT wxClientDisplayRect(int *x, int *y, int *width, int *height);
554 extern wxRect WXDLLEXPORT wxGetClientDisplayRect();
555
556 // set global cursor
557 extern void WXDLLEXPORT wxSetCursor(const wxCursor& cursor);
558
559 #endif
560 // _WX_GDICMNH__