]> git.saurik.com Git - wxWidgets.git/blame - include/wx/gdicmn.h
removed wxUSE_DIB_FOR_BITMAP which doesn't seem to be used any longer
[wxWidgets.git] / include / wx / gdicmn.h
CommitLineData
c801d85f 1/////////////////////////////////////////////////////////////////////////////
ca3e85cf 2// Name: wx/gdicmn.h
c801d85f
KB
3// Purpose: Common GDI classes, types and declarations
4// Author: Julian Smart
5// Modified by:
6// Created: 01/02/97
7// RCS-ID: $Id$
99d80019 8// Copyright: (c) Julian Smart
65571936 9// Licence: wxWindows licence
c801d85f
KB
10/////////////////////////////////////////////////////////////////////////////
11
34138703
JS
12#ifndef _WX_GDICMNH__
13#define _WX_GDICMNH__
c801d85f 14
f03fc89f
VZ
15// ---------------------------------------------------------------------------
16// headers
17// ---------------------------------------------------------------------------
18
2ecf902b 19#include "wx/defs.h"
c801d85f 20#include "wx/list.h"
34138703 21#include "wx/string.h"
ed39ff57 22#include "wx/fontenc.h"
f79f1604 23#include "wx/hashmap.h"
bc14c8b2 24#include "wx/math.h"
c801d85f 25
f03fc89f
VZ
26// ---------------------------------------------------------------------------
27// forward declarations
28// ---------------------------------------------------------------------------
29
62a9d04c
VS
30class WXDLLIMPEXP_CORE wxBitmap;
31class WXDLLIMPEXP_CORE wxBrush;
32class WXDLLIMPEXP_CORE wxColour;
33class WXDLLIMPEXP_CORE wxCursor;
34class WXDLLIMPEXP_CORE wxFont;
35class WXDLLIMPEXP_CORE wxIcon;
36class WXDLLIMPEXP_CORE wxPalette;
37class WXDLLIMPEXP_CORE wxPen;
38class WXDLLIMPEXP_CORE wxRegion;
39class WXDLLIMPEXP_BASE wxString;
f03fc89f
VZ
40
41// ---------------------------------------------------------------------------
42// constants
43// ---------------------------------------------------------------------------
44
45// Bitmap flags
2aeec9ec 46enum wxBitmapType
f03fc89f 47{
6d167489
VZ
48 wxBITMAP_TYPE_INVALID, // should be == 0 for compatibility!
49 wxBITMAP_TYPE_BMP,
f03fc89f
VZ
50 wxBITMAP_TYPE_BMP_RESOURCE,
51 wxBITMAP_TYPE_RESOURCE = wxBITMAP_TYPE_BMP_RESOURCE,
52 wxBITMAP_TYPE_ICO,
53 wxBITMAP_TYPE_ICO_RESOURCE,
54 wxBITMAP_TYPE_CUR,
55 wxBITMAP_TYPE_CUR_RESOURCE,
56 wxBITMAP_TYPE_XBM,
57 wxBITMAP_TYPE_XBM_DATA,
58 wxBITMAP_TYPE_XPM,
59 wxBITMAP_TYPE_XPM_DATA,
60 wxBITMAP_TYPE_TIF,
61 wxBITMAP_TYPE_TIF_RESOURCE,
62 wxBITMAP_TYPE_GIF,
63 wxBITMAP_TYPE_GIF_RESOURCE,
64 wxBITMAP_TYPE_PNG,
65 wxBITMAP_TYPE_PNG_RESOURCE,
66 wxBITMAP_TYPE_JPEG,
67 wxBITMAP_TYPE_JPEG_RESOURCE,
bcc46c75
SB
68 wxBITMAP_TYPE_PNM,
69 wxBITMAP_TYPE_PNM_RESOURCE,
6523d119
GRG
70 wxBITMAP_TYPE_PCX,
71 wxBITMAP_TYPE_PCX_RESOURCE,
6d167489
VZ
72 wxBITMAP_TYPE_PICT,
73 wxBITMAP_TYPE_PICT_RESOURCE,
74 wxBITMAP_TYPE_ICON,
75 wxBITMAP_TYPE_ICON_RESOURCE,
658974ae 76 wxBITMAP_TYPE_ANI,
63f8abca 77 wxBITMAP_TYPE_IFF,
3af706cc 78 wxBITMAP_TYPE_TGA,
6d167489
VZ
79 wxBITMAP_TYPE_MACCURSOR,
80 wxBITMAP_TYPE_MACCURSOR_RESOURCE,
f03fc89f
VZ
81 wxBITMAP_TYPE_ANY = 50
82};
83
c801d85f 84// Standard cursors
f03fc89f
VZ
85enum wxStockCursor
86{
87 wxCURSOR_NONE, // should be 0
88 wxCURSOR_ARROW,
15dadf31 89 wxCURSOR_RIGHT_ARROW,
f03fc89f
VZ
90 wxCURSOR_BULLSEYE,
91 wxCURSOR_CHAR,
92 wxCURSOR_CROSS,
93 wxCURSOR_HAND,
94 wxCURSOR_IBEAM,
95 wxCURSOR_LEFT_BUTTON,
96 wxCURSOR_MAGNIFIER,
97 wxCURSOR_MIDDLE_BUTTON,
98 wxCURSOR_NO_ENTRY,
99 wxCURSOR_PAINT_BRUSH,
100 wxCURSOR_PENCIL,
101 wxCURSOR_POINT_LEFT,
102 wxCURSOR_POINT_RIGHT,
103 wxCURSOR_QUESTION_ARROW,
104 wxCURSOR_RIGHT_BUTTON,
105 wxCURSOR_SIZENESW,
106 wxCURSOR_SIZENS,
107 wxCURSOR_SIZENWSE,
108 wxCURSOR_SIZEWE,
109 wxCURSOR_SIZING,
110 wxCURSOR_SPRAYCAN,
111 wxCURSOR_WAIT,
112 wxCURSOR_WATCH,
113 wxCURSOR_BLANK,
ae53c98c
KB
114#ifdef __WXGTK__
115 wxCURSOR_DEFAULT, // standard X11 cursor
116#endif
5f7a6626 117#ifdef __WXMAC__
5d3e7b52 118 wxCURSOR_COPY_ARROW , // MacOS Theme Plus arrow
5f7a6626 119#endif
c801d85f 120#ifdef __X__
f03fc89f
VZ
121 // Not yet implemented for Windows
122 wxCURSOR_CROSS_REVERSE,
123 wxCURSOR_DOUBLE_ARROW,
124 wxCURSOR_BASED_ARROW_UP,
ea804aad 125 wxCURSOR_BASED_ARROW_DOWN,
f03fc89f
VZ
126#endif // X11
127
83f96286
RD
128 wxCURSOR_ARROWWAIT,
129
f03fc89f
VZ
130 wxCURSOR_MAX
131};
132
943d28e4
VZ
133#ifndef __WXGTK__
134 #define wxCURSOR_DEFAULT wxCURSOR_ARROW
135#endif
136
f03fc89f
VZ
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
2b5f62a0 153 #define wxICON(X) wxIcon(wxT(#X))
1777b9bb
DW
154#elif defined(__WXPM__)
155 // Load from a resource
2b5f62a0 156 #define wxICON(X) wxIcon(wxT(#X))
1e6feb95 157#elif defined(__WXMGL__)
1d965e2f
VS
158 // Initialize from an included XPM
159 #define wxICON(X) wxIcon( (const char**) X##_xpm )
d8bfd727
VS
160#elif defined(__WXDFB__)
161 // Initialize from an included XPM
162 #define wxICON(X) wxIcon( (const char**) X##_xpm )
f03fc89f
VZ
163#elif defined(__WXGTK__)
164 // Initialize from an included XPM
165 #define wxICON(X) wxIcon( (const char**) X##_xpm )
0532484d
GD
166#elif defined(__WXMAC__)
167 // Initialize from an included XPM
168 #define wxICON(X) wxIcon( (const char**) X##_xpm )
f03fc89f
VZ
169#elif defined(__WXMOTIF__)
170 // Initialize from an included XPM
171 #define wxICON(X) wxIcon( X##_xpm )
83df96d6
JS
172#elif defined(__WXX11__)
173 // Initialize from an included XPM
174 #define wxICON(X) wxIcon( X##_xpm )
f03fc89f
VZ
175#else
176 // This will usually mean something on any platform
2b5f62a0 177 #define wxICON(X) wxIcon(wxT(#X))
f03fc89f
VZ
178#endif // platform
179
0c5d3e1c
VZ
180/* Another macro: this one is for portable creation of bitmaps. We assume that
181 under Unix bitmaps live in XPMs and under Windows they're in ressources.
182 */
183
1d965e2f 184#if defined(__WXMSW__) || defined(__WXPM__)
2b5f62a0 185 #define wxBITMAP(name) wxBitmap(wxT(#name), wxBITMAP_TYPE_RESOURCE)
d22004c4
WS
186#elif defined(__WXGTK__) || \
187 defined(__WXMOTIF__) || \
188 defined(__WXX11__) || \
189 defined(__WXMAC__) || \
190 defined(__WXMGL__) || \
d8bfd727 191 defined(__WXDFB__) || \
d22004c4 192 defined(__WXCOCOA__)
bab537dc
VS
193 // Initialize from an included XPM
194 #define wxBITMAP(name) wxBitmap( (const char**) name##_xpm )
b8aa1680 195#else // other platforms
0c5d3e1c
VZ
196 #define wxBITMAP(name) wxBitmap(name##_xpm, wxBITMAP_TYPE_XPM)
197#endif // platform
198
f03fc89f
VZ
199// ===========================================================================
200// classes
201// ===========================================================================
c801d85f 202
f03fc89f
VZ
203// ---------------------------------------------------------------------------
204// wxSize
205// ---------------------------------------------------------------------------
1e6feb95 206
6a6c0a8b 207class WXDLLEXPORT wxSize
c801d85f
KB
208{
209public:
e6c96a7c 210 // members are public for compatibility, don't use them directly.
72cdf4c9 211 int x, y;
f03fc89f
VZ
212
213 // constructors
7ee31b00
GD
214 wxSize() : x(0), y(0) { }
215 wxSize(int xx, int yy) : x(xx), y(yy) { }
f03fc89f
VZ
216
217 // no copy ctor or assignment operator - the defaults are ok
1e6feb95 218
f03fc89f 219 bool operator==(const wxSize& sz) const { return x == sz.x && y == sz.y; }
1e6feb95 220 bool operator!=(const wxSize& sz) const { return x != sz.x || y != sz.y; }
f03fc89f 221
fbfb8bcc
VZ
222 wxSize operator+(const wxSize& sz) const { return wxSize(x + sz.x, y + sz.y); }
223 wxSize operator-(const wxSize& sz) const { return wxSize(x - sz.x, y - sz.y); }
224 wxSize operator/(int i) const { return wxSize(x / i, y / i); }
225 wxSize operator*(int i) const { return wxSize(x * i, y * i); }
fc84bd05
WS
226
227 wxSize& operator+=(const wxSize& sz) { x += sz.x; y += sz.y; return *this; }
228 wxSize& operator-=(const wxSize& sz) { x -= sz.x; y -= sz.y; return *this; }
229 wxSize& operator/=(const int i) { x /= i; y /= i; return *this; }
230 wxSize& operator*=(const int i) { x *= i; y *= i; return *this; }
706f1421 231
5b087ae2
VZ
232 void IncTo(const wxSize& sz)
233 { if ( sz.x > x ) x = sz.x; if ( sz.y > y ) y = sz.y; }
234 void DecTo(const wxSize& sz)
235 { if ( sz.x < x ) x = sz.x; if ( sz.y < y ) y = sz.y; }
f03fc89f 236
23359747
VZ
237 void IncBy(int dx, int dy) { x += dx; y += dy; }
238 void IncBy(const wxSize& sz) { IncBy(sz.x, sz.y); }
239 void IncBy(int d) { IncBy(d, d); }
240
241 void DecBy(int dx, int dy) { IncBy(-dx, -dy); }
242 void DecBy(const wxSize& sz) { DecBy(sz.x, sz.y); }
243 void DecBy(int d) { DecBy(d, d); }
244
245
c5bad604
RR
246 wxSize& Scale(float xscale, float yscale)
247 { x = (int)(x*xscale); y = (int)(y*yscale); return *this; }
8efb2907 248
eddf46fe
JS
249 // accessors
250 void Set(int xx, int yy) { x = xx; y = yy; }
72cdf4c9
VZ
251 void SetWidth(int w) { x = w; }
252 void SetHeight(int h) { y = h; }
cc775580 253
72cdf4c9
VZ
254 int GetWidth() const { return x; }
255 int GetHeight() const { return y; }
f03fc89f 256
5d3e7b52 257 bool IsFullySpecified() const { return x != wxDefaultCoord && y != wxDefaultCoord; }
706f1421
VZ
258
259 // combine this size with the other one replacing the default (i.e. equal
5d3e7b52 260 // to wxDefaultCoord) components of this object with those of the other
706f1421
VZ
261 void SetDefaults(const wxSize& size)
262 {
5d3e7b52 263 if ( x == wxDefaultCoord )
706f1421 264 x = size.x;
5d3e7b52 265 if ( y == wxDefaultCoord )
706f1421
VZ
266 y = size.y;
267 }
268
cc775580 269 // compatibility
72cdf4c9
VZ
270 int GetX() const { return x; }
271 int GetY() const { return y; }
c801d85f
KB
272};
273
f03fc89f
VZ
274// ---------------------------------------------------------------------------
275// Point classes: with real or integer coordinates
276// ---------------------------------------------------------------------------
764a3a49 277
6a6c0a8b 278class WXDLLEXPORT wxRealPoint
c801d85f 279{
f03fc89f
VZ
280public:
281 double x;
282 double y;
283
7ee31b00
GD
284 wxRealPoint() : x(0.0), y(0.0) { }
285 wxRealPoint(double xx, double yy) : x(xx), y(yy) { }
f03fc89f 286
f6bcfd97
BP
287 wxRealPoint operator+(const wxRealPoint& pt) const { return wxRealPoint(x + pt.x, y + pt.y); }
288 wxRealPoint operator-(const wxRealPoint& pt) const { return wxRealPoint(x - pt.x, y - pt.y); }
f03fc89f 289
bc14c8b2
VZ
290 bool operator==(const wxRealPoint& pt) const
291 {
292 return wxIsSameDouble(x, pt.x) && wxIsSameDouble(y, pt.y);
293 }
294 bool operator!=(const wxRealPoint& pt) const { return !(*this == pt); }
c801d85f
KB
295};
296
bc14c8b2 297
6a6c0a8b 298class WXDLLEXPORT wxPoint
c801d85f 299{
f03fc89f 300public:
72cdf4c9 301 int x, y;
6a6c0a8b 302
7ee31b00
GD
303 wxPoint() : x(0), y(0) { }
304 wxPoint(int xx, int yy) : x(xx), y(yy) { }
f03fc89f
VZ
305
306 // no copy ctor or assignment operator - the defaults are ok
6a6c0a8b 307
764a3a49
VZ
308 // comparison
309 bool operator==(const wxPoint& p) const { return x == p.x && y == p.y; }
310 bool operator!=(const wxPoint& p) const { return !(*this == p); }
311
312 // arithmetic operations (component wise)
f6bcfd97
BP
313 wxPoint operator+(const wxPoint& p) const { return wxPoint(x + p.x, y + p.y); }
314 wxPoint operator-(const wxPoint& p) const { return wxPoint(x - p.x, y - p.y); }
f03fc89f 315
764a3a49
VZ
316 wxPoint& operator+=(const wxPoint& p) { x += p.x; y += p.y; return *this; }
317 wxPoint& operator-=(const wxPoint& p) { x -= p.x; y -= p.y; return *this; }
d02bc4c8
JS
318
319 wxPoint& operator+=(const wxSize& s) { x += s.GetWidth(); y += s.GetHeight(); return *this; }
320 wxPoint& operator-=(const wxSize& s) { x -= s.GetWidth(); y -= s.GetHeight(); return *this; }
321
322 wxPoint operator+(const wxSize& s) const { return wxPoint(x + s.GetWidth(), y + s.GetHeight()); }
323 wxPoint operator-(const wxSize& s) const { return wxPoint(x - s.GetWidth(), y - s.GetHeight()); }
24b800a9
VS
324
325 wxPoint operator-() const { return wxPoint(-x, -y); }
c801d85f
KB
326};
327
f03fc89f
VZ
328// ---------------------------------------------------------------------------
329// wxRect
330// ---------------------------------------------------------------------------
c801d85f 331
6a6c0a8b
JS
332class WXDLLEXPORT wxRect
333{
c801d85f 334public:
7ee31b00
GD
335 wxRect()
336 : x(0), y(0), width(0), height(0)
337 { }
72cdf4c9 338 wxRect(int xx, int yy, int ww, int hh)
7ee31b00
GD
339 : x(xx), y(yy), width(ww), height(hh)
340 { }
f03fc89f 341 wxRect(const wxPoint& topLeft, const wxPoint& bottomRight);
df83b840
VZ
342 wxRect(const wxPoint& pt, const wxSize& size)
343 : x(pt.x), y(pt.y), width(size.x), height(size.y)
344 { }
345 wxRect(const wxSize& size)
346 : x(0), y(0), width(size.x), height(size.y)
347 { }
a23fd0e1
VZ
348
349 // default copy ctor and assignment operators ok
c801d85f 350
72cdf4c9
VZ
351 int GetX() const { return x; }
352 void SetX(int xx) { x = xx; }
c801d85f 353
72cdf4c9
VZ
354 int GetY() const { return y; }
355 void SetY(int yy) { y = yy; }
c801d85f 356
72cdf4c9
VZ
357 int GetWidth() const { return width; }
358 void SetWidth(int w) { width = w; }
c801d85f 359
72cdf4c9
VZ
360 int GetHeight() const { return height; }
361 void SetHeight(int h) { height = h; }
f03fc89f 362
dcb44466 363 wxPoint GetPosition() const { return wxPoint(x, y); }
4aa0010b
RL
364 void SetPosition( const wxPoint &p ) { x = p.x; y = p.y; }
365
dcb44466 366 wxSize GetSize() const { return wxSize(width, height); }
4aa0010b 367 void SetSize( const wxSize &s ) { width = s.GetWidth(); height = s.GetHeight(); }
f03fc89f 368
b737ad10
RR
369 bool IsEmpty() const { return (width <= 0) || (height <= 0); }
370
f790ec82
VZ
371 int GetLeft() const { return x; }
372 int GetTop() const { return y; }
373 int GetBottom() const { return y + height - 1; }
374 int GetRight() const { return x + width - 1; }
375
376 void SetLeft(int left) { x = left; }
377 void SetRight(int right) { width = right - x + 1; }
378 void SetTop(int top) { y = top; }
379 void SetBottom(int bottom) { height = bottom - y + 1; }
380
355a5e2b
JS
381 wxPoint GetTopLeft() const { return GetPosition(); }
382 wxPoint GetLeftTop() const { return GetTopLeft(); }
383 void SetTopLeft(const wxPoint &p) { SetPosition(p); }
384 void SetLeftTop(const wxPoint &p) { SetTopLeft(p); }
385
386 wxPoint GetBottomRight() const { return wxPoint(GetRight(), GetBottom()); }
387 wxPoint GetRightBottom() const { return GetBottomRight(); }
388 void SetBottomRight(const wxPoint &p) { SetRight(p.x); SetBottom(p.y); }
389 void SetRightBottom(const wxPoint &p) { SetBottomRight(p); }
390
f790ec82
VZ
391 wxPoint GetTopRight() const { return wxPoint(GetRight(), GetTop()); }
392 wxPoint GetRightTop() const { return GetTopRight(); }
393 void SetTopRight(const wxPoint &p) { SetRight(p.x); SetTop(p.y); }
394 void SetRightTop(const wxPoint &p) { SetTopLeft(p); }
f03fc89f 395
f790ec82
VZ
396 wxPoint GetBottomLeft() const { return wxPoint(GetLeft(), GetBottom()); }
397 wxPoint GetLeftBottom() const { return GetBottomLeft(); }
398 void SetBottomLeft(const wxPoint &p) { SetLeft(p.x); SetBottom(p.y); }
399 void SetLeftBottom(const wxPoint &p) { SetBottomLeft(p); }
dcb44466 400
1e6feb95
VZ
401 // operations with rect
402 wxRect& Inflate(wxCoord dx, wxCoord dy);
c2c4d939 403 wxRect& Inflate(const wxSize& d) { return Inflate(d.x, d.y); }
1e6feb95
VZ
404 wxRect& Inflate(wxCoord d) { return Inflate(d, d); }
405 wxRect Inflate(wxCoord dx, wxCoord dy) const
406 {
407 wxRect r = *this;
408 r.Inflate(dx, dy);
409 return r;
410 }
411
412 wxRect& Deflate(wxCoord dx, wxCoord dy) { return Inflate(-dx, -dy); }
c2c4d939 413 wxRect& Deflate(const wxSize& d) { return Inflate(-d.x, -d.y); }
1e6feb95
VZ
414 wxRect& Deflate(wxCoord d) { return Inflate(-d); }
415 wxRect Deflate(wxCoord dx, wxCoord dy) const
416 {
417 wxRect r = *this;
418 r.Deflate(dx, dy);
419 return r;
420 }
421
422 void Offset(wxCoord dx, wxCoord dy) { x += dx; y += dy; }
423 void Offset(const wxPoint& pt) { Offset(pt.x, pt.y); }
424
425 wxRect& Intersect(const wxRect& rect);
426 wxRect Intersect(const wxRect& rect) const
45816ddd 427 {
1e6feb95
VZ
428 wxRect r = *this;
429 r.Intersect(rect);
430 return r;
45816ddd
VZ
431 }
432
df83b840
VZ
433 wxRect& Union(const wxRect& rect);
434 wxRect Union(const wxRect& rect) const
435 {
436 wxRect r = *this;
437 r.Union(rect);
438 return r;
439 }
45816ddd 440
1e6feb95 441 // compare rectangles
764a3a49
VZ
442 bool operator==(const wxRect& rect) const;
443 bool operator!=(const wxRect& rect) const { return !(*this == rect); }
f03fc89f 444
5d3e7b52 445 // return true if the point is (not strcitly) inside the rect
22a35096
VS
446 bool Contains(int x, int y) const;
447 bool Contains(const wxPoint& pt) const { return Contains(pt.x, pt.y); }
869b59fc 448 // return true if the rectangle is (not strcitly) inside the rect
22a35096
VS
449 bool Contains(const wxRect& rect) const;
450
451#if WXWIN_COMPATIBILITY_2_6
452 // use Contains() instead
453 wxDEPRECATED( bool Inside(int x, int y) const );
454 wxDEPRECATED( bool Inside(const wxPoint& pt) const );
455 wxDEPRECATED( bool Inside(const wxRect& rect) const );
456#endif // WXWIN_COMPATIBILITY_2_6
1e6feb95 457
5d3e7b52 458 // return true if the rectangles have a non empty intersection
1e6feb95 459 bool Intersects(const wxRect& rect) const;
72cdf4c9 460
df83b840
VZ
461
462 // these are like Union() but don't ignore empty rectangles
463 wxRect operator+(const wxRect& rect) const;
3ea9aa8f 464 wxRect& operator+=(const wxRect& rect)
df83b840
VZ
465 {
466 *this = *this + rect;
467 return *this;
468 }
469
470
1bfb73b8
VZ
471 // centre this rectangle in the given (usually, but not necessarily,
472 // larger) one
473 wxRect CentreIn(const wxRect& r, int dir = wxBOTH) const
474 {
475 return wxRect(dir & wxHORIZONTAL ? r.x + (r.width - width)/2 : x,
476 dir & wxVERTICAL ? r.y + (r.height - height)/2 : y,
477 width, height);
478 }
479
480 wxRect CenterIn(const wxRect& r, int dir = wxBOTH) const
481 {
482 return CentreIn(r, dir);
483 }
484
f03fc89f 485public:
72cdf4c9 486 int x, y, width, height;
f03fc89f 487};
c801d85f 488
22a35096 489#if WXWIN_COMPATIBILITY_2_6
3e69f6e5 490inline bool wxRect::Inside(int cx, int cy) const { return Contains(cx, cy); }
22a35096
VS
491inline bool wxRect::Inside(const wxPoint& pt) const { return Contains(pt); }
492inline bool wxRect::Inside(const wxRect& rect) const { return Contains(rect); }
493#endif // WXWIN_COMPATIBILITY_2_6
494
495
f03fc89f 496// ---------------------------------------------------------------------------
c801d85f 497// Management of pens, brushes and fonts
f03fc89f
VZ
498// ---------------------------------------------------------------------------
499
236a9de3
RL
500typedef wxInt8 wxDash;
501
1de8d512 502class WXDLLIMPEXP_CORE wxGDIObjListBase {
f03fc89f 503public:
1de8d512
VZ
504 wxGDIObjListBase();
505 ~wxGDIObjListBase();
f03fc89f 506
1de8d512
VZ
507protected:
508 wxList list;
c801d85f
KB
509};
510
1de8d512 511class WXDLLIMPEXP_CORE wxPenList: public wxGDIObjListBase
c801d85f 512{
f03fc89f 513public:
1de8d512
VZ
514 wxPen *FindOrCreatePen(const wxColour& colour, int width, int style);
515#if WXWIN_COMPATIBILITY_2_6
516 wxDEPRECATED( void AddPen(wxPen*) );
517 wxDEPRECATED( void RemovePen(wxPen*) );
518#endif
519};
f03fc89f 520
1de8d512
VZ
521class WXDLLIMPEXP_CORE wxBrushList: public wxGDIObjListBase
522{
523public:
cf000528 524 wxBrush *FindOrCreateBrush(const wxColour& colour, int style = wxSOLID);
1de8d512
VZ
525#if WXWIN_COMPATIBILITY_2_6
526 wxDEPRECATED( void AddBrush(wxBrush*) );
527 wxDEPRECATED( void RemoveBrush(wxBrush*) );
528#endif
c801d85f
KB
529};
530
1de8d512 531class WXDLLIMPEXP_CORE wxFontList: public wxGDIObjListBase
c801d85f 532{
f03fc89f 533public:
f03fc89f 534 wxFont *FindOrCreateFont(int pointSize, int family, int style, int weight,
5d3e7b52 535 bool underline = false,
37bebc11
RD
536 const wxString& face = wxEmptyString,
537 wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
1de8d512
VZ
538#if WXWIN_COMPATIBILITY_2_6
539 wxDEPRECATED( void AddFont(wxFont*) );
540 wxDEPRECATED( void RemoveFont(wxFont*) );
541#endif
c801d85f
KB
542};
543
f79f1604
PC
544WX_DECLARE_STRING_HASH_MAP(wxColour*, wxStringToColourHashMap);
545
222ed1d6 546class WXDLLEXPORT wxColourDatabase
c801d85f 547{
f03fc89f 548public:
222ed1d6 549 wxColourDatabase();
c50f92d0 550 ~wxColourDatabase();
f03fc89f 551
c50f92d0
VZ
552 // find colour by name or name for the given colour
553 wxColour Find(const wxString& name) const;
f03fc89f 554 wxString FindName(const wxColour& colour) const;
c50f92d0
VZ
555
556 // add a new colour to the database
557 void AddColour(const wxString& name, const wxColour& colour);
558
ca3e85cf 559#if WXWIN_COMPATIBILITY_2_6
492e2a5b
VZ
560 // deprecated, use Find() instead
561 wxDEPRECATED( wxColour *FindColour(const wxString& name) );
ca3e85cf 562#endif // WXWIN_COMPATIBILITY_2_6
c50f92d0
VZ
563
564
19bf0c69
DW
565#ifdef __WXPM__
566 // PM keeps its own type of colour table
567 long* m_palTable;
568 size_t m_nSize;
569#endif
c50f92d0 570
222ed1d6 571private:
c50f92d0
VZ
572 // load the database with the built in colour values when called for the
573 // first time, do nothing after this
574 void Initialize();
222ed1d6 575
c50f92d0 576 wxStringToColourHashMap *m_map;
c801d85f
KB
577};
578
f03fc89f
VZ
579class WXDLLEXPORT wxResourceCache: public wxList
580{
581public:
582 wxResourceCache() { }
222ed1d6 583#if !wxUSE_STL
f03fc89f 584 wxResourceCache(const unsigned int keyType) : wxList(keyType) { }
222ed1d6 585#endif
d3c7fc99 586 virtual ~wxResourceCache();
f03fc89f
VZ
587};
588
589// ---------------------------------------------------------------------------
590// global variables
591// ---------------------------------------------------------------------------
592
c801d85f 593// Lists of GDI objects
16cba29d
WS
594extern WXDLLEXPORT_DATA(wxPenList*) wxThePenList;
595extern WXDLLEXPORT_DATA(wxBrushList*) wxTheBrushList;
596extern WXDLLEXPORT_DATA(wxFontList*) wxTheFontList;
c801d85f 597
f516d986
VZ
598/* Stock objects
599
600 wxStockGDI creates the stock GDI objects on demand. Pointers to the
601 created objects are stored in the ms_stockObject array, which is indexed
602 by the Item enum values. Platorm-specific fonts can be created by
603 implementing a derived class with an override for the GetFont function.
604 wxStockGDI operates as a singleton, accessed through the ms_instance
605 pointer. By default this pointer is set to an instance of wxStockGDI.
606 A derived class must arrange to set this pointer to an instance of itself.
607*/
608class WXDLLIMPEXP_CORE wxStockGDI
609{
610public:
611 enum Item {
612 BRUSH_BLACK,
613 BRUSH_BLUE,
614 BRUSH_CYAN,
615 BRUSH_GREEN,
616 BRUSH_GREY,
617 BRUSH_LIGHTGREY,
618 BRUSH_MEDIUMGREY,
619 BRUSH_RED,
620 BRUSH_TRANSPARENT,
621 BRUSH_WHITE,
622 COLOUR_BLACK,
623 COLOUR_BLUE,
624 COLOUR_CYAN,
625 COLOUR_GREEN,
626 COLOUR_LIGHTGREY,
627 COLOUR_RED,
628 COLOUR_WHITE,
629 CURSOR_CROSS,
630 CURSOR_HOURGLASS,
631 CURSOR_STANDARD,
632 FONT_ITALIC,
633 FONT_NORMAL,
634 FONT_SMALL,
635 FONT_SWISS,
636 PEN_BLACK,
637 PEN_BLACKDASHED,
638 PEN_CYAN,
639 PEN_GREEN,
640 PEN_GREY,
641 PEN_LIGHTGREY,
642 PEN_MEDIUMGREY,
643 PEN_RED,
644 PEN_TRANSPARENT,
645 PEN_WHITE,
646 ITEMCOUNT
647 };
648
649 wxStockGDI();
650 virtual ~wxStockGDI();
651 static void DeleteAll();
652
653 static wxStockGDI& instance() { return *ms_instance; }
654
655 static const wxBrush* GetBrush(Item item);
656 static const wxColour* GetColour(Item item);
657 static const wxCursor* GetCursor(Item item);
658 // Can be overridden by platform-specific derived classes
659 virtual const wxFont* GetFont(Item item);
660 static const wxPen* GetPen(Item item);
661
662protected:
663 static wxStockGDI* ms_instance;
664
665 static wxObject* ms_stockObject[ITEMCOUNT];
666
667 DECLARE_NO_COPY_CLASS(wxStockGDI)
668};
669
670#define wxITALIC_FONT wxStockGDI::instance().GetFont(wxStockGDI::FONT_ITALIC)
671#define wxNORMAL_FONT wxStockGDI::instance().GetFont(wxStockGDI::FONT_NORMAL)
672#define wxSMALL_FONT wxStockGDI::instance().GetFont(wxStockGDI::FONT_SMALL)
673#define wxSWISS_FONT wxStockGDI::instance().GetFont(wxStockGDI::FONT_SWISS)
674
675#define wxBLACK_DASHED_PEN wxStockGDI::GetPen(wxStockGDI::PEN_BLACKDASHED)
676#define wxBLACK_PEN wxStockGDI::GetPen(wxStockGDI::PEN_BLACK)
677#define wxCYAN_PEN wxStockGDI::GetPen(wxStockGDI::PEN_CYAN)
678#define wxGREEN_PEN wxStockGDI::GetPen(wxStockGDI::PEN_GREEN)
679#define wxGREY_PEN wxStockGDI::GetPen(wxStockGDI::PEN_GREY)
680#define wxLIGHT_GREY_PEN wxStockGDI::GetPen(wxStockGDI::PEN_LIGHTGREY)
681#define wxMEDIUM_GREY_PEN wxStockGDI::GetPen(wxStockGDI::PEN_MEDIUMGREY)
682#define wxRED_PEN wxStockGDI::GetPen(wxStockGDI::PEN_RED)
683#define wxTRANSPARENT_PEN wxStockGDI::GetPen(wxStockGDI::PEN_TRANSPARENT)
684#define wxWHITE_PEN wxStockGDI::GetPen(wxStockGDI::PEN_WHITE)
685
686#define wxBLACK_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_BLACK)
687#define wxBLUE_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_BLUE)
688#define wxCYAN_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_CYAN)
689#define wxGREEN_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_GREEN)
690#define wxGREY_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_GREY)
691#define wxLIGHT_GREY_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_LIGHTGREY)
692#define wxMEDIUM_GREY_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_MEDIUMGREY)
693#define wxRED_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_RED)
694#define wxTRANSPARENT_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_TRANSPARENT)
695#define wxWHITE_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_WHITE)
696
697#define wxBLACK wxStockGDI::GetColour(wxStockGDI::COLOUR_BLACK)
698#define wxBLUE wxStockGDI::GetColour(wxStockGDI::COLOUR_BLUE)
699#define wxCYAN wxStockGDI::GetColour(wxStockGDI::COLOUR_CYAN)
700#define wxGREEN wxStockGDI::GetColour(wxStockGDI::COLOUR_GREEN)
701#define wxLIGHT_GREY wxStockGDI::GetColour(wxStockGDI::COLOUR_LIGHTGREY)
702#define wxRED wxStockGDI::GetColour(wxStockGDI::COLOUR_RED)
703#define wxWHITE wxStockGDI::GetColour(wxStockGDI::COLOUR_WHITE)
704
705#define wxCROSS_CURSOR wxStockGDI::GetCursor(wxStockGDI::CURSOR_CROSS)
706#define wxHOURGLASS_CURSOR wxStockGDI::GetCursor(wxStockGDI::CURSOR_HOURGLASS)
707#define wxSTANDARD_CURSOR wxStockGDI::GetCursor(wxStockGDI::CURSOR_STANDARD)
c801d85f
KB
708
709// 'Null' objects
16cba29d
WS
710extern WXDLLEXPORT_DATA(wxBitmap) wxNullBitmap;
711extern WXDLLEXPORT_DATA(wxIcon) wxNullIcon;
712extern WXDLLEXPORT_DATA(wxCursor) wxNullCursor;
713extern WXDLLEXPORT_DATA(wxPen) wxNullPen;
714extern WXDLLEXPORT_DATA(wxBrush) wxNullBrush;
715extern WXDLLEXPORT_DATA(wxPalette) wxNullPalette;
716extern WXDLLEXPORT_DATA(wxFont) wxNullFont;
717extern WXDLLEXPORT_DATA(wxColour) wxNullColour;
c801d85f 718
16cba29d 719extern WXDLLEXPORT_DATA(wxColourDatabase*) wxTheColourDatabase;
f03fc89f 720
63ec432b 721extern WXDLLEXPORT_DATA(const wxChar) wxPanelNameStr[];
c801d85f 722
16cba29d
WS
723extern WXDLLEXPORT_DATA(const wxSize) wxDefaultSize;
724extern WXDLLEXPORT_DATA(const wxPoint) wxDefaultPosition;
f03fc89f 725
f03fc89f
VZ
726// ---------------------------------------------------------------------------
727// global functions
728// ---------------------------------------------------------------------------
729
730// resource management
a3622daa 731extern void WXDLLEXPORT wxInitializeStockLists();
a3622daa 732extern void WXDLLEXPORT wxDeleteStockLists();
c801d85f 733
f03fc89f 734// is the display colour (or monochrome)?
6a6c0a8b 735extern bool WXDLLEXPORT wxColourDisplay();
c801d85f
KB
736
737// Returns depth of screen
6a6c0a8b
JS
738extern int WXDLLEXPORT wxDisplayDepth();
739#define wxGetDisplayDepth wxDisplayDepth
c801d85f 740
904a68b6 741// get the display size
c801d85f 742extern void WXDLLEXPORT wxDisplaySize(int *width, int *height);
6a6c0a8b 743extern wxSize WXDLLEXPORT wxGetDisplaySize();
904a68b6
RL
744extern void WXDLLEXPORT wxDisplaySizeMM(int *width, int *height);
745extern wxSize WXDLLEXPORT wxGetDisplaySizeMM();
c801d85f 746
ec5d7799
RD
747// Get position and size of the display workarea
748extern void WXDLLEXPORT wxClientDisplayRect(int *x, int *y, int *width, int *height);
749extern wxRect WXDLLEXPORT wxGetClientDisplayRect();
750
f03fc89f 751// set global cursor
c801d85f
KB
752extern void WXDLLEXPORT wxSetCursor(const wxCursor& cursor);
753
c801d85f 754#endif
34138703 755 // _WX_GDICMNH__