]> git.saurik.com Git - wxWidgets.git/blob - include/wx/gdicmn.h
projects / wxWidgets.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Added wxPGChoices::Copy(), tweaked related documentation
[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
244 void IncTo(const wxSize& sz)
245 { if ( sz.x > x ) x = sz.x; if ( sz.y > y ) y = sz.y; }
246 void DecTo(const wxSize& sz)
247 { if ( sz.x < x ) x = sz.x; if ( sz.y < y ) y = sz.y; }
248
249 void IncBy(int dx, int dy) { x += dx; y += dy; }
250 void IncBy(const wxSize& sz) { IncBy(sz.x, sz.y); }
251 void IncBy(int d) { IncBy(d, d); }
252
253 void DecBy(int dx, int dy) { IncBy(-dx, -dy); }
254 void DecBy(const wxSize& sz) { DecBy(sz.x, sz.y); }
255 void DecBy(int d) { DecBy(d, d); }
256
257
258 wxSize& Scale(float xscale, float yscale)
259 { x = (int)(x*xscale); y = (int)(y*yscale); return *this; }
260
261 // accessors
262 void Set(int xx, int yy) { x = xx; y = yy; }
263 void SetWidth(int w) { x = w; }
264 void SetHeight(int h) { y = h; }
265
266 int GetWidth() const { return x; }
267 int GetHeight() const { return y; }
268
269 bool IsFullySpecified() const { return x != wxDefaultCoord && y != wxDefaultCoord; }
270
271 // combine this size with the other one replacing the default (i.e. equal
272 // to wxDefaultCoord) components of this object with those of the other
273 void SetDefaults(const wxSize& size)
274 {
275 if ( x == wxDefaultCoord )
276 x = size.x;
277 if ( y == wxDefaultCoord )
278 y = size.y;
279 }
280
281 // compatibility
282 int GetX() const { return x; }
283 int GetY() const { return y; }
284 };
285
286
287 inline bool operator==(const wxSize& s1, const wxSize& s2)
288 {
289 return s1.x == s2.x && s1.y == s2.y;
290 }
291
292 inline bool operator!=(const wxSize& s1, const wxSize& s2)
293 {
294 return s1.x != s2.x || s1.y != s2.y;
295 }
296
297
298 inline wxSize operator+(const wxSize& s1, const wxSize& s2)
299 {
300 return wxSize(s1.x + s2.x, s1.y + s2.y);
301 }
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
310 inline wxSize operator/(const wxSize& s, int i)
311 {
312 return wxSize(s.x / i, s.y / i);
313 }
314
315
316 inline wxSize operator*(const wxSize& s, int i)
317 {
318 return wxSize(s.x * i, s.y * i);
319 }
320
321
322 inline wxSize operator*(int i, const wxSize& s)
323 {
324 return wxSize(s.x * i, s.y * i);
325 }
326
327
328
329
330 // ---------------------------------------------------------------------------
331 // Point classes: with real or integer coordinates
332 // ---------------------------------------------------------------------------
333
334 class WXDLLIMPEXP_CORE wxRealPoint
335 {
336 public:
337 double x;
338 double y;
339
340 wxRealPoint() : x(0.0), y(0.0) { }
341 wxRealPoint(double xx, double yy) : x(xx), y(yy) { }
342 };
343
344
345 inline bool operator==(const wxRealPoint& p1, const wxRealPoint& p2)
346 {
347 return wxIsSameDouble(p1.x, p2.x) && wxIsSameDouble(p1.y, p2.y);
348 }
349
350
351 inline bool operator!=(const wxRealPoint& p1, const wxRealPoint& p2)
352 {
353 return !(p1 == p2);
354 }
355
356
357 inline wxRealPoint operator+(const wxRealPoint& p1, const wxRealPoint& p2)
358 {
359 return wxRealPoint(p1.x + p2.x, p1.y + p2.y);
360 }
361
362
363 inline wxRealPoint operator-(const wxRealPoint& p1, const wxRealPoint& p2)
364 {
365 return wxRealPoint(p1.x - p2.x, p1.y - p2.y);
366 }
367
368
369 // ----------------------------------------------------------------------------
370 // wxPoint: 2D point with integer coordinates
371 // ----------------------------------------------------------------------------
372
373 class WXDLLIMPEXP_CORE wxPoint
374 {
375 public:
376 int x, y;
377
378 wxPoint() : x(0), y(0) { }
379 wxPoint(int xx, int yy) : x(xx), y(yy) { }
380
381 // no copy ctor or assignment operator - the defaults are ok
382
383 //assignment operators
384 wxPoint& operator+=(const wxPoint& p) { x += p.x; y += p.y; return *this; }
385 wxPoint& operator-=(const wxPoint& p) { x -= p.x; y -= p.y; return *this; }
386
387 wxPoint& operator+=(const wxSize& s) { x += s.GetWidth(); y += s.GetHeight(); return *this; }
388 wxPoint& operator-=(const wxSize& s) { x -= s.GetWidth(); y -= s.GetHeight(); return *this; }
389 };
390
391
392 // comparison
393 inline bool operator==(const wxPoint& p1, const wxPoint& p2)
394 {
395 return p1.x == p2.x && p1.y == p2.y;
396 }
397
398 inline bool operator!=(const wxPoint& p1, const wxPoint& p2)
399 {
400 return !(p1 == p2);
401 }
402
403
404 // arithmetic operations (component wise)
405 inline wxPoint operator+(const wxPoint& p1, const wxPoint& p2)
406 {
407 return wxPoint(p1.x + p2.x, p1.y + p2.y);
408 }
409
410 inline wxPoint operator-(const wxPoint& p1, const wxPoint& p2)
411 {
412 return wxPoint(p1.x - p2.x, p1.y - p2.y);
413 }
414
415 inline wxPoint operator+(const wxPoint& p, const wxSize& s)
416 {
417 return wxPoint(p.x + s.x, p.y + s.y);
418 }
419
420 inline wxPoint operator-(const wxPoint& p, const wxSize& s)
421 {
422 return wxPoint(p.x - s.x, p.y - s.y);
423 }
424
425 inline wxPoint operator+(const wxSize& s, const wxPoint& p)
426 {
427 return wxPoint(p.x + s.x, p.y + s.y);
428 }
429
430 inline wxPoint operator-(const wxSize& s, const wxPoint& p)
431 {
432 return wxPoint(s.x - p.x, s.y - p.y);
433 }
434
435 inline wxPoint operator-(const wxPoint& p)
436 {
437 return wxPoint(-p.x, -p.y);
438 }
439
440 WX_DECLARE_LIST_WITH_DECL(wxPoint, wxPointList, class WXDLLIMPEXP_CORE);
441
442 // ---------------------------------------------------------------------------
443 // wxRect
444 // ---------------------------------------------------------------------------
445
446 class WXDLLIMPEXP_CORE wxRect
447 {
448 public:
449 wxRect()
450 : x(0), y(0), width(0), height(0)
451 { }
452 wxRect(int xx, int yy, int ww, int hh)
453 : x(xx), y(yy), width(ww), height(hh)
454 { }
455 wxRect(const wxPoint& topLeft, const wxPoint& bottomRight);
456 wxRect(const wxPoint& pt, const wxSize& size)
457 : x(pt.x), y(pt.y), width(size.x), height(size.y)
458 { }
459 wxRect(const wxSize& size)
460 : x(0), y(0), width(size.x), height(size.y)
461 { }
462
463 // default copy ctor and assignment operators ok
464
465 int GetX() const { return x; }
466 void SetX(int xx) { x = xx; }
467
468 int GetY() const { return y; }
469 void SetY(int yy) { y = yy; }
470
471 int GetWidth() const { return width; }
472 void SetWidth(int w) { width = w; }
473
474 int GetHeight() const { return height; }
475 void SetHeight(int h) { height = h; }
476
477 wxPoint GetPosition() const { return wxPoint(x, y); }
478 void SetPosition( const wxPoint &p ) { x = p.x; y = p.y; }
479
480 wxSize GetSize() const { return wxSize(width, height); }
481 void SetSize( const wxSize &s ) { width = s.GetWidth(); height = s.GetHeight(); }
482
483 bool IsEmpty() const { return (width <= 0) || (height <= 0); }
484
485 int GetLeft() const { return x; }
486 int GetTop() const { return y; }
487 int GetBottom() const { return y + height - 1; }
488 int GetRight() const { return x + width - 1; }
489
490 void SetLeft(int left) { x = left; }
491 void SetRight(int right) { width = right - x + 1; }
492 void SetTop(int top) { y = top; }
493 void SetBottom(int bottom) { height = bottom - y + 1; }
494
495 wxPoint GetTopLeft() const { return GetPosition(); }
496 wxPoint GetLeftTop() const { return GetTopLeft(); }
497 void SetTopLeft(const wxPoint &p) { SetPosition(p); }
498 void SetLeftTop(const wxPoint &p) { SetTopLeft(p); }
499
500 wxPoint GetBottomRight() const { return wxPoint(GetRight(), GetBottom()); }
501 wxPoint GetRightBottom() const { return GetBottomRight(); }
502 void SetBottomRight(const wxPoint &p) { SetRight(p.x); SetBottom(p.y); }
503 void SetRightBottom(const wxPoint &p) { SetBottomRight(p); }
504
505 wxPoint GetTopRight() const { return wxPoint(GetRight(), GetTop()); }
506 wxPoint GetRightTop() const { return GetTopRight(); }
507 void SetTopRight(const wxPoint &p) { SetRight(p.x); SetTop(p.y); }
508 void SetRightTop(const wxPoint &p) { SetTopLeft(p); }
509
510 wxPoint GetBottomLeft() const { return wxPoint(GetLeft(), GetBottom()); }
511 wxPoint GetLeftBottom() const { return GetBottomLeft(); }
512 void SetBottomLeft(const wxPoint &p) { SetLeft(p.x); SetBottom(p.y); }
513 void SetLeftBottom(const wxPoint &p) { SetBottomLeft(p); }
514
515 // operations with rect
516 wxRect& Inflate(wxCoord dx, wxCoord dy);
517 wxRect& Inflate(const wxSize& d) { return Inflate(d.x, d.y); }
518 wxRect& Inflate(wxCoord d) { return Inflate(d, d); }
519 wxRect Inflate(wxCoord dx, wxCoord dy) const
520 {
521 wxRect r = *this;
522 r.Inflate(dx, dy);
523 return r;
524 }
525
526 wxRect& Deflate(wxCoord dx, wxCoord dy) { return Inflate(-dx, -dy); }
527 wxRect& Deflate(const wxSize& d) { return Inflate(-d.x, -d.y); }
528 wxRect& Deflate(wxCoord d) { return Inflate(-d); }
529 wxRect Deflate(wxCoord dx, wxCoord dy) const
530 {
531 wxRect r = *this;
532 r.Deflate(dx, dy);
533 return r;
534 }
535
536 void Offset(wxCoord dx, wxCoord dy) { x += dx; y += dy; }
537 void Offset(const wxPoint& pt) { Offset(pt.x, pt.y); }
538
539 wxRect& Intersect(const wxRect& rect);
540 wxRect Intersect(const wxRect& rect) const
541 {
542 wxRect r = *this;
543 r.Intersect(rect);
544 return r;
545 }
546
547 wxRect& Union(const wxRect& rect);
548 wxRect Union(const wxRect& rect) const
549 {
550 wxRect r = *this;
551 r.Union(rect);
552 return r;
553 }
554
555 // return true if the point is (not strcitly) inside the rect
556 bool Contains(int x, int y) const;
557 bool Contains(const wxPoint& pt) const { return Contains(pt.x, pt.y); }
558 // return true if the rectangle 'rect' is (not strictly) inside this rect
559 bool Contains(const wxRect& rect) const;
560
561 #if WXWIN_COMPATIBILITY_2_6
562 // use Contains() instead
563 wxDEPRECATED( bool Inside(int x, int y) const );
564 wxDEPRECATED( bool Inside(const wxPoint& pt) const );
565 wxDEPRECATED( bool Inside(const wxRect& rect) const );
566 #endif // WXWIN_COMPATIBILITY_2_6
567
568 // return true if the rectangles have a non empty intersection
569 bool Intersects(const wxRect& rect) const;
570
571 // like Union() but don't ignore empty rectangles
572 wxRect& operator+=(const wxRect& rect);
573
574 // intersections of two rectrangles not testing for empty rectangles
575 wxRect& operator*=(const wxRect& rect);
576
577 // centre this rectangle in the given (usually, but not necessarily,
578 // larger) one
579 wxRect CentreIn(const wxRect& r, int dir = wxBOTH) const
580 {
581 return wxRect(dir & wxHORIZONTAL ? r.x + (r.width - width)/2 : x,
582 dir & wxVERTICAL ? r.y + (r.height - height)/2 : y,
583 width, height);
584 }
585
586 wxRect CenterIn(const wxRect& r, int dir = wxBOTH) const
587 {
588 return CentreIn(r, dir);
589 }
590
591 public:
592 int x, y, width, height;
593 };
594
595
596 // compare rectangles
597 inline bool operator==(const wxRect& r1, const wxRect& r2)
598 {
599 return (r1.x == r2.x) && (r1.y == r2.y) &&
600 (r1.width == r2.width) && (r1.height == r2.height);
601 }
602
603 inline bool operator!=(const wxRect& r1, const wxRect& r2)
604 {
605 return !(r1 == r2);
606 }
607
608 // like Union() but don't treat empty rectangles specially
609 WXDLLIMPEXP_CORE wxRect operator+(const wxRect& r1, const wxRect& r2);
610
611 // intersections of two rectangles
612 WXDLLIMPEXP_CORE wxRect operator*(const wxRect& r1, const wxRect& r2);
613
614
615
616
617 #if WXWIN_COMPATIBILITY_2_6
618 inline bool wxRect::Inside(int cx, int cy) const { return Contains(cx, cy); }
619 inline bool wxRect::Inside(const wxPoint& pt) const { return Contains(pt); }
620 inline bool wxRect::Inside(const wxRect& rect) const { return Contains(rect); }
621 #endif // WXWIN_COMPATIBILITY_2_6
622
623
624 // ---------------------------------------------------------------------------
625 // Management of pens, brushes and fonts
626 // ---------------------------------------------------------------------------
627
628 typedef wxInt8 wxDash;
629
630 class WXDLLIMPEXP_CORE wxGDIObjListBase {
631 public:
632 wxGDIObjListBase();
633 ~wxGDIObjListBase();
634
635 protected:
636 wxList list;
637 };
638
639 WX_DECLARE_STRING_HASH_MAP(wxColour*, wxStringToColourHashMap);
640
641 class WXDLLIMPEXP_CORE wxColourDatabase
642 {
643 public:
644 wxColourDatabase();
645 ~wxColourDatabase();
646
647 // find colour by name or name for the given colour
648 wxColour Find(const wxString& name) const;
649 wxString FindName(const wxColour& colour) const;
650
651 // add a new colour to the database
652 void AddColour(const wxString& name, const wxColour& colour);
653
654 #if WXWIN_COMPATIBILITY_2_6
655 // deprecated, use Find() instead
656 wxDEPRECATED( wxColour *FindColour(const wxString& name) );
657 #endif // WXWIN_COMPATIBILITY_2_6
658
659
660 #ifdef __WXPM__
661 // PM keeps its own type of colour table
662 long* m_palTable;
663 size_t m_nSize;
664 #endif
665
666 private:
667 // load the database with the built in colour values when called for the
668 // first time, do nothing after this
669 void Initialize();
670
671 wxStringToColourHashMap *m_map;
672 };
673
674 class WXDLLIMPEXP_CORE wxResourceCache: public wxList
675 {
676 public:
677 wxResourceCache() { }
678 #if !wxUSE_STL
679 wxResourceCache(const unsigned int keyType) : wxList(keyType) { }
680 #endif
681 virtual ~wxResourceCache();
682 };
683
684 // ---------------------------------------------------------------------------
685 // global variables
686 // ---------------------------------------------------------------------------
687
688
689 /* Stock objects
690
691 wxStockGDI creates the stock GDI objects on demand. Pointers to the
692 created objects are stored in the ms_stockObject array, which is indexed
693 by the Item enum values. Platorm-specific fonts can be created by
694 implementing a derived class with an override for the GetFont function.
695 wxStockGDI operates as a singleton, accessed through the ms_instance
696 pointer. By default this pointer is set to an instance of wxStockGDI.
697 A derived class must arrange to set this pointer to an instance of itself.
698 */
699 class WXDLLIMPEXP_CORE wxStockGDI
700 {
701 public:
702 enum Item {
703 BRUSH_BLACK,
704 BRUSH_BLUE,
705 BRUSH_CYAN,
706 BRUSH_GREEN,
707 BRUSH_GREY,
708 BRUSH_LIGHTGREY,
709 BRUSH_MEDIUMGREY,
710 BRUSH_RED,
711 BRUSH_TRANSPARENT,
712 BRUSH_WHITE,
713 COLOUR_BLACK,
714 COLOUR_BLUE,
715 COLOUR_CYAN,
716 COLOUR_GREEN,
717 COLOUR_LIGHTGREY,
718 COLOUR_RED,
719 COLOUR_WHITE,
720 CURSOR_CROSS,
721 CURSOR_HOURGLASS,
722 CURSOR_STANDARD,
723 FONT_ITALIC,
724 FONT_NORMAL,
725 FONT_SMALL,
726 FONT_SWISS,
727 PEN_BLACK,
728 PEN_BLACKDASHED,
729 PEN_CYAN,
730 PEN_GREEN,
731 PEN_GREY,
732 PEN_LIGHTGREY,
733 PEN_MEDIUMGREY,
734 PEN_RED,
735 PEN_TRANSPARENT,
736 PEN_WHITE,
737 ITEMCOUNT
738 };
739
740 wxStockGDI();
741 virtual ~wxStockGDI();
742 static void DeleteAll();
743
744 static wxStockGDI& instance() { return *ms_instance; }
745
746 static const wxBrush* GetBrush(Item item);
747 static const wxColour* GetColour(Item item);
748 static const wxCursor* GetCursor(Item item);
749 // Can be overridden by platform-specific derived classes
750 virtual const wxFont* GetFont(Item item);
751 static const wxPen* GetPen(Item item);
752
753 protected:
754 static wxStockGDI* ms_instance;
755
756 static wxObject* ms_stockObject[ITEMCOUNT];
757
758 DECLARE_NO_COPY_CLASS(wxStockGDI)
759 };
760
761 #define wxITALIC_FONT wxStockGDI::instance().GetFont(wxStockGDI::FONT_ITALIC)
762 #define wxNORMAL_FONT wxStockGDI::instance().GetFont(wxStockGDI::FONT_NORMAL)
763 #define wxSMALL_FONT wxStockGDI::instance().GetFont(wxStockGDI::FONT_SMALL)
764 #define wxSWISS_FONT wxStockGDI::instance().GetFont(wxStockGDI::FONT_SWISS)
765
766 #define wxBLACK_DASHED_PEN wxStockGDI::GetPen(wxStockGDI::PEN_BLACKDASHED)
767 #define wxBLACK_PEN wxStockGDI::GetPen(wxStockGDI::PEN_BLACK)
768 #define wxCYAN_PEN wxStockGDI::GetPen(wxStockGDI::PEN_CYAN)
769 #define wxGREEN_PEN wxStockGDI::GetPen(wxStockGDI::PEN_GREEN)
770 #define wxGREY_PEN wxStockGDI::GetPen(wxStockGDI::PEN_GREY)
771 #define wxLIGHT_GREY_PEN wxStockGDI::GetPen(wxStockGDI::PEN_LIGHTGREY)
772 #define wxMEDIUM_GREY_PEN wxStockGDI::GetPen(wxStockGDI::PEN_MEDIUMGREY)
773 #define wxRED_PEN wxStockGDI::GetPen(wxStockGDI::PEN_RED)
774 #define wxTRANSPARENT_PEN wxStockGDI::GetPen(wxStockGDI::PEN_TRANSPARENT)
775 #define wxWHITE_PEN wxStockGDI::GetPen(wxStockGDI::PEN_WHITE)
776
777 #define wxBLACK_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_BLACK)
778 #define wxBLUE_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_BLUE)
779 #define wxCYAN_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_CYAN)
780 #define wxGREEN_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_GREEN)
781 #define wxGREY_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_GREY)
782 #define wxLIGHT_GREY_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_LIGHTGREY)
783 #define wxMEDIUM_GREY_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_MEDIUMGREY)
784 #define wxRED_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_RED)
785 #define wxTRANSPARENT_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_TRANSPARENT)
786 #define wxWHITE_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_WHITE)
787
788 #define wxBLACK wxStockGDI::GetColour(wxStockGDI::COLOUR_BLACK)
789 #define wxBLUE wxStockGDI::GetColour(wxStockGDI::COLOUR_BLUE)
790 #define wxCYAN wxStockGDI::GetColour(wxStockGDI::COLOUR_CYAN)
791 #define wxGREEN wxStockGDI::GetColour(wxStockGDI::COLOUR_GREEN)
792 #define wxLIGHT_GREY wxStockGDI::GetColour(wxStockGDI::COLOUR_LIGHTGREY)
793 #define wxRED wxStockGDI::GetColour(wxStockGDI::COLOUR_RED)
794 #define wxWHITE wxStockGDI::GetColour(wxStockGDI::COLOUR_WHITE)
795
796 #define wxCROSS_CURSOR wxStockGDI::GetCursor(wxStockGDI::CURSOR_CROSS)
797 #define wxHOURGLASS_CURSOR wxStockGDI::GetCursor(wxStockGDI::CURSOR_HOURGLASS)
798 #define wxSTANDARD_CURSOR wxStockGDI::GetCursor(wxStockGDI::CURSOR_STANDARD)
799
800 // 'Null' objects
801 extern WXDLLIMPEXP_DATA_CORE(wxBitmap) wxNullBitmap;
802 extern WXDLLIMPEXP_DATA_CORE(wxIcon) wxNullIcon;
803 extern WXDLLIMPEXP_DATA_CORE(wxCursor) wxNullCursor;
804 extern WXDLLIMPEXP_DATA_CORE(wxPen) wxNullPen;
805 extern WXDLLIMPEXP_DATA_CORE(wxBrush) wxNullBrush;
806 extern WXDLLIMPEXP_DATA_CORE(wxPalette) wxNullPalette;
807 extern WXDLLIMPEXP_DATA_CORE(wxFont) wxNullFont;
808 extern WXDLLIMPEXP_DATA_CORE(wxColour) wxNullColour;
809 extern WXDLLIMPEXP_DATA_CORE(wxIconBundle) wxNullIconBundle;
810
811 extern WXDLLIMPEXP_DATA_CORE(wxColourDatabase*) wxTheColourDatabase;
812
813 extern WXDLLIMPEXP_DATA_CORE(const char) wxPanelNameStr[];
814
815 extern WXDLLIMPEXP_DATA_CORE(const wxSize) wxDefaultSize;
816 extern WXDLLIMPEXP_DATA_CORE(const wxPoint) wxDefaultPosition;
817
818 // ---------------------------------------------------------------------------
819 // global functions
820 // ---------------------------------------------------------------------------
821
822 // resource management
823 extern void WXDLLIMPEXP_CORE wxInitializeStockLists();
824 extern void WXDLLIMPEXP_CORE wxDeleteStockLists();
825
826 // is the display colour (or monochrome)?
827 extern bool WXDLLIMPEXP_CORE wxColourDisplay();
828
829 // Returns depth of screen
830 extern int WXDLLIMPEXP_CORE wxDisplayDepth();
831 #define wxGetDisplayDepth wxDisplayDepth
832
833 // get the display size
834 extern void WXDLLIMPEXP_CORE wxDisplaySize(int *width, int *height);
835 extern wxSize WXDLLIMPEXP_CORE wxGetDisplaySize();
836 extern void WXDLLIMPEXP_CORE wxDisplaySizeMM(int *width, int *height);
837 extern wxSize WXDLLIMPEXP_CORE wxGetDisplaySizeMM();
838 extern wxSize WXDLLIMPEXP_CORE wxGetDisplayPPI();
839
840 // Get position and size of the display workarea
841 extern void WXDLLIMPEXP_CORE wxClientDisplayRect(int *x, int *y, int *width, int *height);
842 extern wxRect WXDLLIMPEXP_CORE wxGetClientDisplayRect();
843
844 // set global cursor
845 extern void WXDLLIMPEXP_CORE wxSetCursor(const wxCursor& cursor);
846
847 #endif
848 // _WX_GDICMNH__
wxWidgets (Impactor)