1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Common GDI classes, types and declarations
4 // Author: Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
15 // ---------------------------------------------------------------------------
17 // ---------------------------------------------------------------------------
20 #pragma interface "gdicmn.h"
23 #include "wx/object.h"
26 #include "wx/string.h"
28 #include "wx/colour.h"
31 // ---------------------------------------------------------------------------
32 // forward declarations
33 // ---------------------------------------------------------------------------
35 class WXDLLEXPORT wxBitmap
;
36 class WXDLLEXPORT wxBrush
;
37 class WXDLLEXPORT wxColour
;
38 class WXDLLEXPORT wxCursor
;
39 class WXDLLEXPORT wxFont
;
40 class WXDLLEXPORT wxIcon
;
41 class WXDLLEXPORT wxPalette
;
42 class WXDLLEXPORT wxPen
;
43 class WXDLLEXPORT wxRegion
;
44 class WXDLLEXPORT wxString
;
46 // ---------------------------------------------------------------------------
48 // ---------------------------------------------------------------------------
53 wxBITMAP_TYPE_INVALID
, // should be == 0 for compatibility!
55 wxBITMAP_TYPE_BMP_RESOURCE
,
56 wxBITMAP_TYPE_RESOURCE
= wxBITMAP_TYPE_BMP_RESOURCE
,
58 wxBITMAP_TYPE_ICO_RESOURCE
,
60 wxBITMAP_TYPE_CUR_RESOURCE
,
62 wxBITMAP_TYPE_XBM_DATA
,
64 wxBITMAP_TYPE_XPM_DATA
,
66 wxBITMAP_TYPE_TIF_RESOURCE
,
68 wxBITMAP_TYPE_GIF_RESOURCE
,
70 wxBITMAP_TYPE_PNG_RESOURCE
,
72 wxBITMAP_TYPE_JPEG_RESOURCE
,
74 wxBITMAP_TYPE_PNM_RESOURCE
,
76 wxBITMAP_TYPE_PCX_RESOURCE
,
78 wxBITMAP_TYPE_PICT_RESOURCE
,
80 wxBITMAP_TYPE_ICON_RESOURCE
,
83 wxBITMAP_TYPE_MACCURSOR
,
84 wxBITMAP_TYPE_MACCURSOR_RESOURCE
,
85 wxBITMAP_TYPE_ANY
= 50
91 wxCURSOR_NONE
, // should be 0
100 wxCURSOR_MIDDLE_BUTTON
,
102 wxCURSOR_PAINT_BRUSH
,
105 wxCURSOR_POINT_RIGHT
,
106 wxCURSOR_QUESTION_ARROW
,
107 wxCURSOR_RIGHT_BUTTON
,
118 wxCURSOR_DEFAULT
, // standard X11 cursor
121 // Not yet implemented for Windows
122 wxCURSOR_CROSS_REVERSE
,
123 wxCURSOR_DOUBLE_ARROW
,
124 wxCURSOR_BASED_ARROW_UP
,
125 wxCURSOR_BASED_ARROW_DOWN
,
134 #define wxCURSOR_DEFAULT wxCURSOR_ARROW
137 // ---------------------------------------------------------------------------
139 // ---------------------------------------------------------------------------
141 /* Useful macro for creating icons portably, for example:
143 wxIcon *icon = new wxICON(mondrian);
147 wxIcon *icon = new wxIcon("mondrian"); // On wxMSW
148 wxIcon *icon = new wxIcon(mondrian_xpm); // On wxGTK
152 // Load from a resource
153 #define wxICON(X) wxIcon("" #X "")
154 #elif defined(__WXPM__)
155 // Load from a resource
156 #define wxICON(X) wxIcon("" #X "")
157 #elif defined(__WXMGL__)
158 // Initialize from an included XPM
159 #define wxICON(X) wxIcon( (const char**) X##_xpm )
160 #elif defined(__WXGTK__)
161 // Initialize from an included XPM
162 #define wxICON(X) wxIcon( (const char**) X##_xpm )
163 #elif defined(__WXMAC__)
164 // Initialize from an included XPM
165 #define wxICON(X) wxIcon( (const char**) X##_xpm )
166 #elif defined(__WXMOTIF__)
167 // Initialize from an included XPM
168 #define wxICON(X) wxIcon( X##_xpm )
169 #elif defined(__WXX11__)
170 // Initialize from an included XPM
171 #define wxICON(X) wxIcon( X##_xpm )
173 // This will usually mean something on any platform
174 #define wxICON(X) wxIcon("" #X "")
177 /* Another macro: this one is for portable creation of bitmaps. We assume that
178 under Unix bitmaps live in XPMs and under Windows they're in ressources.
181 #if defined(__WXMSW__) || defined(__WXPM__)
182 #define wxBITMAP(name) wxBitmap(#name, wxBITMAP_TYPE_RESOURCE)
183 #elif defined(__WXGTK__) || defined(__WXMOTIF__) || defined(__WXX11__) || defined(__WXMAC__) || defined(__WXMGL__)
184 // Initialize from an included XPM
185 #define wxBITMAP(name) wxBitmap( (const char**) name##_xpm )
186 #else // other platforms
187 #define wxBITMAP(name) wxBitmap(name##_xpm, wxBITMAP_TYPE_XPM)
190 // ===========================================================================
192 // ===========================================================================
194 // ---------------------------------------------------------------------------
196 // ---------------------------------------------------------------------------
198 class WXDLLEXPORT wxSize
201 // members are public for compatibility (don't use them directly,
202 // especially that there names were chosen very unfortunately - they should
203 // have been called width and height)
207 wxSize() { x
= y
= 0; }
208 wxSize(int xx
, int yy
) { Set(xx
, yy
); }
210 // no copy ctor or assignment operator - the defaults are ok
212 bool operator==(const wxSize
& sz
) const { return x
== sz
.x
&& y
== sz
.y
; }
213 bool operator!=(const wxSize
& sz
) const { return x
!= sz
.x
|| y
!= sz
.y
; }
215 // FIXME are these really useful? If they're, we should have += &c as well
216 wxSize
operator+(const wxSize
& sz
) { return wxSize(x
+ sz
.x
, y
+ sz
.y
); }
217 wxSize
operator-(const wxSize
& sz
) { return wxSize(x
- sz
.x
, y
- sz
.y
); }
220 void Set(int xx
, int yy
) { x
= xx
; y
= yy
; }
221 void SetWidth(int w
) { x
= w
; }
222 void SetHeight(int h
) { y
= h
; }
224 int GetWidth() const { return x
; }
225 int GetHeight() const { return y
; }
228 int GetX() const { return x
; }
229 int GetY() const { return y
; }
232 // ---------------------------------------------------------------------------
233 // Point classes: with real or integer coordinates
234 // ---------------------------------------------------------------------------
236 class WXDLLEXPORT wxRealPoint
242 wxRealPoint() { x
= y
= 0.0; };
243 wxRealPoint(double xx
, double yy
) { x
= xx
; y
= yy
; };
245 wxRealPoint
operator+(const wxRealPoint
& pt
) const { return wxRealPoint(x
+ pt
.x
, y
+ pt
.y
); }
246 wxRealPoint
operator-(const wxRealPoint
& pt
) const { return wxRealPoint(x
- pt
.x
, y
- pt
.y
); }
248 bool operator==(const wxRealPoint
& pt
) const { return x
== pt
.x
&& y
== pt
.y
; }
251 class WXDLLEXPORT wxPoint
256 wxPoint() { x
= y
= 0; };
257 wxPoint(int xx
, int yy
) { x
= xx
; y
= yy
; };
259 // no copy ctor or assignment operator - the defaults are ok
262 bool operator==(const wxPoint
& p
) const { return x
== p
.x
&& y
== p
.y
; }
263 bool operator!=(const wxPoint
& p
) const { return !(*this == p
); }
265 // arithmetic operations (component wise)
266 wxPoint
operator+(const wxPoint
& p
) const { return wxPoint(x
+ p
.x
, y
+ p
.y
); }
267 wxPoint
operator-(const wxPoint
& p
) const { return wxPoint(x
- p
.x
, y
- p
.y
); }
269 wxPoint
& operator+=(const wxPoint
& p
) { x
+= p
.x
; y
+= p
.y
; return *this; }
270 wxPoint
& operator-=(const wxPoint
& p
) { x
-= p
.x
; y
-= p
.y
; return *this; }
273 #if WXWIN_COMPATIBILITY
274 #define wxIntPoint wxPoint
275 #define wxRectangle wxRect
276 #endif // WXWIN_COMPATIBILITY
278 // ---------------------------------------------------------------------------
280 // ---------------------------------------------------------------------------
282 class WXDLLEXPORT wxRect
285 wxRect() { x
= y
= width
= height
= 0; }
286 wxRect(int xx
, int yy
, int ww
, int hh
)
287 { x
= xx
; y
= yy
; width
= ww
; height
= hh
; }
288 wxRect(const wxPoint
& topLeft
, const wxPoint
& bottomRight
);
289 wxRect(const wxPoint
& pos
, const wxSize
& size
);
291 // default copy ctor and assignment operators ok
293 int GetX() const { return x
; }
294 void SetX(int xx
) { x
= xx
; }
296 int GetY() const { return y
; }
297 void SetY(int yy
) { y
= yy
; }
299 int GetWidth() const { return width
; }
300 void SetWidth(int w
) { width
= w
; }
302 int GetHeight() const { return height
; }
303 void SetHeight(int h
) { height
= h
; }
305 wxPoint
GetPosition() const { return wxPoint(x
, y
); }
306 wxSize
GetSize() const { return wxSize(width
, height
); }
308 int GetLeft() const { return x
; }
309 int GetTop() const { return y
; }
310 int GetBottom() const { return y
+ height
- 1; }
311 int GetRight() const { return x
+ width
- 1; }
313 void SetLeft(int left
) { x
= left
; }
314 void SetRight(int right
) { width
= right
- x
+ 1; }
315 void SetTop(int top
) { y
= top
; }
316 void SetBottom(int bottom
) { height
= bottom
- y
+ 1; }
318 // operations with rect
319 wxRect
& Inflate(wxCoord dx
, wxCoord dy
);
320 wxRect
& Inflate(wxCoord d
) { return Inflate(d
, d
); }
321 wxRect
Inflate(wxCoord dx
, wxCoord dy
) const
328 wxRect
& Deflate(wxCoord dx
, wxCoord dy
) { return Inflate(-dx
, -dy
); }
329 wxRect
& Deflate(wxCoord d
) { return Inflate(-d
); }
330 wxRect
Deflate(wxCoord dx
, wxCoord dy
) const
337 void Offset(wxCoord dx
, wxCoord dy
) { x
+= dx
; y
+= dy
; }
338 void Offset(const wxPoint
& pt
) { Offset(pt
.x
, pt
.y
); }
340 wxRect
& Intersect(const wxRect
& rect
);
341 wxRect
Intersect(const wxRect
& rect
) const
348 wxRect
operator+(const wxRect
& rect
) const;
349 wxRect
& operator+=(const wxRect
& rect
);
351 // compare rectangles
352 bool operator==(const wxRect
& rect
) const;
353 bool operator!=(const wxRect
& rect
) const { return !(*this == rect
); }
355 // return TRUE if the point is (not strcitly) inside the rect
356 bool Inside(int x
, int y
) const;
357 bool Inside(const wxPoint
& pt
) const { return Inside(pt
.x
, pt
.y
); }
359 // return TRUE if the rectangles have a non empty intersection
360 bool Intersects(const wxRect
& rect
) const;
363 int x
, y
, width
, height
;
366 // ---------------------------------------------------------------------------
367 // Management of pens, brushes and fonts
368 // ---------------------------------------------------------------------------
370 typedef wxInt8 wxDash
;
372 class WXDLLEXPORT wxPenList
: public wxList
374 DECLARE_DYNAMIC_CLASS(wxPenList
)
380 void AddPen(wxPen
*pen
);
381 void RemovePen(wxPen
*pen
);
382 wxPen
*FindOrCreatePen(const wxColour
& colour
, int width
, int style
);
385 class WXDLLEXPORT wxBrushList
: public wxList
387 DECLARE_DYNAMIC_CLASS(wxBrushList
)
393 void AddBrush(wxBrush
*brush
);
394 void RemoveBrush(wxBrush
*brush
);
395 wxBrush
*FindOrCreateBrush(const wxColour
& colour
, int style
);
398 WXDLLEXPORT_DATA(extern const wxChar
*) wxEmptyString
;
400 class WXDLLEXPORT wxFontList
: public wxList
402 DECLARE_DYNAMIC_CLASS(wxFontList
)
408 void AddFont(wxFont
*font
);
409 void RemoveFont(wxFont
*font
);
410 wxFont
*FindOrCreateFont(int pointSize
, int family
, int style
, int weight
,
411 bool underline
= FALSE
,
412 const wxString
& face
= wxEmptyString
,
413 wxFontEncoding encoding
= wxFONTENCODING_DEFAULT
);
416 class WXDLLEXPORT wxColourDatabase
: public wxList
418 DECLARE_CLASS(wxColourDatabase
)
421 wxColourDatabase(int type
);
422 ~wxColourDatabase() ;
424 // Not const because it may add a name to the database
425 wxColour
*FindColour(const wxString
& colour
) ;
426 wxString
FindName(const wxColour
& colour
) const;
429 // PM keeps its own type of colour table
435 class WXDLLEXPORT wxBitmapList
: public wxList
437 DECLARE_DYNAMIC_CLASS(wxBitmapList
)
443 void AddBitmap(wxBitmap
*bitmap
);
444 void RemoveBitmap(wxBitmap
*bitmap
);
447 class WXDLLEXPORT wxResourceCache
: public wxList
450 wxResourceCache() { }
451 wxResourceCache(const unsigned int keyType
) : wxList(keyType
) { }
455 DECLARE_DYNAMIC_CLASS(wxResourceCache
)
458 // ---------------------------------------------------------------------------
460 // ---------------------------------------------------------------------------
462 // Lists of GDI objects
463 WXDLLEXPORT_DATA(extern wxPenList
*) wxThePenList
;
464 WXDLLEXPORT_DATA(extern wxBrushList
*) wxTheBrushList
;
465 WXDLLEXPORT_DATA(extern wxFontList
*) wxTheFontList
;
466 WXDLLEXPORT_DATA(extern wxBitmapList
*) wxTheBitmapList
;
469 WXDLLEXPORT_DATA(extern wxFont
*) wxNORMAL_FONT
;
470 WXDLLEXPORT_DATA(extern wxFont
*) wxSMALL_FONT
;
471 WXDLLEXPORT_DATA(extern wxFont
*) wxITALIC_FONT
;
472 WXDLLEXPORT_DATA(extern wxFont
*) wxSWISS_FONT
;
474 WXDLLEXPORT_DATA(extern wxPen
*) wxRED_PEN
;
475 WXDLLEXPORT_DATA(extern wxPen
*) wxCYAN_PEN
;
476 WXDLLEXPORT_DATA(extern wxPen
*) wxGREEN_PEN
;
477 WXDLLEXPORT_DATA(extern wxPen
*) wxBLACK_PEN
;
478 WXDLLEXPORT_DATA(extern wxPen
*) wxWHITE_PEN
;
479 WXDLLEXPORT_DATA(extern wxPen
*) wxTRANSPARENT_PEN
;
480 WXDLLEXPORT_DATA(extern wxPen
*) wxBLACK_DASHED_PEN
;
481 WXDLLEXPORT_DATA(extern wxPen
*) wxGREY_PEN
;
482 WXDLLEXPORT_DATA(extern wxPen
*) wxMEDIUM_GREY_PEN
;
483 WXDLLEXPORT_DATA(extern wxPen
*) wxLIGHT_GREY_PEN
;
485 WXDLLEXPORT_DATA(extern wxBrush
*) wxBLUE_BRUSH
;
486 WXDLLEXPORT_DATA(extern wxBrush
*) wxGREEN_BRUSH
;
487 WXDLLEXPORT_DATA(extern wxBrush
*) wxWHITE_BRUSH
;
488 WXDLLEXPORT_DATA(extern wxBrush
*) wxBLACK_BRUSH
;
489 WXDLLEXPORT_DATA(extern wxBrush
*) wxGREY_BRUSH
;
490 WXDLLEXPORT_DATA(extern wxBrush
*) wxMEDIUM_GREY_BRUSH
;
491 WXDLLEXPORT_DATA(extern wxBrush
*) wxLIGHT_GREY_BRUSH
;
492 WXDLLEXPORT_DATA(extern wxBrush
*) wxTRANSPARENT_BRUSH
;
493 WXDLLEXPORT_DATA(extern wxBrush
*) wxCYAN_BRUSH
;
494 WXDLLEXPORT_DATA(extern wxBrush
*) wxRED_BRUSH
;
496 WXDLLEXPORT_DATA(extern wxColour
*) wxBLACK
;
497 WXDLLEXPORT_DATA(extern wxColour
*) wxWHITE
;
498 WXDLLEXPORT_DATA(extern wxColour
*) wxRED
;
499 WXDLLEXPORT_DATA(extern wxColour
*) wxBLUE
;
500 WXDLLEXPORT_DATA(extern wxColour
*) wxGREEN
;
501 WXDLLEXPORT_DATA(extern wxColour
*) wxCYAN
;
502 WXDLLEXPORT_DATA(extern wxColour
*) wxLIGHT_GREY
;
505 WXDLLEXPORT_DATA(extern wxBitmap
) wxNullBitmap
;
506 WXDLLEXPORT_DATA(extern wxIcon
) wxNullIcon
;
507 WXDLLEXPORT_DATA(extern wxCursor
) wxNullCursor
;
508 WXDLLEXPORT_DATA(extern wxPen
) wxNullPen
;
509 WXDLLEXPORT_DATA(extern wxBrush
) wxNullBrush
;
510 WXDLLEXPORT_DATA(extern wxPalette
) wxNullPalette
;
511 WXDLLEXPORT_DATA(extern wxFont
) wxNullFont
;
512 WXDLLEXPORT_DATA(extern wxColour
) wxNullColour
;
514 // Stock cursors types
515 WXDLLEXPORT_DATA(extern wxCursor
*) wxSTANDARD_CURSOR
;
516 WXDLLEXPORT_DATA(extern wxCursor
*) wxHOURGLASS_CURSOR
;
517 WXDLLEXPORT_DATA(extern wxCursor
*) wxCROSS_CURSOR
;
519 WXDLLEXPORT_DATA(extern wxColourDatabase
*) wxTheColourDatabase
;
521 WXDLLEXPORT_DATA(extern const wxChar
*) wxPanelNameStr
;
523 WXDLLEXPORT_DATA(extern const wxSize
) wxDefaultSize
;
524 WXDLLEXPORT_DATA(extern const wxPoint
) wxDefaultPosition
;
526 // The list of objects which should be deleted
527 WXDLLEXPORT_DATA(extern wxList
) wxPendingDelete
;
529 // ---------------------------------------------------------------------------
531 // ---------------------------------------------------------------------------
533 // resource management
534 extern void WXDLLEXPORT
wxInitializeStockObjects();
535 extern void WXDLLEXPORT
wxInitializeStockLists();
536 extern void WXDLLEXPORT
wxDeleteStockObjects();
537 extern void WXDLLEXPORT
wxDeleteStockLists();
539 // is the display colour (or monochrome)?
540 extern bool WXDLLEXPORT
wxColourDisplay();
542 // Returns depth of screen
543 extern int WXDLLEXPORT
wxDisplayDepth();
544 #define wxGetDisplayDepth wxDisplayDepth
546 // get the display size
547 extern void WXDLLEXPORT
wxDisplaySize(int *width
, int *height
);
548 extern wxSize WXDLLEXPORT
wxGetDisplaySize();
549 extern void WXDLLEXPORT
wxDisplaySizeMM(int *width
, int *height
);
550 extern wxSize WXDLLEXPORT
wxGetDisplaySizeMM();
552 // Get position and size of the display workarea
553 extern void WXDLLEXPORT
wxClientDisplayRect(int *x
, int *y
, int *width
, int *height
);
554 extern wxRect WXDLLEXPORT
wxGetClientDisplayRect();
557 extern void WXDLLEXPORT
wxSetCursor(const wxCursor
& cursor
);