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