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