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
101 wxCURSOR_MIDDLE_BUTTON
,
103 wxCURSOR_PAINT_BRUSH
,
106 wxCURSOR_POINT_RIGHT
,
107 wxCURSOR_QUESTION_ARROW
,
108 wxCURSOR_RIGHT_BUTTON
,
119 wxCURSOR_DEFAULT
, // standard X11 cursor
122 // Not yet implemented for Windows
123 wxCURSOR_CROSS_REVERSE
,
124 wxCURSOR_DOUBLE_ARROW
,
125 wxCURSOR_BASED_ARROW_UP
,
126 wxCURSOR_BASED_ARROW_DOWN
,
135 #define wxCURSOR_DEFAULT wxCURSOR_ARROW
138 // ---------------------------------------------------------------------------
140 // ---------------------------------------------------------------------------
142 /* Useful macro for creating icons portably, for example:
144 wxIcon *icon = new wxICON(mondrian);
148 wxIcon *icon = new wxIcon("mondrian"); // On wxMSW
149 wxIcon *icon = new wxIcon(mondrian_xpm); // On wxGTK
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 )
174 // This will usually mean something on any platform
175 #define wxICON(X) wxIcon("" #X "")
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.
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)
191 // ===========================================================================
193 // ===========================================================================
195 // ---------------------------------------------------------------------------
197 // ---------------------------------------------------------------------------
199 class WXDLLEXPORT wxSize
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)
208 wxSize() : x(0), y(0) { }
209 wxSize(int xx
, int yy
) : x(xx
), y(yy
) { }
211 // no copy ctor or assignment operator - the defaults are ok
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
; }
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
); }
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
; }
225 int GetWidth() const { return x
; }
226 int GetHeight() const { return y
; }
229 int GetX() const { return x
; }
230 int GetY() const { return y
; }
233 // ---------------------------------------------------------------------------
234 // Point classes: with real or integer coordinates
235 // ---------------------------------------------------------------------------
237 class WXDLLEXPORT wxRealPoint
243 wxRealPoint() : x(0.0), y(0.0) { }
244 wxRealPoint(double xx
, double yy
) : x(xx
), y(yy
) { }
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
); }
249 bool operator==(const wxRealPoint
& pt
) const { return x
== pt
.x
&& y
== pt
.y
; }
252 class WXDLLEXPORT wxPoint
257 wxPoint() : x(0), y(0) { }
258 wxPoint(int xx
, int yy
) : x(xx
), y(yy
) { }
260 // no copy ctor or assignment operator - the defaults are ok
263 bool operator==(const wxPoint
& p
) const { return x
== p
.x
&& y
== p
.y
; }
264 bool operator!=(const wxPoint
& p
) const { return !(*this == p
); }
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
); }
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; }
274 #if WXWIN_COMPATIBILITY
275 #define wxIntPoint wxPoint
276 #define wxRectangle wxRect
277 #endif // WXWIN_COMPATIBILITY
279 // ---------------------------------------------------------------------------
281 // ---------------------------------------------------------------------------
283 class WXDLLEXPORT wxRect
287 : x(0), y(0), width(0), height(0)
289 wxRect(int xx
, int yy
, int ww
, int hh
)
290 : x(xx
), y(yy
), width(ww
), height(hh
)
292 wxRect(const wxPoint
& topLeft
, const wxPoint
& bottomRight
);
293 wxRect(const wxPoint
& pos
, const wxSize
& size
);
295 // default copy ctor and assignment operators ok
297 int GetX() const { return x
; }
298 void SetX(int xx
) { x
= xx
; }
300 int GetY() const { return y
; }
301 void SetY(int yy
) { y
= yy
; }
303 int GetWidth() const { return width
; }
304 void SetWidth(int w
) { width
= w
; }
306 int GetHeight() const { return height
; }
307 void SetHeight(int h
) { height
= h
; }
309 wxPoint
GetPosition() const { return wxPoint(x
, y
); }
310 wxSize
GetSize() const { return wxSize(width
, height
); }
312 int GetLeft() const { return x
; }
313 int GetTop() const { return y
; }
314 int GetBottom() const { return y
+ height
- 1; }
315 int GetRight() const { return x
+ width
- 1; }
317 void SetLeft(int left
) { x
= left
; }
318 void SetRight(int right
) { width
= right
- x
+ 1; }
319 void SetTop(int top
) { y
= top
; }
320 void SetBottom(int bottom
) { height
= bottom
- y
+ 1; }
322 // operations with rect
323 wxRect
& Inflate(wxCoord dx
, wxCoord dy
);
324 wxRect
& Inflate(wxCoord d
) { return Inflate(d
, d
); }
325 wxRect
Inflate(wxCoord dx
, wxCoord dy
) const
332 wxRect
& Deflate(wxCoord dx
, wxCoord dy
) { return Inflate(-dx
, -dy
); }
333 wxRect
& Deflate(wxCoord d
) { return Inflate(-d
); }
334 wxRect
Deflate(wxCoord dx
, wxCoord dy
) const
341 void Offset(wxCoord dx
, wxCoord dy
) { x
+= dx
; y
+= dy
; }
342 void Offset(const wxPoint
& pt
) { Offset(pt
.x
, pt
.y
); }
344 wxRect
& Intersect(const wxRect
& rect
);
345 wxRect
Intersect(const wxRect
& rect
) const
352 wxRect
operator+(const wxRect
& rect
) const;
353 wxRect
& operator+=(const wxRect
& rect
);
355 // compare rectangles
356 bool operator==(const wxRect
& rect
) const;
357 bool operator!=(const wxRect
& rect
) const { return !(*this == rect
); }
359 // return TRUE if the point is (not strcitly) inside the rect
360 bool Inside(int x
, int y
) const;
361 bool Inside(const wxPoint
& pt
) const { return Inside(pt
.x
, pt
.y
); }
363 // return TRUE if the rectangles have a non empty intersection
364 bool Intersects(const wxRect
& rect
) const;
367 int x
, y
, width
, height
;
370 // ---------------------------------------------------------------------------
371 // Management of pens, brushes and fonts
372 // ---------------------------------------------------------------------------
374 typedef wxInt8 wxDash
;
376 class WXDLLEXPORT wxPenList
: public wxList
378 DECLARE_DYNAMIC_CLASS(wxPenList
)
384 void AddPen(wxPen
*pen
);
385 void RemovePen(wxPen
*pen
);
386 wxPen
*FindOrCreatePen(const wxColour
& colour
, int width
, int style
);
389 class WXDLLEXPORT wxBrushList
: public wxList
391 DECLARE_DYNAMIC_CLASS(wxBrushList
)
397 void AddBrush(wxBrush
*brush
);
398 void RemoveBrush(wxBrush
*brush
);
399 wxBrush
*FindOrCreateBrush(const wxColour
& colour
, int style
);
402 WXDLLEXPORT_DATA(extern const wxChar
*) wxEmptyString
;
404 class WXDLLEXPORT wxFontList
: public wxList
406 DECLARE_DYNAMIC_CLASS(wxFontList
)
412 void AddFont(wxFont
*font
);
413 void RemoveFont(wxFont
*font
);
414 wxFont
*FindOrCreateFont(int pointSize
, int family
, int style
, int weight
,
415 bool underline
= FALSE
,
416 const wxString
& face
= wxEmptyString
,
417 wxFontEncoding encoding
= wxFONTENCODING_DEFAULT
);
420 class WXDLLEXPORT wxColourDatabase
: public wxList
422 DECLARE_CLASS(wxColourDatabase
)
425 wxColourDatabase(int type
);
426 ~wxColourDatabase() ;
428 // Not const because it may add a name to the database
429 wxColour
*FindColour(const wxString
& colour
) ;
430 wxString
FindName(const wxColour
& colour
) const;
433 // PM keeps its own type of colour table
439 class WXDLLEXPORT wxBitmapList
: public wxList
441 DECLARE_DYNAMIC_CLASS(wxBitmapList
)
447 void AddBitmap(wxBitmap
*bitmap
);
448 void RemoveBitmap(wxBitmap
*bitmap
);
451 class WXDLLEXPORT wxResourceCache
: public wxList
454 wxResourceCache() { }
455 wxResourceCache(const unsigned int keyType
) : wxList(keyType
) { }
459 DECLARE_DYNAMIC_CLASS(wxResourceCache
)
462 // ---------------------------------------------------------------------------
464 // ---------------------------------------------------------------------------
466 // Lists of GDI objects
467 WXDLLEXPORT_DATA(extern wxPenList
*) wxThePenList
;
468 WXDLLEXPORT_DATA(extern wxBrushList
*) wxTheBrushList
;
469 WXDLLEXPORT_DATA(extern wxFontList
*) wxTheFontList
;
470 WXDLLEXPORT_DATA(extern wxBitmapList
*) wxTheBitmapList
;
473 WXDLLEXPORT_DATA(extern wxFont
*) wxNORMAL_FONT
;
474 WXDLLEXPORT_DATA(extern wxFont
*) wxSMALL_FONT
;
475 WXDLLEXPORT_DATA(extern wxFont
*) wxITALIC_FONT
;
476 WXDLLEXPORT_DATA(extern wxFont
*) wxSWISS_FONT
;
478 WXDLLEXPORT_DATA(extern wxPen
*) wxRED_PEN
;
479 WXDLLEXPORT_DATA(extern wxPen
*) wxCYAN_PEN
;
480 WXDLLEXPORT_DATA(extern wxPen
*) wxGREEN_PEN
;
481 WXDLLEXPORT_DATA(extern wxPen
*) wxBLACK_PEN
;
482 WXDLLEXPORT_DATA(extern wxPen
*) wxWHITE_PEN
;
483 WXDLLEXPORT_DATA(extern wxPen
*) wxTRANSPARENT_PEN
;
484 WXDLLEXPORT_DATA(extern wxPen
*) wxBLACK_DASHED_PEN
;
485 WXDLLEXPORT_DATA(extern wxPen
*) wxGREY_PEN
;
486 WXDLLEXPORT_DATA(extern wxPen
*) wxMEDIUM_GREY_PEN
;
487 WXDLLEXPORT_DATA(extern wxPen
*) wxLIGHT_GREY_PEN
;
489 WXDLLEXPORT_DATA(extern wxBrush
*) wxBLUE_BRUSH
;
490 WXDLLEXPORT_DATA(extern wxBrush
*) wxGREEN_BRUSH
;
491 WXDLLEXPORT_DATA(extern wxBrush
*) wxWHITE_BRUSH
;
492 WXDLLEXPORT_DATA(extern wxBrush
*) wxBLACK_BRUSH
;
493 WXDLLEXPORT_DATA(extern wxBrush
*) wxGREY_BRUSH
;
494 WXDLLEXPORT_DATA(extern wxBrush
*) wxMEDIUM_GREY_BRUSH
;
495 WXDLLEXPORT_DATA(extern wxBrush
*) wxLIGHT_GREY_BRUSH
;
496 WXDLLEXPORT_DATA(extern wxBrush
*) wxTRANSPARENT_BRUSH
;
497 WXDLLEXPORT_DATA(extern wxBrush
*) wxCYAN_BRUSH
;
498 WXDLLEXPORT_DATA(extern wxBrush
*) wxRED_BRUSH
;
500 WXDLLEXPORT_DATA(extern wxColour
*) wxBLACK
;
501 WXDLLEXPORT_DATA(extern wxColour
*) wxWHITE
;
502 WXDLLEXPORT_DATA(extern wxColour
*) wxRED
;
503 WXDLLEXPORT_DATA(extern wxColour
*) wxBLUE
;
504 WXDLLEXPORT_DATA(extern wxColour
*) wxGREEN
;
505 WXDLLEXPORT_DATA(extern wxColour
*) wxCYAN
;
506 WXDLLEXPORT_DATA(extern wxColour
*) wxLIGHT_GREY
;
509 WXDLLEXPORT_DATA(extern wxBitmap
) wxNullBitmap
;
510 WXDLLEXPORT_DATA(extern wxIcon
) wxNullIcon
;
511 WXDLLEXPORT_DATA(extern wxCursor
) wxNullCursor
;
512 WXDLLEXPORT_DATA(extern wxPen
) wxNullPen
;
513 WXDLLEXPORT_DATA(extern wxBrush
) wxNullBrush
;
514 WXDLLEXPORT_DATA(extern wxPalette
) wxNullPalette
;
515 WXDLLEXPORT_DATA(extern wxFont
) wxNullFont
;
516 WXDLLEXPORT_DATA(extern wxColour
) wxNullColour
;
518 // Stock cursors types
519 WXDLLEXPORT_DATA(extern wxCursor
*) wxSTANDARD_CURSOR
;
520 WXDLLEXPORT_DATA(extern wxCursor
*) wxHOURGLASS_CURSOR
;
521 WXDLLEXPORT_DATA(extern wxCursor
*) wxCROSS_CURSOR
;
523 WXDLLEXPORT_DATA(extern wxColourDatabase
*) wxTheColourDatabase
;
525 WXDLLEXPORT_DATA(extern const wxChar
*) wxPanelNameStr
;
527 WXDLLEXPORT_DATA(extern const wxSize
) wxDefaultSize
;
528 WXDLLEXPORT_DATA(extern const wxPoint
) wxDefaultPosition
;
530 // The list of objects which should be deleted
531 WXDLLEXPORT_DATA(extern wxList
) wxPendingDelete
;
533 // ---------------------------------------------------------------------------
535 // ---------------------------------------------------------------------------
537 // resource management
538 extern void WXDLLEXPORT
wxInitializeStockObjects();
539 extern void WXDLLEXPORT
wxInitializeStockLists();
540 extern void WXDLLEXPORT
wxDeleteStockObjects();
541 extern void WXDLLEXPORT
wxDeleteStockLists();
543 // is the display colour (or monochrome)?
544 extern bool WXDLLEXPORT
wxColourDisplay();
546 // Returns depth of screen
547 extern int WXDLLEXPORT
wxDisplayDepth();
548 #define wxGetDisplayDepth wxDisplayDepth
550 // get the display size
551 extern void WXDLLEXPORT
wxDisplaySize(int *width
, int *height
);
552 extern wxSize WXDLLEXPORT
wxGetDisplaySize();
553 extern void WXDLLEXPORT
wxDisplaySizeMM(int *width
, int *height
);
554 extern wxSize WXDLLEXPORT
wxGetDisplaySizeMM();
556 // Get position and size of the display workarea
557 extern void WXDLLEXPORT
wxClientDisplayRect(int *x
, int *y
, int *width
, int *height
);
558 extern wxRect WXDLLEXPORT
wxGetClientDisplayRect();
561 extern void WXDLLEXPORT
wxSetCursor(const wxCursor
& cursor
);