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 // FIXME are these really useful? If they're, we should have += &c as well
221 wxSize
operator+(const wxSize
& sz
) { return wxSize(x
+ sz
.x
, y
+ sz
.y
); }
222 wxSize
operator-(const wxSize
& sz
) { return wxSize(x
- sz
.x
, y
- sz
.y
); }
224 void IncTo(const wxSize
& sz
)
225 { if ( sz
.x
> x
) x
= sz
.x
; if ( sz
.y
> y
) y
= sz
.y
; }
226 void DecTo(const wxSize
& sz
)
227 { if ( sz
.x
< x
) x
= sz
.x
; if ( sz
.y
< y
) y
= sz
.y
; }
230 void Set(int xx
, int yy
) { x
= xx
; y
= yy
; }
231 void SetWidth(int w
) { x
= w
; }
232 void SetHeight(int h
) { y
= h
; }
234 int GetWidth() const { return x
; }
235 int GetHeight() const { return y
; }
237 bool IsFullySpecified() const { return x
!= -1 && y
!= -1; }
239 // combine this size with the other one replacing the default (i.e. equal
240 // to -1) components of this object with those of the other
241 void SetDefaults(const wxSize
& size
)
250 int GetX() const { return x
; }
251 int GetY() const { return y
; }
254 // ---------------------------------------------------------------------------
255 // Point classes: with real or integer coordinates
256 // ---------------------------------------------------------------------------
258 class WXDLLEXPORT wxRealPoint
264 wxRealPoint() : x(0.0), y(0.0) { }
265 wxRealPoint(double xx
, double yy
) : x(xx
), y(yy
) { }
267 wxRealPoint
operator+(const wxRealPoint
& pt
) const { return wxRealPoint(x
+ pt
.x
, y
+ pt
.y
); }
268 wxRealPoint
operator-(const wxRealPoint
& pt
) const { return wxRealPoint(x
- pt
.x
, y
- pt
.y
); }
270 bool operator==(const wxRealPoint
& pt
) const { return x
== pt
.x
&& y
== pt
.y
; }
271 bool operator!=(const wxRealPoint
& pt
) const { return x
!= pt
.x
|| y
!= pt
.y
; }
274 class WXDLLEXPORT wxPoint
279 wxPoint() : x(0), y(0) { }
280 wxPoint(int xx
, int yy
) : x(xx
), y(yy
) { }
282 // no copy ctor or assignment operator - the defaults are ok
285 bool operator==(const wxPoint
& p
) const { return x
== p
.x
&& y
== p
.y
; }
286 bool operator!=(const wxPoint
& p
) const { return !(*this == p
); }
288 // arithmetic operations (component wise)
289 wxPoint
operator+(const wxPoint
& p
) const { return wxPoint(x
+ p
.x
, y
+ p
.y
); }
290 wxPoint
operator-(const wxPoint
& p
) const { return wxPoint(x
- p
.x
, y
- p
.y
); }
292 wxPoint
& operator+=(const wxPoint
& p
) { x
+= p
.x
; y
+= p
.y
; return *this; }
293 wxPoint
& operator-=(const wxPoint
& p
) { x
-= p
.x
; y
-= p
.y
; return *this; }
295 wxPoint
& operator+=(const wxSize
& s
) { x
+= s
.GetWidth(); y
+= s
.GetHeight(); return *this; }
296 wxPoint
& operator-=(const wxSize
& s
) { x
-= s
.GetWidth(); y
-= s
.GetHeight(); return *this; }
298 wxPoint
operator+(const wxSize
& s
) const { return wxPoint(x
+ s
.GetWidth(), y
+ s
.GetHeight()); }
299 wxPoint
operator-(const wxSize
& s
) const { return wxPoint(x
- s
.GetWidth(), y
- s
.GetHeight()); }
302 // ---------------------------------------------------------------------------
304 // ---------------------------------------------------------------------------
306 class WXDLLEXPORT wxRect
310 : x(0), y(0), width(0), height(0)
312 wxRect(int xx
, int yy
, int ww
, int hh
)
313 : x(xx
), y(yy
), width(ww
), height(hh
)
315 wxRect(const wxPoint
& topLeft
, const wxPoint
& bottomRight
);
316 wxRect(const wxPoint
& pos
, const wxSize
& size
);
318 // default copy ctor and assignment operators ok
320 int GetX() const { return x
; }
321 void SetX(int xx
) { x
= xx
; }
323 int GetY() const { return y
; }
324 void SetY(int yy
) { y
= yy
; }
326 int GetWidth() const { return width
; }
327 void SetWidth(int w
) { width
= w
; }
329 int GetHeight() const { return height
; }
330 void SetHeight(int h
) { height
= h
; }
332 wxPoint
GetPosition() const { return wxPoint(x
, y
); }
333 void SetPosition( const wxPoint
&p
) { x
= p
.x
; y
= p
.y
; }
335 wxSize
GetSize() const { return wxSize(width
, height
); }
336 void SetSize( const wxSize
&s
) { width
= s
.GetWidth(); height
= s
.GetHeight(); }
338 wxPoint
GetTopLeft() const { return GetPosition(); }
339 wxPoint
GetLeftTop() const { return GetTopLeft(); }
340 void SetTopLeft(const wxPoint
&p
) { SetPosition(p
); }
341 void SetLeftTop(const wxPoint
&p
) { SetTopLeft(p
); }
343 wxPoint
GetBottomRight() const { return wxPoint(GetRight(), GetBottom()); }
344 wxPoint
GetRightBottom() const { return GetBottomRight(); }
345 void SetBottomRight(const wxPoint
&p
) { SetRight(p
.x
); SetBottom(p
.y
); }
346 void SetRightBottom(const wxPoint
&p
) { SetBottomRight(p
); }
348 int GetLeft() const { return x
; }
349 int GetTop() const { return y
; }
350 int GetBottom() const { return y
+ height
- 1; }
351 int GetRight() const { return x
+ width
- 1; }
353 void SetLeft(int left
) { x
= left
; }
354 void SetRight(int right
) { width
= right
- x
+ 1; }
355 void SetTop(int top
) { y
= top
; }
356 void SetBottom(int bottom
) { height
= bottom
- y
+ 1; }
358 // operations with rect
359 wxRect
& Inflate(wxCoord dx
, wxCoord dy
);
360 wxRect
& Inflate(wxCoord d
) { return Inflate(d
, d
); }
361 wxRect
Inflate(wxCoord dx
, wxCoord dy
) const
368 wxRect
& Deflate(wxCoord dx
, wxCoord dy
) { return Inflate(-dx
, -dy
); }
369 wxRect
& Deflate(wxCoord d
) { return Inflate(-d
); }
370 wxRect
Deflate(wxCoord dx
, wxCoord dy
) const
377 void Offset(wxCoord dx
, wxCoord dy
) { x
+= dx
; y
+= dy
; }
378 void Offset(const wxPoint
& pt
) { Offset(pt
.x
, pt
.y
); }
380 wxRect
& Intersect(const wxRect
& rect
);
381 wxRect
Intersect(const wxRect
& rect
) const
388 wxRect
operator+(const wxRect
& rect
) const;
389 wxRect
& operator+=(const wxRect
& rect
);
391 // compare rectangles
392 bool operator==(const wxRect
& rect
) const;
393 bool operator!=(const wxRect
& rect
) const { return !(*this == rect
); }
395 // return TRUE if the point is (not strcitly) inside the rect
396 bool Inside(int x
, int y
) const;
397 bool Inside(const wxPoint
& pt
) const { return Inside(pt
.x
, pt
.y
); }
399 // return TRUE if the rectangles have a non empty intersection
400 bool Intersects(const wxRect
& rect
) const;
403 int x
, y
, width
, height
;
406 // ---------------------------------------------------------------------------
407 // Management of pens, brushes and fonts
408 // ---------------------------------------------------------------------------
410 typedef wxInt8 wxDash
;
412 class WXDLLEXPORT wxPenList
: public wxList
418 void AddPen(wxPen
*pen
);
419 void RemovePen(wxPen
*pen
);
420 wxPen
*FindOrCreatePen(const wxColour
& colour
, int width
, int style
);
423 class WXDLLEXPORT wxBrushList
: public wxList
429 void AddBrush(wxBrush
*brush
);
430 void RemoveBrush(wxBrush
*brush
);
431 wxBrush
*FindOrCreateBrush(const wxColour
& colour
, int style
);
434 class WXDLLEXPORT wxFontList
: public wxList
440 void AddFont(wxFont
*font
);
441 void RemoveFont(wxFont
*font
);
442 wxFont
*FindOrCreateFont(int pointSize
, int family
, int style
, int weight
,
443 bool underline
= FALSE
,
444 const wxString
& face
= wxEmptyString
,
445 wxFontEncoding encoding
= wxFONTENCODING_DEFAULT
);
448 WX_DECLARE_STRING_HASH_MAP( wxColour
*, wxStringToColourHashMap
);
450 class WXDLLEXPORT wxColourDatabase
456 // find colour by name or name for the given colour
457 wxColour
Find(const wxString
& name
) const;
458 wxString
FindName(const wxColour
& colour
) const;
460 // add a new colour to the database
461 void AddColour(const wxString
& name
, const wxColour
& colour
);
463 // deprecated, use Find() instead
464 wxDEPRECATED( wxColour
*FindColour(const wxString
& name
) );
468 // PM keeps its own type of colour table
474 // load the database with the built in colour values when called for the
475 // first time, do nothing after this
478 wxStringToColourHashMap
*m_map
;
481 class WXDLLEXPORT wxBitmapList
: public wxList
487 void AddBitmap(wxBitmap
*bitmap
);
488 void RemoveBitmap(wxBitmap
*bitmap
);
491 class WXDLLEXPORT wxResourceCache
: public wxList
494 wxResourceCache() { }
496 wxResourceCache(const unsigned int keyType
) : wxList(keyType
) { }
501 // ---------------------------------------------------------------------------
503 // ---------------------------------------------------------------------------
505 // Lists of GDI objects
506 WXDLLEXPORT_DATA(extern wxPenList
*) wxThePenList
;
507 WXDLLEXPORT_DATA(extern wxBrushList
*) wxTheBrushList
;
508 WXDLLEXPORT_DATA(extern wxFontList
*) wxTheFontList
;
509 WXDLLEXPORT_DATA(extern wxBitmapList
*) wxTheBitmapList
;
512 WXDLLEXPORT_DATA(extern wxFont
*) wxNORMAL_FONT
;
513 WXDLLEXPORT_DATA(extern wxFont
*) wxSMALL_FONT
;
514 WXDLLEXPORT_DATA(extern wxFont
*) wxITALIC_FONT
;
515 WXDLLEXPORT_DATA(extern wxFont
*) wxSWISS_FONT
;
517 WXDLLEXPORT_DATA(extern wxPen
*) wxRED_PEN
;
518 WXDLLEXPORT_DATA(extern wxPen
*) wxCYAN_PEN
;
519 WXDLLEXPORT_DATA(extern wxPen
*) wxGREEN_PEN
;
520 WXDLLEXPORT_DATA(extern wxPen
*) wxBLACK_PEN
;
521 WXDLLEXPORT_DATA(extern wxPen
*) wxWHITE_PEN
;
522 WXDLLEXPORT_DATA(extern wxPen
*) wxTRANSPARENT_PEN
;
523 WXDLLEXPORT_DATA(extern wxPen
*) wxBLACK_DASHED_PEN
;
524 WXDLLEXPORT_DATA(extern wxPen
*) wxGREY_PEN
;
525 WXDLLEXPORT_DATA(extern wxPen
*) wxMEDIUM_GREY_PEN
;
526 WXDLLEXPORT_DATA(extern wxPen
*) wxLIGHT_GREY_PEN
;
528 WXDLLEXPORT_DATA(extern wxBrush
*) wxBLUE_BRUSH
;
529 WXDLLEXPORT_DATA(extern wxBrush
*) wxGREEN_BRUSH
;
530 WXDLLEXPORT_DATA(extern wxBrush
*) wxWHITE_BRUSH
;
531 WXDLLEXPORT_DATA(extern wxBrush
*) wxBLACK_BRUSH
;
532 WXDLLEXPORT_DATA(extern wxBrush
*) wxGREY_BRUSH
;
533 WXDLLEXPORT_DATA(extern wxBrush
*) wxMEDIUM_GREY_BRUSH
;
534 WXDLLEXPORT_DATA(extern wxBrush
*) wxLIGHT_GREY_BRUSH
;
535 WXDLLEXPORT_DATA(extern wxBrush
*) wxTRANSPARENT_BRUSH
;
536 WXDLLEXPORT_DATA(extern wxBrush
*) wxCYAN_BRUSH
;
537 WXDLLEXPORT_DATA(extern wxBrush
*) wxRED_BRUSH
;
539 WXDLLEXPORT_DATA(extern wxColour
*) wxBLACK
;
540 WXDLLEXPORT_DATA(extern wxColour
*) wxWHITE
;
541 WXDLLEXPORT_DATA(extern wxColour
*) wxRED
;
542 WXDLLEXPORT_DATA(extern wxColour
*) wxBLUE
;
543 WXDLLEXPORT_DATA(extern wxColour
*) wxGREEN
;
544 WXDLLEXPORT_DATA(extern wxColour
*) wxCYAN
;
545 WXDLLEXPORT_DATA(extern wxColour
*) wxLIGHT_GREY
;
548 WXDLLEXPORT_DATA(extern wxBitmap
) wxNullBitmap
;
549 WXDLLEXPORT_DATA(extern wxIcon
) wxNullIcon
;
550 WXDLLEXPORT_DATA(extern wxCursor
) wxNullCursor
;
551 WXDLLEXPORT_DATA(extern wxPen
) wxNullPen
;
552 WXDLLEXPORT_DATA(extern wxBrush
) wxNullBrush
;
553 WXDLLEXPORT_DATA(extern wxPalette
) wxNullPalette
;
554 WXDLLEXPORT_DATA(extern wxFont
) wxNullFont
;
555 WXDLLEXPORT_DATA(extern wxColour
) wxNullColour
;
557 // Stock cursors types
558 WXDLLEXPORT_DATA(extern wxCursor
*) wxSTANDARD_CURSOR
;
559 WXDLLEXPORT_DATA(extern wxCursor
*) wxHOURGLASS_CURSOR
;
560 WXDLLEXPORT_DATA(extern wxCursor
*) wxCROSS_CURSOR
;
562 WXDLLEXPORT_DATA(extern wxColourDatabase
*) wxTheColourDatabase
;
564 WXDLLEXPORT_DATA(extern const wxChar
*) wxPanelNameStr
;
566 WXDLLEXPORT_DATA(extern const wxSize
) wxDefaultSize
;
567 WXDLLEXPORT_DATA(extern const wxPoint
) wxDefaultPosition
;
569 // The list of objects which should be deleted
570 WXDLLEXPORT_DATA(extern wxList
) wxPendingDelete
;
572 // ---------------------------------------------------------------------------
574 // ---------------------------------------------------------------------------
576 // resource management
577 extern void WXDLLEXPORT
wxInitializeStockObjects();
578 extern void WXDLLEXPORT
wxInitializeStockLists();
579 extern void WXDLLEXPORT
wxDeleteStockObjects();
580 extern void WXDLLEXPORT
wxDeleteStockLists();
582 // is the display colour (or monochrome)?
583 extern bool WXDLLEXPORT
wxColourDisplay();
585 // Returns depth of screen
586 extern int WXDLLEXPORT
wxDisplayDepth();
587 #define wxGetDisplayDepth wxDisplayDepth
589 // get the display size
590 extern void WXDLLEXPORT
wxDisplaySize(int *width
, int *height
);
591 extern wxSize WXDLLEXPORT
wxGetDisplaySize();
592 extern void WXDLLEXPORT
wxDisplaySizeMM(int *width
, int *height
);
593 extern wxSize WXDLLEXPORT
wxGetDisplaySizeMM();
595 // Get position and size of the display workarea
596 extern void WXDLLEXPORT
wxClientDisplayRect(int *x
, int *y
, int *width
, int *height
);
597 extern wxRect WXDLLEXPORT
wxGetClientDisplayRect();
600 extern void WXDLLEXPORT
wxSetCursor(const wxCursor
& cursor
);