1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Common GDI classes, types and declarations
4 // Author: Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
15 // ---------------------------------------------------------------------------
17 // ---------------------------------------------------------------------------
19 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
20 #pragma interface "gdicmn.h"
25 #include "wx/string.h"
26 #include "wx/fontenc.h"
27 #include "wx/hashmap.h"
29 // ---------------------------------------------------------------------------
30 // forward declarations
31 // ---------------------------------------------------------------------------
33 class WXDLLIMPEXP_CORE wxBitmap
;
34 class WXDLLIMPEXP_CORE wxBrush
;
35 class WXDLLIMPEXP_CORE wxColour
;
36 class WXDLLIMPEXP_CORE wxCursor
;
37 class WXDLLIMPEXP_CORE wxFont
;
38 class WXDLLIMPEXP_CORE wxIcon
;
39 class WXDLLIMPEXP_CORE wxPalette
;
40 class WXDLLIMPEXP_CORE wxPen
;
41 class WXDLLIMPEXP_CORE wxRegion
;
42 class WXDLLIMPEXP_BASE wxString
;
44 // ---------------------------------------------------------------------------
46 // ---------------------------------------------------------------------------
51 wxBITMAP_TYPE_INVALID
, // should be == 0 for compatibility!
53 wxBITMAP_TYPE_BMP_RESOURCE
,
54 wxBITMAP_TYPE_RESOURCE
= wxBITMAP_TYPE_BMP_RESOURCE
,
56 wxBITMAP_TYPE_ICO_RESOURCE
,
58 wxBITMAP_TYPE_CUR_RESOURCE
,
60 wxBITMAP_TYPE_XBM_DATA
,
62 wxBITMAP_TYPE_XPM_DATA
,
64 wxBITMAP_TYPE_TIF_RESOURCE
,
66 wxBITMAP_TYPE_GIF_RESOURCE
,
68 wxBITMAP_TYPE_PNG_RESOURCE
,
70 wxBITMAP_TYPE_JPEG_RESOURCE
,
72 wxBITMAP_TYPE_PNM_RESOURCE
,
74 wxBITMAP_TYPE_PCX_RESOURCE
,
76 wxBITMAP_TYPE_PICT_RESOURCE
,
78 wxBITMAP_TYPE_ICON_RESOURCE
,
81 wxBITMAP_TYPE_MACCURSOR
,
82 wxBITMAP_TYPE_MACCURSOR_RESOURCE
,
83 wxBITMAP_TYPE_ANY
= 50
89 wxCURSOR_NONE
, // should be 0
99 wxCURSOR_MIDDLE_BUTTON
,
101 wxCURSOR_PAINT_BRUSH
,
104 wxCURSOR_POINT_RIGHT
,
105 wxCURSOR_QUESTION_ARROW
,
106 wxCURSOR_RIGHT_BUTTON
,
117 wxCURSOR_DEFAULT
, // standard X11 cursor
120 wxCURSOR_COPY_ARROW
, // MacOS Theme Plus arrow
123 // Not yet implemented for Windows
124 wxCURSOR_CROSS_REVERSE
,
125 wxCURSOR_DOUBLE_ARROW
,
126 wxCURSOR_BASED_ARROW_UP
,
127 wxCURSOR_BASED_ARROW_DOWN
,
136 #define wxCURSOR_DEFAULT wxCURSOR_ARROW
139 // ---------------------------------------------------------------------------
141 // ---------------------------------------------------------------------------
143 /* Useful macro for creating icons portably, for example:
145 wxIcon *icon = new wxICON(mondrian);
149 wxIcon *icon = new wxIcon("mondrian"); // On wxMSW
150 wxIcon *icon = new wxIcon(mondrian_xpm); // On wxGTK
154 // Load from a resource
155 #define wxICON(X) wxIcon(wxT(#X))
156 #elif defined(__WXPM__)
157 // Load from a resource
158 #define wxICON(X) wxIcon(wxT(#X))
159 #elif defined(__WXMGL__)
160 // Initialize from an included XPM
161 #define wxICON(X) wxIcon( (const char**) X##_xpm )
162 #elif defined(__WXGTK__)
163 // Initialize from an included XPM
164 #define wxICON(X) wxIcon( (const char**) X##_xpm )
165 #elif defined(__WXMAC__)
166 // Initialize from an included XPM
167 #define wxICON(X) wxIcon( (const char**) X##_xpm )
168 #elif defined(__WXMOTIF__)
169 // Initialize from an included XPM
170 #define wxICON(X) wxIcon( X##_xpm )
171 #elif defined(__WXX11__)
172 // Initialize from an included XPM
173 #define wxICON(X) wxIcon( X##_xpm )
175 // This will usually mean something on any platform
176 #define wxICON(X) wxIcon(wxT(#X))
179 /* Another macro: this one is for portable creation of bitmaps. We assume that
180 under Unix bitmaps live in XPMs and under Windows they're in ressources.
183 #if defined(__WXMSW__) || defined(__WXPM__)
184 #define wxBITMAP(name) wxBitmap(wxT(#name), wxBITMAP_TYPE_RESOURCE)
185 #elif defined(__WXGTK__) || \
186 defined(__WXMOTIF__) || \
187 defined(__WXX11__) || \
188 defined(__WXMAC__) || \
189 defined(__WXMGL__) || \
191 // Initialize from an included XPM
192 #define wxBITMAP(name) wxBitmap( (const char**) name##_xpm )
193 #else // other platforms
194 #define wxBITMAP(name) wxBitmap(name##_xpm, wxBITMAP_TYPE_XPM)
197 // ===========================================================================
199 // ===========================================================================
201 // ---------------------------------------------------------------------------
203 // ---------------------------------------------------------------------------
205 class WXDLLEXPORT wxSize
208 // members are public for compatibility, don't use them directly.
212 wxSize() : x(0), y(0) { }
213 wxSize(int xx
, int yy
) : x(xx
), y(yy
) { }
215 // no copy ctor or assignment operator - the defaults are ok
217 bool operator==(const wxSize
& sz
) const { return x
== sz
.x
&& y
== sz
.y
; }
218 bool operator!=(const wxSize
& sz
) const { return x
!= sz
.x
|| y
!= sz
.y
; }
220 wxSize
operator+(const wxSize
& sz
) { return wxSize(x
+ sz
.x
, y
+ sz
.y
); }
221 wxSize
operator-(const wxSize
& sz
) { return wxSize(x
- sz
.x
, y
- sz
.y
); }
222 wxSize
operator/(const int i
) { return wxSize(x
/ i
, y
/ i
); }
223 wxSize
operator*(const int i
) { return wxSize(x
* i
, y
* i
); }
225 wxSize
& operator+=(const wxSize
& sz
) { x
+= sz
.x
; y
+= sz
.y
; return *this; }
226 wxSize
& operator-=(const wxSize
& sz
) { x
-= sz
.x
; y
-= sz
.y
; return *this; }
227 wxSize
& operator/=(const int i
) { x
/= i
; y
/= i
; return *this; }
228 wxSize
& operator*=(const int i
) { x
*= i
; y
*= i
; return *this; }
230 void IncTo(const wxSize
& sz
)
231 { if ( sz
.x
> x
) x
= sz
.x
; if ( sz
.y
> y
) y
= sz
.y
; }
232 void DecTo(const wxSize
& sz
)
233 { if ( sz
.x
< x
) x
= sz
.x
; if ( sz
.y
< y
) y
= sz
.y
; }
236 void Set(int xx
, int yy
) { x
= xx
; y
= yy
; }
237 void SetWidth(int w
) { x
= w
; }
238 void SetHeight(int h
) { y
= h
; }
240 int GetWidth() const { return x
; }
241 int GetHeight() const { return y
; }
243 bool IsFullySpecified() const { return x
!= wxDefaultCoord
&& y
!= wxDefaultCoord
; }
245 // combine this size with the other one replacing the default (i.e. equal
246 // to wxDefaultCoord) components of this object with those of the other
247 void SetDefaults(const wxSize
& size
)
249 if ( x
== wxDefaultCoord
)
251 if ( y
== wxDefaultCoord
)
256 int GetX() const { return x
; }
257 int GetY() const { return y
; }
260 // ---------------------------------------------------------------------------
261 // Point classes: with real or integer coordinates
262 // ---------------------------------------------------------------------------
264 class WXDLLEXPORT wxRealPoint
270 wxRealPoint() : x(0.0), y(0.0) { }
271 wxRealPoint(double xx
, double yy
) : x(xx
), y(yy
) { }
273 wxRealPoint
operator+(const wxRealPoint
& pt
) const { return wxRealPoint(x
+ pt
.x
, y
+ pt
.y
); }
274 wxRealPoint
operator-(const wxRealPoint
& pt
) const { return wxRealPoint(x
- pt
.x
, y
- pt
.y
); }
276 bool operator==(const wxRealPoint
& pt
) const { return x
== pt
.x
&& y
== pt
.y
; }
277 bool operator!=(const wxRealPoint
& pt
) const { return x
!= pt
.x
|| y
!= pt
.y
; }
280 class WXDLLEXPORT wxPoint
285 wxPoint() : x(0), y(0) { }
286 wxPoint(int xx
, int yy
) : x(xx
), y(yy
) { }
288 // no copy ctor or assignment operator - the defaults are ok
291 bool operator==(const wxPoint
& p
) const { return x
== p
.x
&& y
== p
.y
; }
292 bool operator!=(const wxPoint
& p
) const { return !(*this == p
); }
294 // arithmetic operations (component wise)
295 wxPoint
operator+(const wxPoint
& p
) const { return wxPoint(x
+ p
.x
, y
+ p
.y
); }
296 wxPoint
operator-(const wxPoint
& p
) const { return wxPoint(x
- p
.x
, y
- p
.y
); }
298 wxPoint
& operator+=(const wxPoint
& p
) { x
+= p
.x
; y
+= p
.y
; return *this; }
299 wxPoint
& operator-=(const wxPoint
& p
) { x
-= p
.x
; y
-= p
.y
; return *this; }
301 wxPoint
& operator+=(const wxSize
& s
) { x
+= s
.GetWidth(); y
+= s
.GetHeight(); return *this; }
302 wxPoint
& operator-=(const wxSize
& s
) { x
-= s
.GetWidth(); y
-= s
.GetHeight(); return *this; }
304 wxPoint
operator+(const wxSize
& s
) const { return wxPoint(x
+ s
.GetWidth(), y
+ s
.GetHeight()); }
305 wxPoint
operator-(const wxSize
& s
) const { return wxPoint(x
- s
.GetWidth(), y
- s
.GetHeight()); }
308 // ---------------------------------------------------------------------------
310 // ---------------------------------------------------------------------------
312 class WXDLLEXPORT wxRect
316 : x(0), y(0), width(0), height(0)
318 wxRect(int xx
, int yy
, int ww
, int hh
)
319 : x(xx
), y(yy
), width(ww
), height(hh
)
321 wxRect(const wxPoint
& topLeft
, const wxPoint
& bottomRight
);
322 wxRect(const wxPoint
& pt
, const wxSize
& size
)
323 : x(pt
.x
), y(pt
.y
), width(size
.x
), height(size
.y
)
325 wxRect(const wxSize
& size
)
326 : x(0), y(0), width(size
.x
), height(size
.y
)
329 // default copy ctor and assignment operators ok
331 int GetX() const { return x
; }
332 void SetX(int xx
) { x
= xx
; }
334 int GetY() const { return y
; }
335 void SetY(int yy
) { y
= yy
; }
337 int GetWidth() const { return width
; }
338 void SetWidth(int w
) { width
= w
; }
340 int GetHeight() const { return height
; }
341 void SetHeight(int h
) { height
= h
; }
343 wxPoint
GetPosition() const { return wxPoint(x
, y
); }
344 void SetPosition( const wxPoint
&p
) { x
= p
.x
; y
= p
.y
; }
346 wxSize
GetSize() const { return wxSize(width
, height
); }
347 void SetSize( const wxSize
&s
) { width
= s
.GetWidth(); height
= s
.GetHeight(); }
349 bool IsEmpty() const { return (width
<= 0) || (height
<= 0); }
351 wxPoint
GetTopLeft() const { return GetPosition(); }
352 wxPoint
GetLeftTop() const { return GetTopLeft(); }
353 void SetTopLeft(const wxPoint
&p
) { SetPosition(p
); }
354 void SetLeftTop(const wxPoint
&p
) { SetTopLeft(p
); }
356 wxPoint
GetBottomRight() const { return wxPoint(GetRight(), GetBottom()); }
357 wxPoint
GetRightBottom() const { return GetBottomRight(); }
358 void SetBottomRight(const wxPoint
&p
) { SetRight(p
.x
); SetBottom(p
.y
); }
359 void SetRightBottom(const wxPoint
&p
) { SetBottomRight(p
); }
361 int GetLeft() const { return x
; }
362 int GetTop() const { return y
; }
363 int GetBottom() const { return y
+ height
- 1; }
364 int GetRight() const { return x
+ width
- 1; }
366 void SetLeft(int left
) { x
= left
; }
367 void SetRight(int right
) { width
= right
- x
+ 1; }
368 void SetTop(int top
) { y
= top
; }
369 void SetBottom(int bottom
) { height
= bottom
- y
+ 1; }
371 // operations with rect
372 wxRect
& Inflate(wxCoord dx
, wxCoord dy
);
373 wxRect
& Inflate(wxCoord d
) { return Inflate(d
, d
); }
374 wxRect
Inflate(wxCoord dx
, wxCoord dy
) const
381 wxRect
& Deflate(wxCoord dx
, wxCoord dy
) { return Inflate(-dx
, -dy
); }
382 wxRect
& Deflate(wxCoord d
) { return Inflate(-d
); }
383 wxRect
Deflate(wxCoord dx
, wxCoord dy
) const
390 void Offset(wxCoord dx
, wxCoord dy
) { x
+= dx
; y
+= dy
; }
391 void Offset(const wxPoint
& pt
) { Offset(pt
.x
, pt
.y
); }
393 wxRect
& Intersect(const wxRect
& rect
);
394 wxRect
Intersect(const wxRect
& rect
) const
401 wxRect
& Union(const wxRect
& rect
);
402 wxRect
Union(const wxRect
& rect
) const
409 // compare rectangles
410 bool operator==(const wxRect
& rect
) const;
411 bool operator!=(const wxRect
& rect
) const { return !(*this == rect
); }
413 // return true if the point is (not strcitly) inside the rect
414 bool Inside(int x
, int y
) const;
415 bool Inside(const wxPoint
& pt
) const { return Inside(pt
.x
, pt
.y
); }
417 // return true if the rectangles have a non empty intersection
418 bool Intersects(const wxRect
& rect
) const;
421 // these are like Union() but don't ignore empty rectangles
422 wxRect
operator+(const wxRect
& rect
) const;
423 wxRect
& operator+=(const wxRect
& rect
)
425 *this = *this + rect
;
431 int x
, y
, width
, height
;
434 // ---------------------------------------------------------------------------
435 // Management of pens, brushes and fonts
436 // ---------------------------------------------------------------------------
438 typedef wxInt8 wxDash
;
440 class WXDLLEXPORT wxPenList
: public wxList
446 void AddPen(wxPen
*pen
);
447 void RemovePen(wxPen
*pen
);
448 wxPen
*FindOrCreatePen(const wxColour
& colour
, int width
, int style
);
451 class WXDLLEXPORT wxBrushList
: public wxList
457 void AddBrush(wxBrush
*brush
);
458 void RemoveBrush(wxBrush
*brush
);
459 wxBrush
*FindOrCreateBrush(const wxColour
& colour
, int style
);
462 class WXDLLEXPORT wxFontList
: public wxList
468 void AddFont(wxFont
*font
);
469 void RemoveFont(wxFont
*font
);
470 wxFont
*FindOrCreateFont(int pointSize
, int family
, int style
, int weight
,
471 bool underline
= false,
472 const wxString
& face
= wxEmptyString
,
473 wxFontEncoding encoding
= wxFONTENCODING_DEFAULT
);
476 WX_DECLARE_STRING_HASH_MAP( wxColour
*, wxStringToColourHashMap
);
478 class WXDLLEXPORT wxColourDatabase
484 // find colour by name or name for the given colour
485 wxColour
Find(const wxString
& name
) const;
486 wxString
FindName(const wxColour
& colour
) const;
488 // add a new colour to the database
489 void AddColour(const wxString
& name
, const wxColour
& colour
);
491 // deprecated, use Find() instead
492 wxDEPRECATED( wxColour
*FindColour(const wxString
& name
) );
496 // PM keeps its own type of colour table
502 // load the database with the built in colour values when called for the
503 // first time, do nothing after this
506 wxStringToColourHashMap
*m_map
;
509 class WXDLLEXPORT wxBitmapList
: public wxList
515 void AddBitmap(wxBitmap
*bitmap
);
516 void RemoveBitmap(wxBitmap
*bitmap
);
519 class WXDLLEXPORT wxResourceCache
: public wxList
522 wxResourceCache() { }
524 wxResourceCache(const unsigned int keyType
) : wxList(keyType
) { }
529 // ---------------------------------------------------------------------------
531 // ---------------------------------------------------------------------------
533 // Lists of GDI objects
534 extern WXDLLEXPORT_DATA(wxPenList
*) wxThePenList
;
535 extern WXDLLEXPORT_DATA(wxBrushList
*) wxTheBrushList
;
536 extern WXDLLEXPORT_DATA(wxFontList
*) wxTheFontList
;
537 extern WXDLLEXPORT_DATA(wxBitmapList
*) wxTheBitmapList
;
540 extern WXDLLEXPORT_DATA(wxFont
*) wxNORMAL_FONT
;
541 extern WXDLLEXPORT_DATA(wxFont
*) wxSMALL_FONT
;
542 extern WXDLLEXPORT_DATA(wxFont
*) wxITALIC_FONT
;
543 extern WXDLLEXPORT_DATA(wxFont
*) wxSWISS_FONT
;
545 extern WXDLLEXPORT_DATA(wxPen
*) wxRED_PEN
;
546 extern WXDLLEXPORT_DATA(wxPen
*) wxCYAN_PEN
;
547 extern WXDLLEXPORT_DATA(wxPen
*) wxGREEN_PEN
;
548 extern WXDLLEXPORT_DATA(wxPen
*) wxBLACK_PEN
;
549 extern WXDLLEXPORT_DATA(wxPen
*) wxWHITE_PEN
;
550 extern WXDLLEXPORT_DATA(wxPen
*) wxTRANSPARENT_PEN
;
551 extern WXDLLEXPORT_DATA(wxPen
*) wxBLACK_DASHED_PEN
;
552 extern WXDLLEXPORT_DATA(wxPen
*) wxGREY_PEN
;
553 extern WXDLLEXPORT_DATA(wxPen
*) wxMEDIUM_GREY_PEN
;
554 extern WXDLLEXPORT_DATA(wxPen
*) wxLIGHT_GREY_PEN
;
556 extern WXDLLEXPORT_DATA(wxBrush
*) wxBLUE_BRUSH
;
557 extern WXDLLEXPORT_DATA(wxBrush
*) wxGREEN_BRUSH
;
558 extern WXDLLEXPORT_DATA(wxBrush
*) wxWHITE_BRUSH
;
559 extern WXDLLEXPORT_DATA(wxBrush
*) wxBLACK_BRUSH
;
560 extern WXDLLEXPORT_DATA(wxBrush
*) wxGREY_BRUSH
;
561 extern WXDLLEXPORT_DATA(wxBrush
*) wxMEDIUM_GREY_BRUSH
;
562 extern WXDLLEXPORT_DATA(wxBrush
*) wxLIGHT_GREY_BRUSH
;
563 extern WXDLLEXPORT_DATA(wxBrush
*) wxTRANSPARENT_BRUSH
;
564 extern WXDLLEXPORT_DATA(wxBrush
*) wxCYAN_BRUSH
;
565 extern WXDLLEXPORT_DATA(wxBrush
*) wxRED_BRUSH
;
567 extern WXDLLEXPORT_DATA(wxColour
*) wxBLACK
;
568 extern WXDLLEXPORT_DATA(wxColour
*) wxWHITE
;
569 extern WXDLLEXPORT_DATA(wxColour
*) wxRED
;
570 extern WXDLLEXPORT_DATA(wxColour
*) wxBLUE
;
571 extern WXDLLEXPORT_DATA(wxColour
*) wxGREEN
;
572 extern WXDLLEXPORT_DATA(wxColour
*) wxCYAN
;
573 extern WXDLLEXPORT_DATA(wxColour
*) wxLIGHT_GREY
;
576 extern WXDLLEXPORT_DATA(wxBitmap
) wxNullBitmap
;
577 extern WXDLLEXPORT_DATA(wxIcon
) wxNullIcon
;
578 extern WXDLLEXPORT_DATA(wxCursor
) wxNullCursor
;
579 extern WXDLLEXPORT_DATA(wxPen
) wxNullPen
;
580 extern WXDLLEXPORT_DATA(wxBrush
) wxNullBrush
;
581 extern WXDLLEXPORT_DATA(wxPalette
) wxNullPalette
;
582 extern WXDLLEXPORT_DATA(wxFont
) wxNullFont
;
583 extern WXDLLEXPORT_DATA(wxColour
) wxNullColour
;
585 // Stock cursors types
586 extern WXDLLEXPORT_DATA(wxCursor
*) wxSTANDARD_CURSOR
;
587 extern WXDLLEXPORT_DATA(wxCursor
*) wxHOURGLASS_CURSOR
;
588 extern WXDLLEXPORT_DATA(wxCursor
*) wxCROSS_CURSOR
;
590 extern WXDLLEXPORT_DATA(wxColourDatabase
*) wxTheColourDatabase
;
592 extern WXDLLEXPORT_DATA(const wxChar
*) wxPanelNameStr
;
594 extern WXDLLEXPORT_DATA(const wxSize
) wxDefaultSize
;
595 extern WXDLLEXPORT_DATA(const wxPoint
) wxDefaultPosition
;
597 // The list of objects which should be deleted
598 extern WXDLLEXPORT_DATA(wxList
) wxPendingDelete
;
600 // ---------------------------------------------------------------------------
602 // ---------------------------------------------------------------------------
604 // resource management
605 extern void WXDLLEXPORT
wxInitializeStockObjects();
606 extern void WXDLLEXPORT
wxInitializeStockLists();
607 extern void WXDLLEXPORT
wxDeleteStockObjects();
608 extern void WXDLLEXPORT
wxDeleteStockLists();
610 // is the display colour (or monochrome)?
611 extern bool WXDLLEXPORT
wxColourDisplay();
613 // Returns depth of screen
614 extern int WXDLLEXPORT
wxDisplayDepth();
615 #define wxGetDisplayDepth wxDisplayDepth
617 // get the display size
618 extern void WXDLLEXPORT
wxDisplaySize(int *width
, int *height
);
619 extern wxSize WXDLLEXPORT
wxGetDisplaySize();
620 extern void WXDLLEXPORT
wxDisplaySizeMM(int *width
, int *height
);
621 extern wxSize WXDLLEXPORT
wxGetDisplaySizeMM();
623 // Get position and size of the display workarea
624 extern void WXDLLEXPORT
wxClientDisplayRect(int *x
, int *y
, int *width
, int *height
);
625 extern wxRect WXDLLEXPORT
wxGetClientDisplayRect();
628 extern void WXDLLEXPORT
wxSetCursor(const wxCursor
& cursor
);