projects / wxWidgets.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
add uint/long/ulong overloads of operator* and operator/ to avoid problems with ambig...
[wxWidgets.git] / include / wx / gdicmn.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/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) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_GDICMNH__
13 #define _WX_GDICMNH__
14
15 // ---------------------------------------------------------------------------
16 // headers
17 // ---------------------------------------------------------------------------
18
19 #include "wx/defs.h"
20 #include "wx/list.h"
21 #include "wx/string.h"
22 #include "wx/fontenc.h"
23 #include "wx/hashmap.h"
24 #include "wx/math.h"
25
26 // ---------------------------------------------------------------------------
27 // forward declarations
28 // ---------------------------------------------------------------------------
29
30 class WXDLLIMPEXP_FWD_CORE wxBitmap;
31 class WXDLLIMPEXP_FWD_CORE wxBrush;
32 class WXDLLIMPEXP_FWD_CORE wxColour;
33 class WXDLLIMPEXP_FWD_CORE wxCursor;
34 class WXDLLIMPEXP_FWD_CORE wxFont;
35 class WXDLLIMPEXP_FWD_CORE wxIcon;
36 class WXDLLIMPEXP_FWD_CORE wxPalette;
37 class WXDLLIMPEXP_FWD_CORE wxPen;
38 class WXDLLIMPEXP_FWD_CORE wxRegion;
39 class WXDLLIMPEXP_FWD_BASE wxString;
40 class WXDLLIMPEXP_FWD_CORE wxIconBundle;
41 class WXDLLIMPEXP_FWD_CORE wxPoint;
42
43 // ---------------------------------------------------------------------------
44 // constants
45 // ---------------------------------------------------------------------------
46
47 // Bitmap flags
48 enum wxBitmapType
49 {
50 wxBITMAP_TYPE_INVALID, // should be == 0 for compatibility!
51 wxBITMAP_TYPE_BMP,
52 wxBITMAP_TYPE_BMP_RESOURCE,
53 wxBITMAP_TYPE_RESOURCE = wxBITMAP_TYPE_BMP_RESOURCE,
54 wxBITMAP_TYPE_ICO,
55 wxBITMAP_TYPE_ICO_RESOURCE,
56 wxBITMAP_TYPE_CUR,
57 wxBITMAP_TYPE_CUR_RESOURCE,
58 wxBITMAP_TYPE_XBM,
59 wxBITMAP_TYPE_XBM_DATA,
60 wxBITMAP_TYPE_XPM,
61 wxBITMAP_TYPE_XPM_DATA,
62 wxBITMAP_TYPE_TIF,
63 wxBITMAP_TYPE_TIF_RESOURCE,
64 wxBITMAP_TYPE_GIF,
65 wxBITMAP_TYPE_GIF_RESOURCE,
66 wxBITMAP_TYPE_PNG,
67 wxBITMAP_TYPE_PNG_RESOURCE,
68 wxBITMAP_TYPE_JPEG,
69 wxBITMAP_TYPE_JPEG_RESOURCE,
70 wxBITMAP_TYPE_PNM,
71 wxBITMAP_TYPE_PNM_RESOURCE,
72 wxBITMAP_TYPE_PCX,
73 wxBITMAP_TYPE_PCX_RESOURCE,
74 wxBITMAP_TYPE_PICT,
75 wxBITMAP_TYPE_PICT_RESOURCE,
76 wxBITMAP_TYPE_ICON,
77 wxBITMAP_TYPE_ICON_RESOURCE,
78 wxBITMAP_TYPE_ANI,
79 wxBITMAP_TYPE_IFF,
80 wxBITMAP_TYPE_TGA,
81 wxBITMAP_TYPE_MACCURSOR,
82 wxBITMAP_TYPE_MACCURSOR_RESOURCE,
83
84 wxBITMAP_TYPE_MAX,
85 wxBITMAP_TYPE_ANY = 50
86 };
87
88 // Polygon filling mode
89 enum wxPolygonFillMode
90 {
91 wxODDEVEN_RULE = 1,
92 wxWINDING_RULE
93 };
94
95 // Standard cursors
96 enum wxStockCursor
97 {
98 wxCURSOR_NONE, // should be 0
99 wxCURSOR_ARROW,
100 wxCURSOR_RIGHT_ARROW,
101 wxCURSOR_BULLSEYE,
102 wxCURSOR_CHAR,
103 wxCURSOR_CROSS,
104 wxCURSOR_HAND,
105 wxCURSOR_IBEAM,
106 wxCURSOR_LEFT_BUTTON,
107 wxCURSOR_MAGNIFIER,
108 wxCURSOR_MIDDLE_BUTTON,
109 wxCURSOR_NO_ENTRY,
110 wxCURSOR_PAINT_BRUSH,
111 wxCURSOR_PENCIL,
112 wxCURSOR_POINT_LEFT,
113 wxCURSOR_POINT_RIGHT,
114 wxCURSOR_QUESTION_ARROW,
115 wxCURSOR_RIGHT_BUTTON,
116 wxCURSOR_SIZENESW,
117 wxCURSOR_SIZENS,
118 wxCURSOR_SIZENWSE,
119 wxCURSOR_SIZEWE,
120 wxCURSOR_SIZING,
121 wxCURSOR_SPRAYCAN,
122 wxCURSOR_WAIT,
123 wxCURSOR_WATCH,
124 wxCURSOR_BLANK,
125 #ifdef __WXGTK__
126 wxCURSOR_DEFAULT, // standard X11 cursor
127 #endif
128 #ifdef __WXMAC__
129 wxCURSOR_COPY_ARROW , // MacOS Theme Plus arrow
130 #endif
131 #ifdef __X__
132 // Not yet implemented for Windows
133 wxCURSOR_CROSS_REVERSE,
134 wxCURSOR_DOUBLE_ARROW,
135 wxCURSOR_BASED_ARROW_UP,
136 wxCURSOR_BASED_ARROW_DOWN,
137 #endif // X11
138 wxCURSOR_ARROWWAIT,
139 #ifdef __WXMAC__
140 wxCURSOR_OPEN_HAND,
141 wxCURSOR_CLOSED_HAND,
142 #endif
143
144 wxCURSOR_MAX
145 };
146
147 #ifndef __WXGTK__
148 #define wxCURSOR_DEFAULT wxCURSOR_ARROW
149 #endif
150
151 #ifndef __WXMAC__
152 // TODO CS supply openhand and closedhand cursors
153 #define wxCURSOR_OPEN_HAND wxCURSOR_HAND
154 #define wxCURSOR_CLOSED_HAND wxCURSOR_HAND
155 #endif
156
157 // ---------------------------------------------------------------------------
158 // macros
159 // ---------------------------------------------------------------------------
160
161 /* Useful macro for creating icons portably, for example:
162
163 wxIcon *icon = new wxICON(mondrian);
164
165 expands into:
166
167 wxIcon *icon = new wxIcon("mondrian"); // On wxMSW
168 wxIcon *icon = new wxIcon(mondrian_xpm); // On wxGTK
169 */
170
171 #ifdef __WXMSW__
172 // Load from a resource
173 #define wxICON(X) wxIcon(wxT(#X))
174 #elif defined(__WXPM__)
175 // Load from a resource
176 #define wxICON(X) wxIcon(wxT(#X))
177 #elif defined(__WXMGL__)
178 // Initialize from an included XPM
179 #define wxICON(X) wxIcon( X##_xpm )
180 #elif defined(__WXDFB__)
181 // Initialize from an included XPM
182 #define wxICON(X) wxIcon( X##_xpm )
183 #elif defined(__WXGTK__)
184 // Initialize from an included XPM
185 #define wxICON(X) wxIcon( X##_xpm )
186 #elif defined(__WXMAC__)
187 // Initialize from an included XPM
188 #define wxICON(X) wxIcon( X##_xpm )
189 #elif defined(__WXMOTIF__)
190 // Initialize from an included XPM
191 #define wxICON(X) wxIcon( X##_xpm )
192 #elif defined(__WXX11__)
193 // Initialize from an included XPM
194 #define wxICON(X) wxIcon( X##_xpm )
195 #else
196 // This will usually mean something on any platform
197 #define wxICON(X) wxIcon(wxT(#X))
198 #endif // platform
199
200 /* Another macro: this one is for portable creation of bitmaps. We assume that
201 under Unix bitmaps live in XPMs and under Windows they're in ressources.
202 */
203
204 #if defined(__WXMSW__) || defined(__WXPM__)
205 #define wxBITMAP(name) wxBitmap(wxT(#name), wxBITMAP_TYPE_RESOURCE)
206 #elif defined(__WXGTK__) || \
207 defined(__WXMOTIF__) || \
208 defined(__WXX11__) || \
209 defined(__WXMAC__) || \
210 defined(__WXMGL__) || \
211 defined(__WXDFB__) || \
212 defined(__WXCOCOA__)
213 // Initialize from an included XPM
214 #define wxBITMAP(name) wxBitmap(name##_xpm)
215 #else // other platforms
216 #define wxBITMAP(name) wxBitmap(name##_xpm, wxBITMAP_TYPE_XPM)
217 #endif // platform
218
219 // ===========================================================================
220 // classes
221 // ===========================================================================
222
223 // ---------------------------------------------------------------------------
224 // wxSize
225 // ---------------------------------------------------------------------------
226
227 class WXDLLIMPEXP_CORE wxSize
228 {
229 public:
230 // members are public for compatibility, don't use them directly.
231 int x, y;
232
233 // constructors
234 wxSize() : x(0), y(0) { }
235 wxSize(int xx, int yy) : x(xx), y(yy) { }
236
237 // no copy ctor or assignment operator - the defaults are ok
238
239 wxSize& operator+=(const wxSize& sz) { x += sz.x; y += sz.y; return *this; }
240 wxSize& operator-=(const wxSize& sz) { x -= sz.x; y -= sz.y; return *this; }
241 wxSize& operator/=(int i) { x /= i; y /= i; return *this; }
242 wxSize& operator*=(int i) { x *= i; y *= i; return *this; }
243 wxSize& operator/=(unsigned int i) { x /= i; y /= i; return *this; }
244 wxSize& operator*=(unsigned int i) { x *= i; y *= i; return *this; }
245 wxSize& operator/=(long i) { x /= i; y /= i; return *this; }
246 wxSize& operator*=(long i) { x *= i; y *= i; return *this; }
247 wxSize& operator/=(unsigned long i) { x /= i; y /= i; return *this; }
248 wxSize& operator*=(unsigned long i) { x *= i; y *= i; return *this; }
249 wxSize& operator/=(double i) { x = int(x/i); y = int(y/i); return *this; }
250 wxSize& operator*=(double i) { x = int(x*i); y = int(y*i); return *this; }
251
252 void IncTo(const wxSize& sz)
253 { if ( sz.x > x ) x = sz.x; if ( sz.y > y ) y = sz.y; }
254 void DecTo(const wxSize& sz)
255 { if ( sz.x < x ) x = sz.x; if ( sz.y < y ) y = sz.y; }
256
257 void IncBy(int dx, int dy) { x += dx; y += dy; }
258 void IncBy(const wxSize& sz) { IncBy(sz.x, sz.y); }
259 void IncBy(int d) { IncBy(d, d); }
260
261 void DecBy(int dx, int dy) { IncBy(-dx, -dy); }
262 void DecBy(const wxSize& sz) { DecBy(sz.x, sz.y); }
263 void DecBy(int d) { DecBy(d, d); }
264
265
266 wxSize& Scale(float xscale, float yscale)
267 { x = (int)(x*xscale); y = (int)(y*yscale); return *this; }
268
269 // accessors
270 void Set(int xx, int yy) { x = xx; y = yy; }
271 void SetWidth(int w) { x = w; }
272 void SetHeight(int h) { y = h; }
273
274 int GetWidth() const { return x; }
275 int GetHeight() const { return y; }
276
277 bool IsFullySpecified() const { return x != wxDefaultCoord && y != wxDefaultCoord; }
278
279 // combine this size with the other one replacing the default (i.e. equal
280 // to wxDefaultCoord) components of this object with those of the other
281 void SetDefaults(const wxSize& size)
282 {
283 if ( x == wxDefaultCoord )
284 x = size.x;
285 if ( y == wxDefaultCoord )
286 y = size.y;
287 }
288
289 // compatibility
290 int GetX() const { return x; }
291 int GetY() const { return y; }
292 };
293
294 inline bool operator==(const wxSize& s1, const wxSize& s2)
295 {
296 return s1.x == s2.x && s1.y == s2.y;
297 }
298
299 inline bool operator!=(const wxSize& s1, const wxSize& s2)
300 {
301 return s1.x != s2.x || s1.y != s2.y;
302 }
303
304 inline wxSize operator+(const wxSize& s1, const wxSize& s2)
305 {
306 return wxSize(s1.x + s2.x, s1.y + s2.y);
307 }
308
309 inline wxSize operator-(const wxSize& s1, const wxSize& s2)
310 {
311 return wxSize(s1.x - s2.x, s1.y - s2.y);
312 }
313
314 inline wxSize operator/(const wxSize& s, int i)
315 {
316 return wxSize(s.x / i, s.y / i);
317 }
318
319 inline wxSize operator*(const wxSize& s, int i)
320 {
321 return wxSize(s.x * i, s.y * i);
322 }
323
324 inline wxSize operator*(int i, const wxSize& s)
325 {
326 return wxSize(s.x * i, s.y * i);
327 }
328
329 inline wxSize operator/(const wxSize& s, unsigned int i)
330 {
331 return wxSize(s.x / i, s.y / i);
332 }
333
334 inline wxSize operator*(const wxSize& s, unsigned int i)
335 {
336 return wxSize(s.x * i, s.y * i);
337 }
338
339 inline wxSize operator*(unsigned int i, const wxSize& s)
340 {
341 return wxSize(s.x * i, s.y * i);
342 }
343
344 inline wxSize operator/(const wxSize& s, long i)
345 {
346 return wxSize(s.x / i, s.y / i);
347 }
348
349 inline wxSize operator*(const wxSize& s, long i)
350 {
351 return wxSize(s.x * i, s.y * i);
352 }
353
354 inline wxSize operator*(long i, const wxSize& s)
355 {
356 return wxSize(s.x * i, s.y * i);
357 }
358
359 inline wxSize operator/(const wxSize& s, unsigned long i)
360 {
361 return wxSize(s.x / i, s.y / i);
362 }
363
364 inline wxSize operator*(const wxSize& s, unsigned long i)
365 {
366 return wxSize(s.x * i, s.y * i);
367 }
368
369 inline wxSize operator*(unsigned long i, const wxSize& s)
370 {
371 return wxSize(s.x * i, s.y * i);
372 }
373
374 inline wxSize operator*(const wxSize& s, double i)
375 {
376 return wxSize(int(s.x * i), int(s.y * i));
377 }
378
379 inline wxSize operator*(double i, const wxSize& s)
380 {
381 return wxSize(int(s.x * i), int(s.y * i));
382 }
383
384
385
386 // ---------------------------------------------------------------------------
387 // Point classes: with real or integer coordinates
388 // ---------------------------------------------------------------------------
389
390 class WXDLLIMPEXP_CORE wxRealPoint
391 {
392 public:
393 double x;
394 double y;
395
396 wxRealPoint() : x(0.0), y(0.0) { }
397 wxRealPoint(double xx, double yy) : x(xx), y(yy) { }
398 };
399
400
401 inline bool operator==(const wxRealPoint& p1, const wxRealPoint& p2)
402 {
403 return wxIsSameDouble(p1.x, p2.x) && wxIsSameDouble(p1.y, p2.y);
404 }
405
406
407 inline bool operator!=(const wxRealPoint& p1, const wxRealPoint& p2)
408 {
409 return !(p1 == p2);
410 }
411
412
413 inline wxRealPoint operator+(const wxRealPoint& p1, const wxRealPoint& p2)
414 {
415 return wxRealPoint(p1.x + p2.x, p1.y + p2.y);
416 }
417
418
419 inline wxRealPoint operator-(const wxRealPoint& p1, const wxRealPoint& p2)
420 {
421 return wxRealPoint(p1.x - p2.x, p1.y - p2.y);
422 }
423
424
425 // ----------------------------------------------------------------------------
426 // wxPoint: 2D point with integer coordinates
427 // ----------------------------------------------------------------------------
428
429 class WXDLLIMPEXP_CORE wxPoint
430 {
431 public:
432 int x, y;
433
434 wxPoint() : x(0), y(0) { }
435 wxPoint(int xx, int yy) : x(xx), y(yy) { }
436
437 // no copy ctor or assignment operator - the defaults are ok
438
439 //assignment operators
440 wxPoint& operator+=(const wxPoint& p) { x += p.x; y += p.y; return *this; }
441 wxPoint& operator-=(const wxPoint& p) { x -= p.x; y -= p.y; return *this; }
442
443 wxPoint& operator+=(const wxSize& s) { x += s.GetWidth(); y += s.GetHeight(); return *this; }
444 wxPoint& operator-=(const wxSize& s) { x -= s.GetWidth(); y -= s.GetHeight(); return *this; }
445 };
446
447
448 // comparison
449 inline bool operator==(const wxPoint& p1, const wxPoint& p2)
450 {
451 return p1.x == p2.x && p1.y == p2.y;
452 }
453
454 inline bool operator!=(const wxPoint& p1, const wxPoint& p2)
455 {
456 return !(p1 == p2);
457 }
458
459
460 // arithmetic operations (component wise)
461 inline wxPoint operator+(const wxPoint& p1, const wxPoint& p2)
462 {
463 return wxPoint(p1.x + p2.x, p1.y + p2.y);
464 }
465
466 inline wxPoint operator-(const wxPoint& p1, const wxPoint& p2)
467 {
468 return wxPoint(p1.x - p2.x, p1.y - p2.y);
469 }
470
471 inline wxPoint operator+(const wxPoint& p, const wxSize& s)
472 {
473 return wxPoint(p.x + s.x, p.y + s.y);
474 }
475
476 inline wxPoint operator-(const wxPoint& p, const wxSize& s)
477 {
478 return wxPoint(p.x - s.x, p.y - s.y);
479 }
480
481 inline wxPoint operator+(const wxSize& s, const wxPoint& p)
482 {
483 return wxPoint(p.x + s.x, p.y + s.y);
484 }
485
486 inline wxPoint operator-(const wxSize& s, const wxPoint& p)
487 {
488 return wxPoint(s.x - p.x, s.y - p.y);
489 }
490
491 inline wxPoint operator-(const wxPoint& p)
492 {
493 return wxPoint(-p.x, -p.y);
494 }
495
496 WX_DECLARE_LIST_WITH_DECL(wxPoint, wxPointList, class WXDLLIMPEXP_CORE);
497
498 // ---------------------------------------------------------------------------
499 // wxRect
500 // ---------------------------------------------------------------------------
501
502 class WXDLLIMPEXP_CORE wxRect
503 {
504 public:
505 wxRect()
506 : x(0), y(0), width(0), height(0)
507 { }
508 wxRect(int xx, int yy, int ww, int hh)
509 : x(xx), y(yy), width(ww), height(hh)
510 { }
511 wxRect(const wxPoint& topLeft, const wxPoint& bottomRight);
512 wxRect(const wxPoint& pt, const wxSize& size)
513 : x(pt.x), y(pt.y), width(size.x), height(size.y)
514 { }
515 wxRect(const wxSize& size)
516 : x(0), y(0), width(size.x), height(size.y)
517 { }
518
519 // default copy ctor and assignment operators ok
520
521 int GetX() const { return x; }
522 void SetX(int xx) { x = xx; }
523
524 int GetY() const { return y; }
525 void SetY(int yy) { y = yy; }
526
527 int GetWidth() const { return width; }
528 void SetWidth(int w) { width = w; }
529
530 int GetHeight() const { return height; }
531 void SetHeight(int h) { height = h; }
532
533 wxPoint GetPosition() const { return wxPoint(x, y); }
534 void SetPosition( const wxPoint &p ) { x = p.x; y = p.y; }
535
536 wxSize GetSize() const { return wxSize(width, height); }
537 void SetSize( const wxSize &s ) { width = s.GetWidth(); height = s.GetHeight(); }
538
539 bool IsEmpty() const { return (width <= 0) || (height <= 0); }
540
541 int GetLeft() const { return x; }
542 int GetTop() const { return y; }
543 int GetBottom() const { return y + height - 1; }
544 int GetRight() const { return x + width - 1; }
545
546 void SetLeft(int left) { x = left; }
547 void SetRight(int right) { width = right - x + 1; }
548 void SetTop(int top) { y = top; }
549 void SetBottom(int bottom) { height = bottom - y + 1; }
550
551 wxPoint GetTopLeft() const { return GetPosition(); }
552 wxPoint GetLeftTop() const { return GetTopLeft(); }
553 void SetTopLeft(const wxPoint &p) { SetPosition(p); }
554 void SetLeftTop(const wxPoint &p) { SetTopLeft(p); }
555
556 wxPoint GetBottomRight() const { return wxPoint(GetRight(), GetBottom()); }
557 wxPoint GetRightBottom() const { return GetBottomRight(); }
558 void SetBottomRight(const wxPoint &p) { SetRight(p.x); SetBottom(p.y); }
559 void SetRightBottom(const wxPoint &p) { SetBottomRight(p); }
560
561 wxPoint GetTopRight() const { return wxPoint(GetRight(), GetTop()); }
562 wxPoint GetRightTop() const { return GetTopRight(); }
563 void SetTopRight(const wxPoint &p) { SetRight(p.x); SetTop(p.y); }
564 void SetRightTop(const wxPoint &p) { SetTopLeft(p); }
565
566 wxPoint GetBottomLeft() const { return wxPoint(GetLeft(), GetBottom()); }
567 wxPoint GetLeftBottom() const { return GetBottomLeft(); }
568 void SetBottomLeft(const wxPoint &p) { SetLeft(p.x); SetBottom(p.y); }
569 void SetLeftBottom(const wxPoint &p) { SetBottomLeft(p); }
570
571 // operations with rect
572 wxRect& Inflate(wxCoord dx, wxCoord dy);
573 wxRect& Inflate(const wxSize& d) { return Inflate(d.x, d.y); }
574 wxRect& Inflate(wxCoord d) { return Inflate(d, d); }
575 wxRect Inflate(wxCoord dx, wxCoord dy) const
576 {
577 wxRect r = *this;
578 r.Inflate(dx, dy);
579 return r;
580 }
581
582 wxRect& Deflate(wxCoord dx, wxCoord dy) { return Inflate(-dx, -dy); }
583 wxRect& Deflate(const wxSize& d) { return Inflate(-d.x, -d.y); }
584 wxRect& Deflate(wxCoord d) { return Inflate(-d); }
585 wxRect Deflate(wxCoord dx, wxCoord dy) const
586 {
587 wxRect r = *this;
588 r.Deflate(dx, dy);
589 return r;
590 }
591
592 void Offset(wxCoord dx, wxCoord dy) { x += dx; y += dy; }
593 void Offset(const wxPoint& pt) { Offset(pt.x, pt.y); }
594
595 wxRect& Intersect(const wxRect& rect);
596 wxRect Intersect(const wxRect& rect) const
597 {
598 wxRect r = *this;
599 r.Intersect(rect);
600 return r;
601 }
602
603 wxRect& Union(const wxRect& rect);
604 wxRect Union(const wxRect& rect) const
605 {
606 wxRect r = *this;
607 r.Union(rect);
608 return r;
609 }
610
611 // return true if the point is (not strcitly) inside the rect
612 bool Contains(int x, int y) const;
613 bool Contains(const wxPoint& pt) const { return Contains(pt.x, pt.y); }
614 // return true if the rectangle 'rect' is (not strictly) inside this rect
615 bool Contains(const wxRect& rect) const;
616
617 #if WXWIN_COMPATIBILITY_2_6
618 // use Contains() instead
619 wxDEPRECATED( bool Inside(int x, int y) const );
620 wxDEPRECATED( bool Inside(const wxPoint& pt) const );
621 wxDEPRECATED( bool Inside(const wxRect& rect) const );
622 #endif // WXWIN_COMPATIBILITY_2_6
623
624 // return true if the rectangles have a non empty intersection
625 bool Intersects(const wxRect& rect) const;
626
627 // like Union() but don't ignore empty rectangles
628 wxRect& operator+=(const wxRect& rect);
629
630 // intersections of two rectrangles not testing for empty rectangles
631 wxRect& operator*=(const wxRect& rect);
632
633 // centre this rectangle in the given (usually, but not necessarily,
634 // larger) one
635 wxRect CentreIn(const wxRect& r, int dir = wxBOTH) const
636 {
637 return wxRect(dir & wxHORIZONTAL ? r.x + (r.width - width)/2 : x,
638 dir & wxVERTICAL ? r.y + (r.height - height)/2 : y,
639 width, height);
640 }
641
642 wxRect CenterIn(const wxRect& r, int dir = wxBOTH) const
643 {
644 return CentreIn(r, dir);
645 }
646
647 public:
648 int x, y, width, height;
649 };
650
651
652 // compare rectangles
653 inline bool operator==(const wxRect& r1, const wxRect& r2)
654 {
655 return (r1.x == r2.x) && (r1.y == r2.y) &&
656 (r1.width == r2.width) && (r1.height == r2.height);
657 }
658
659 inline bool operator!=(const wxRect& r1, const wxRect& r2)
660 {
661 return !(r1 == r2);
662 }
663
664 // like Union() but don't treat empty rectangles specially
665 WXDLLIMPEXP_CORE wxRect operator+(const wxRect& r1, const wxRect& r2);
666
667 // intersections of two rectangles
668 WXDLLIMPEXP_CORE wxRect operator*(const wxRect& r1, const wxRect& r2);
669
670
671
672
673 #if WXWIN_COMPATIBILITY_2_6
674 inline bool wxRect::Inside(int cx, int cy) const { return Contains(cx, cy); }
675 inline bool wxRect::Inside(const wxPoint& pt) const { return Contains(pt); }
676 inline bool wxRect::Inside(const wxRect& rect) const { return Contains(rect); }
677 #endif // WXWIN_COMPATIBILITY_2_6
678
679
680 // ---------------------------------------------------------------------------
681 // Management of pens, brushes and fonts
682 // ---------------------------------------------------------------------------
683
684 typedef wxInt8 wxDash;
685
686 class WXDLLIMPEXP_CORE wxGDIObjListBase {
687 public:
688 wxGDIObjListBase();
689 ~wxGDIObjListBase();
690
691 protected:
692 wxList list;
693 };
694
695 WX_DECLARE_STRING_HASH_MAP(wxColour*, wxStringToColourHashMap);
696
697 class WXDLLIMPEXP_CORE wxColourDatabase
698 {
699 public:
700 wxColourDatabase();
701 ~wxColourDatabase();
702
703 // find colour by name or name for the given colour
704 wxColour Find(const wxString& name) const;
705 wxString FindName(const wxColour& colour) const;
706
707 // add a new colour to the database
708 void AddColour(const wxString& name, const wxColour& colour);
709
710 #if WXWIN_COMPATIBILITY_2_6
711 // deprecated, use Find() instead
712 wxDEPRECATED( wxColour *FindColour(const wxString& name) );
713 #endif // WXWIN_COMPATIBILITY_2_6
714
715
716 #ifdef __WXPM__
717 // PM keeps its own type of colour table
718 long* m_palTable;
719 size_t m_nSize;
720 #endif
721
722 private:
723 // load the database with the built in colour values when called for the
724 // first time, do nothing after this
725 void Initialize();
726
727 wxStringToColourHashMap *m_map;
728 };
729
730 class WXDLLIMPEXP_CORE wxResourceCache: public wxList
731 {
732 public:
733 wxResourceCache() { }
734 #if !wxUSE_STL
735 wxResourceCache(const unsigned int keyType) : wxList(keyType) { }
736 #endif
737 virtual ~wxResourceCache();
738 };
739
740 // ---------------------------------------------------------------------------
741 // global variables
742 // ---------------------------------------------------------------------------
743
744
745 /* Stock objects
746
747 wxStockGDI creates the stock GDI objects on demand. Pointers to the
748 created objects are stored in the ms_stockObject array, which is indexed
749 by the Item enum values. Platorm-specific fonts can be created by
750 implementing a derived class with an override for the GetFont function.
751 wxStockGDI operates as a singleton, accessed through the ms_instance
752 pointer. By default this pointer is set to an instance of wxStockGDI.
753 A derived class must arrange to set this pointer to an instance of itself.
754 */
755 class WXDLLIMPEXP_CORE wxStockGDI
756 {
757 public:
758 enum Item {
759 BRUSH_BLACK,
760 BRUSH_BLUE,
761 BRUSH_CYAN,
762 BRUSH_GREEN,
763 BRUSH_GREY,
764 BRUSH_LIGHTGREY,
765 BRUSH_MEDIUMGREY,
766 BRUSH_RED,
767 BRUSH_TRANSPARENT,
768 BRUSH_WHITE,
769 COLOUR_BLACK,
770 COLOUR_BLUE,
771 COLOUR_CYAN,
772 COLOUR_GREEN,
773 COLOUR_LIGHTGREY,
774 COLOUR_RED,
775 COLOUR_WHITE,
776 CURSOR_CROSS,
777 CURSOR_HOURGLASS,
778 CURSOR_STANDARD,
779 FONT_ITALIC,
780 FONT_NORMAL,
781 FONT_SMALL,
782 FONT_SWISS,
783 PEN_BLACK,
784 PEN_BLACKDASHED,
785 PEN_CYAN,
786 PEN_GREEN,
787 PEN_GREY,
788 PEN_LIGHTGREY,
789 PEN_MEDIUMGREY,
790 PEN_RED,
791 PEN_TRANSPARENT,
792 PEN_WHITE,
793 ITEMCOUNT
794 };
795
796 wxStockGDI();
797 virtual ~wxStockGDI();
798 static void DeleteAll();
799
800 static wxStockGDI& instance() { return *ms_instance; }
801
802 static const wxBrush* GetBrush(Item item);
803 static const wxColour* GetColour(Item item);
804 static const wxCursor* GetCursor(Item item);
805 // Can be overridden by platform-specific derived classes
806 virtual const wxFont* GetFont(Item item);
807 static const wxPen* GetPen(Item item);
808
809 protected:
810 static wxStockGDI* ms_instance;
811
812 static wxObject* ms_stockObject[ITEMCOUNT];
813
814 DECLARE_NO_COPY_CLASS(wxStockGDI)
815 };
816
817 #define wxITALIC_FONT wxStockGDI::instance().GetFont(wxStockGDI::FONT_ITALIC)
818 #define wxNORMAL_FONT wxStockGDI::instance().GetFont(wxStockGDI::FONT_NORMAL)
819 #define wxSMALL_FONT wxStockGDI::instance().GetFont(wxStockGDI::FONT_SMALL)
820 #define wxSWISS_FONT wxStockGDI::instance().GetFont(wxStockGDI::FONT_SWISS)
821
822 #define wxBLACK_DASHED_PEN wxStockGDI::GetPen(wxStockGDI::PEN_BLACKDASHED)
823 #define wxBLACK_PEN wxStockGDI::GetPen(wxStockGDI::PEN_BLACK)
824 #define wxCYAN_PEN wxStockGDI::GetPen(wxStockGDI::PEN_CYAN)
825 #define wxGREEN_PEN wxStockGDI::GetPen(wxStockGDI::PEN_GREEN)
826 #define wxGREY_PEN wxStockGDI::GetPen(wxStockGDI::PEN_GREY)
827 #define wxLIGHT_GREY_PEN wxStockGDI::GetPen(wxStockGDI::PEN_LIGHTGREY)
828 #define wxMEDIUM_GREY_PEN wxStockGDI::GetPen(wxStockGDI::PEN_MEDIUMGREY)
829 #define wxRED_PEN wxStockGDI::GetPen(wxStockGDI::PEN_RED)
830 #define wxTRANSPARENT_PEN wxStockGDI::GetPen(wxStockGDI::PEN_TRANSPARENT)
831 #define wxWHITE_PEN wxStockGDI::GetPen(wxStockGDI::PEN_WHITE)
832
833 #define wxBLACK_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_BLACK)
834 #define wxBLUE_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_BLUE)
835 #define wxCYAN_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_CYAN)
836 #define wxGREEN_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_GREEN)
837 #define wxGREY_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_GREY)
838 #define wxLIGHT_GREY_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_LIGHTGREY)
839 #define wxMEDIUM_GREY_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_MEDIUMGREY)
840 #define wxRED_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_RED)
841 #define wxTRANSPARENT_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_TRANSPARENT)
842 #define wxWHITE_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_WHITE)
843
844 #define wxBLACK wxStockGDI::GetColour(wxStockGDI::COLOUR_BLACK)
845 #define wxBLUE wxStockGDI::GetColour(wxStockGDI::COLOUR_BLUE)
846 #define wxCYAN wxStockGDI::GetColour(wxStockGDI::COLOUR_CYAN)
847 #define wxGREEN wxStockGDI::GetColour(wxStockGDI::COLOUR_GREEN)
848 #define wxLIGHT_GREY wxStockGDI::GetColour(wxStockGDI::COLOUR_LIGHTGREY)
849 #define wxRED wxStockGDI::GetColour(wxStockGDI::COLOUR_RED)
850 #define wxWHITE wxStockGDI::GetColour(wxStockGDI::COLOUR_WHITE)
851
852 #define wxCROSS_CURSOR wxStockGDI::GetCursor(wxStockGDI::CURSOR_CROSS)
853 #define wxHOURGLASS_CURSOR wxStockGDI::GetCursor(wxStockGDI::CURSOR_HOURGLASS)
854 #define wxSTANDARD_CURSOR wxStockGDI::GetCursor(wxStockGDI::CURSOR_STANDARD)
855
856 // 'Null' objects
857 extern WXDLLIMPEXP_DATA_CORE(wxBitmap) wxNullBitmap;
858 extern WXDLLIMPEXP_DATA_CORE(wxIcon) wxNullIcon;
859 extern WXDLLIMPEXP_DATA_CORE(wxCursor) wxNullCursor;
860 extern WXDLLIMPEXP_DATA_CORE(wxPen) wxNullPen;
861 extern WXDLLIMPEXP_DATA_CORE(wxBrush) wxNullBrush;
862 extern WXDLLIMPEXP_DATA_CORE(wxPalette) wxNullPalette;
863 extern WXDLLIMPEXP_DATA_CORE(wxFont) wxNullFont;
864 extern WXDLLIMPEXP_DATA_CORE(wxColour) wxNullColour;
865 extern WXDLLIMPEXP_DATA_CORE(wxIconBundle) wxNullIconBundle;
866
867 extern WXDLLIMPEXP_DATA_CORE(wxColourDatabase*) wxTheColourDatabase;
868
869 extern WXDLLIMPEXP_DATA_CORE(const char) wxPanelNameStr[];
870
871 extern WXDLLIMPEXP_DATA_CORE(const wxSize) wxDefaultSize;
872 extern WXDLLIMPEXP_DATA_CORE(const wxPoint) wxDefaultPosition;
873
874 // ---------------------------------------------------------------------------
875 // global functions
876 // ---------------------------------------------------------------------------
877
878 // resource management
879 extern void WXDLLIMPEXP_CORE wxInitializeStockLists();
880 extern void WXDLLIMPEXP_CORE wxDeleteStockLists();
881
882 // is the display colour (or monochrome)?
883 extern bool WXDLLIMPEXP_CORE wxColourDisplay();
884
885 // Returns depth of screen
886 extern int WXDLLIMPEXP_CORE wxDisplayDepth();
887 #define wxGetDisplayDepth wxDisplayDepth
888
889 // get the display size
890 extern void WXDLLIMPEXP_CORE wxDisplaySize(int *width, int *height);
891 extern wxSize WXDLLIMPEXP_CORE wxGetDisplaySize();
892 extern void WXDLLIMPEXP_CORE wxDisplaySizeMM(int *width, int *height);
893 extern wxSize WXDLLIMPEXP_CORE wxGetDisplaySizeMM();
894 extern wxSize WXDLLIMPEXP_CORE wxGetDisplayPPI();
895
896 // Get position and size of the display workarea
897 extern void WXDLLIMPEXP_CORE wxClientDisplayRect(int *x, int *y, int *width, int *height);
898 extern wxRect WXDLLIMPEXP_CORE wxGetClientDisplayRect();
899
900 // set global cursor
901 extern void WXDLLIMPEXP_CORE wxSetCursor(const wxCursor& cursor);
902
903 #endif
904 // _WX_GDICMNH__
wxWidgets (Impactor)