]> 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
fixed typo
[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 __WXMAC__
119 wxCURSOR_COPY_ARROW , // MacOS Theme Plus arrow
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(wxT(#X))
155#elif defined(__WXPM__)
156 // Load from a resource
157 #define wxICON(X) wxIcon(wxT(#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(wxT(#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(wxT(#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(0), y(0) { }
209 wxSize(int xx, int yy) : x(xx), y(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(0.0), 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 bool operator!=(const wxRealPoint& pt) const { return x != pt.x || y != pt.y; }
251};
252
253class WXDLLEXPORT wxPoint
254{
255public:
256 int x, y;
257
258 wxPoint() : x(0), y(0) { }
259 wxPoint(int xx, int yy) : x(xx), y(yy) { }
260
261 // no copy ctor or assignment operator - the defaults are ok
262
263 // comparison
264 bool operator==(const wxPoint& p) const { return x == p.x && y == p.y; }
265 bool operator!=(const wxPoint& p) const { return !(*this == p); }
266
267 // arithmetic operations (component wise)
268 wxPoint operator+(const wxPoint& p) const { return wxPoint(x + p.x, y + p.y); }
269 wxPoint operator-(const wxPoint& p) const { return wxPoint(x - p.x, y - p.y); }
270
271 wxPoint& operator+=(const wxPoint& p) { x += p.x; y += p.y; return *this; }
272 wxPoint& operator-=(const wxPoint& p) { x -= p.x; y -= p.y; return *this; }
273};
274
275#if WXWIN_COMPATIBILITY
276 #define wxIntPoint wxPoint
277 #define wxRectangle wxRect
278#endif // WXWIN_COMPATIBILITY
279
280// ---------------------------------------------------------------------------
281// wxRect
282// ---------------------------------------------------------------------------
283
284class WXDLLEXPORT wxRect
285{
286public:
287 wxRect()
288 : x(0), y(0), width(0), height(0)
289 { }
290 wxRect(int xx, int yy, int ww, int hh)
291 : x(xx), y(yy), width(ww), height(hh)
292 { }
293 wxRect(const wxPoint& topLeft, const wxPoint& bottomRight);
294 wxRect(const wxPoint& pos, const wxSize& size);
295
296 // default copy ctor and assignment operators ok
297
298 int GetX() const { return x; }
299 void SetX(int xx) { x = xx; }
300
301 int GetY() const { return y; }
302 void SetY(int yy) { y = yy; }
303
304 int GetWidth() const { return width; }
305 void SetWidth(int w) { width = w; }
306
307 int GetHeight() const { return height; }
308 void SetHeight(int h) { height = h; }
309
310 wxPoint GetPosition() const { return wxPoint(x, y); }
311 void SetPosition( const wxPoint &p ) { x = p.x; y = p.y; }
312
313 wxSize GetSize() const { return wxSize(width, height); }
314 void SetSize( const wxSize &s ) { width = s.GetWidth(); height = s.GetHeight(); }
315
316 int GetLeft() const { return x; }
317 int GetTop() const { return y; }
318 int GetBottom() const { return y + height - 1; }
319 int GetRight() const { return x + width - 1; }
320
321 void SetLeft(int left) { x = left; }
322 void SetRight(int right) { width = right - x + 1; }
323 void SetTop(int top) { y = top; }
324 void SetBottom(int bottom) { height = bottom - y + 1; }
325
326 // operations with rect
327 wxRect& Inflate(wxCoord dx, wxCoord dy);
328 wxRect& Inflate(wxCoord d) { return Inflate(d, d); }
329 wxRect Inflate(wxCoord dx, wxCoord dy) const
330 {
331 wxRect r = *this;
332 r.Inflate(dx, dy);
333 return r;
334 }
335
336 wxRect& Deflate(wxCoord dx, wxCoord dy) { return Inflate(-dx, -dy); }
337 wxRect& Deflate(wxCoord d) { return Inflate(-d); }
338 wxRect Deflate(wxCoord dx, wxCoord dy) const
339 {
340 wxRect r = *this;
341 r.Deflate(dx, dy);
342 return r;
343 }
344
345 void Offset(wxCoord dx, wxCoord dy) { x += dx; y += dy; }
346 void Offset(const wxPoint& pt) { Offset(pt.x, pt.y); }
347
348 wxRect& Intersect(const wxRect& rect);
349 wxRect Intersect(const wxRect& rect) const
350 {
351 wxRect r = *this;
352 r.Intersect(rect);
353 return r;
354 }
355
356 wxRect operator+(const wxRect& rect) const;
357 wxRect& operator+=(const wxRect& rect);
358
359 // compare rectangles
360 bool operator==(const wxRect& rect) const;
361 bool operator!=(const wxRect& rect) const { return !(*this == rect); }
362
363 // return TRUE if the point is (not strcitly) inside the rect
364 bool Inside(int x, int y) const;
365 bool Inside(const wxPoint& pt) const { return Inside(pt.x, pt.y); }
366
367 // return TRUE if the rectangles have a non empty intersection
368 bool Intersects(const wxRect& rect) const;
369
370public:
371 int x, y, width, height;
372};
373
374// ---------------------------------------------------------------------------
375// Management of pens, brushes and fonts
376// ---------------------------------------------------------------------------
377
378typedef wxInt8 wxDash;
379
380class WXDLLEXPORT wxPenList : public wxList
381{
382 DECLARE_DYNAMIC_CLASS(wxPenList)
383
384public:
385 wxPenList() { }
386 ~wxPenList();
387
388 void AddPen(wxPen *pen);
389 void RemovePen(wxPen *pen);
390 wxPen *FindOrCreatePen(const wxColour& colour, int width, int style);
391};
392
393class WXDLLEXPORT wxBrushList : public wxList
394{
395 DECLARE_DYNAMIC_CLASS(wxBrushList)
396
397public:
398 wxBrushList() { }
399 ~wxBrushList();
400
401 void AddBrush(wxBrush *brush);
402 void RemoveBrush(wxBrush *brush);
403 wxBrush *FindOrCreateBrush(const wxColour& colour, int style);
404};
405
406WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
407
408class WXDLLEXPORT wxFontList : public wxList
409{
410 DECLARE_DYNAMIC_CLASS(wxFontList)
411
412public:
413 wxFontList() { }
414 ~wxFontList();
415
416 void AddFont(wxFont *font);
417 void RemoveFont(wxFont *font);
418 wxFont *FindOrCreateFont(int pointSize, int family, int style, int weight,
419 bool underline = FALSE,
420 const wxString& face = wxEmptyString,
421 wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
422};
423
424class WXDLLEXPORT wxColourDatabase : public wxList
425{
426 DECLARE_CLASS(wxColourDatabase)
427
428public:
429 wxColourDatabase(int type);
430 ~wxColourDatabase() ;
431
432 // Not const because it may add a name to the database
433 wxColour *FindColour(const wxString& colour) ;
434 wxString FindName(const wxColour& colour) const;
435 void Initialize();
436#ifdef __WXPM__
437 // PM keeps its own type of colour table
438 long* m_palTable;
439 size_t m_nSize;
440#endif
441};
442
443class WXDLLEXPORT wxBitmapList : public wxList
444{
445 DECLARE_DYNAMIC_CLASS(wxBitmapList)
446
447public:
448 wxBitmapList();
449 ~wxBitmapList();
450
451 void AddBitmap(wxBitmap *bitmap);
452 void RemoveBitmap(wxBitmap *bitmap);
453};
454
455class WXDLLEXPORT wxResourceCache: public wxList
456{
457public:
458 wxResourceCache() { }
459 wxResourceCache(const unsigned int keyType) : wxList(keyType) { }
460 ~wxResourceCache();
461
462private:
463 DECLARE_DYNAMIC_CLASS(wxResourceCache)
464};
465
466// ---------------------------------------------------------------------------
467// global variables
468// ---------------------------------------------------------------------------
469
470// Lists of GDI objects
471WXDLLEXPORT_DATA(extern wxPenList*) wxThePenList;
472WXDLLEXPORT_DATA(extern wxBrushList*) wxTheBrushList;
473WXDLLEXPORT_DATA(extern wxFontList*) wxTheFontList;
474WXDLLEXPORT_DATA(extern wxBitmapList*) wxTheBitmapList;
475
476// Stock objects
477WXDLLEXPORT_DATA(extern wxFont*) wxNORMAL_FONT;
478WXDLLEXPORT_DATA(extern wxFont*) wxSMALL_FONT;
479WXDLLEXPORT_DATA(extern wxFont*) wxITALIC_FONT;
480WXDLLEXPORT_DATA(extern wxFont*) wxSWISS_FONT;
481
482WXDLLEXPORT_DATA(extern wxPen*) wxRED_PEN;
483WXDLLEXPORT_DATA(extern wxPen*) wxCYAN_PEN;
484WXDLLEXPORT_DATA(extern wxPen*) wxGREEN_PEN;
485WXDLLEXPORT_DATA(extern wxPen*) wxBLACK_PEN;
486WXDLLEXPORT_DATA(extern wxPen*) wxWHITE_PEN;
487WXDLLEXPORT_DATA(extern wxPen*) wxTRANSPARENT_PEN;
488WXDLLEXPORT_DATA(extern wxPen*) wxBLACK_DASHED_PEN;
489WXDLLEXPORT_DATA(extern wxPen*) wxGREY_PEN;
490WXDLLEXPORT_DATA(extern wxPen*) wxMEDIUM_GREY_PEN;
491WXDLLEXPORT_DATA(extern wxPen*) wxLIGHT_GREY_PEN;
492
493WXDLLEXPORT_DATA(extern wxBrush*) wxBLUE_BRUSH;
494WXDLLEXPORT_DATA(extern wxBrush*) wxGREEN_BRUSH;
495WXDLLEXPORT_DATA(extern wxBrush*) wxWHITE_BRUSH;
496WXDLLEXPORT_DATA(extern wxBrush*) wxBLACK_BRUSH;
497WXDLLEXPORT_DATA(extern wxBrush*) wxGREY_BRUSH;
498WXDLLEXPORT_DATA(extern wxBrush*) wxMEDIUM_GREY_BRUSH;
499WXDLLEXPORT_DATA(extern wxBrush*) wxLIGHT_GREY_BRUSH;
500WXDLLEXPORT_DATA(extern wxBrush*) wxTRANSPARENT_BRUSH;
501WXDLLEXPORT_DATA(extern wxBrush*) wxCYAN_BRUSH;
502WXDLLEXPORT_DATA(extern wxBrush*) wxRED_BRUSH;
503
504WXDLLEXPORT_DATA(extern wxColour*) wxBLACK;
505WXDLLEXPORT_DATA(extern wxColour*) wxWHITE;
506WXDLLEXPORT_DATA(extern wxColour*) wxRED;
507WXDLLEXPORT_DATA(extern wxColour*) wxBLUE;
508WXDLLEXPORT_DATA(extern wxColour*) wxGREEN;
509WXDLLEXPORT_DATA(extern wxColour*) wxCYAN;
510WXDLLEXPORT_DATA(extern wxColour*) wxLIGHT_GREY;
511
512// 'Null' objects
513WXDLLEXPORT_DATA(extern wxBitmap) wxNullBitmap;
514WXDLLEXPORT_DATA(extern wxIcon) wxNullIcon;
515WXDLLEXPORT_DATA(extern wxCursor) wxNullCursor;
516WXDLLEXPORT_DATA(extern wxPen) wxNullPen;
517WXDLLEXPORT_DATA(extern wxBrush) wxNullBrush;
518WXDLLEXPORT_DATA(extern wxPalette) wxNullPalette;
519WXDLLEXPORT_DATA(extern wxFont) wxNullFont;
520WXDLLEXPORT_DATA(extern wxColour) wxNullColour;
521
522// Stock cursors types
523WXDLLEXPORT_DATA(extern wxCursor*) wxSTANDARD_CURSOR;
524WXDLLEXPORT_DATA(extern wxCursor*) wxHOURGLASS_CURSOR;
525WXDLLEXPORT_DATA(extern wxCursor*) wxCROSS_CURSOR;
526
527WXDLLEXPORT_DATA(extern wxColourDatabase*) wxTheColourDatabase;
528
529WXDLLEXPORT_DATA(extern const wxChar*) wxPanelNameStr;
530
531WXDLLEXPORT_DATA(extern const wxSize) wxDefaultSize;
532WXDLLEXPORT_DATA(extern const wxPoint) wxDefaultPosition;
533
534// The list of objects which should be deleted
535WXDLLEXPORT_DATA(extern wxList) wxPendingDelete;
536
537// ---------------------------------------------------------------------------
538// global functions
539// ---------------------------------------------------------------------------
540
541// resource management
542extern void WXDLLEXPORT wxInitializeStockObjects();
543extern void WXDLLEXPORT wxInitializeStockLists();
544extern void WXDLLEXPORT wxDeleteStockObjects();
545extern void WXDLLEXPORT wxDeleteStockLists();
546
547// is the display colour (or monochrome)?
548extern bool WXDLLEXPORT wxColourDisplay();
549
550// Returns depth of screen
551extern int WXDLLEXPORT wxDisplayDepth();
552#define wxGetDisplayDepth wxDisplayDepth
553
554// get the display size
555extern void WXDLLEXPORT wxDisplaySize(int *width, int *height);
556extern wxSize WXDLLEXPORT wxGetDisplaySize();
557extern void WXDLLEXPORT wxDisplaySizeMM(int *width, int *height);
558extern wxSize WXDLLEXPORT wxGetDisplaySizeMM();
559
560// Get position and size of the display workarea
561extern void WXDLLEXPORT wxClientDisplayRect(int *x, int *y, int *width, int *height);
562extern wxRect WXDLLEXPORT wxGetClientDisplayRect();
563
564// set global cursor
565extern void WXDLLEXPORT wxSetCursor(const wxCursor& cursor);
566
567#endif
568 // _WX_GDICMNH__
wxWidgets (Impactor)