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"
28 // ---------------------------------------------------------------------------
29 // forward declarations
30 // ---------------------------------------------------------------------------
32 class WXDLLEXPORT wxBitmap
;
33 class WXDLLEXPORT wxBrush
;
34 class WXDLLEXPORT wxColour
;
35 class WXDLLEXPORT wxCursor
;
36 class WXDLLEXPORT wxFont
;
37 class WXDLLEXPORT wxIcon
;
38 class WXDLLEXPORT wxPalette
;
39 class WXDLLEXPORT wxPen
;
40 class WXDLLEXPORT wxRegion
;
41 class WXDLLEXPORT wxString
;
43 // ---------------------------------------------------------------------------
45 // ---------------------------------------------------------------------------
50 wxBITMAP_TYPE_INVALID
, // should be == 0 for compatibility!
52 wxBITMAP_TYPE_BMP_RESOURCE
,
53 wxBITMAP_TYPE_RESOURCE
= wxBITMAP_TYPE_BMP_RESOURCE
,
55 wxBITMAP_TYPE_ICO_RESOURCE
,
57 wxBITMAP_TYPE_CUR_RESOURCE
,
59 wxBITMAP_TYPE_XBM_DATA
,
61 wxBITMAP_TYPE_XPM_DATA
,
63 wxBITMAP_TYPE_TIF_RESOURCE
,
65 wxBITMAP_TYPE_GIF_RESOURCE
,
67 wxBITMAP_TYPE_PNG_RESOURCE
,
69 wxBITMAP_TYPE_JPEG_RESOURCE
,
71 wxBITMAP_TYPE_PNM_RESOURCE
,
73 wxBITMAP_TYPE_PCX_RESOURCE
,
75 wxBITMAP_TYPE_PICT_RESOURCE
,
77 wxBITMAP_TYPE_ICON_RESOURCE
,
80 wxBITMAP_TYPE_MACCURSOR
,
81 wxBITMAP_TYPE_MACCURSOR_RESOURCE
,
82 wxBITMAP_TYPE_ANY
= 50
88 wxCURSOR_NONE
, // should be 0
98 wxCURSOR_MIDDLE_BUTTON
,
100 wxCURSOR_PAINT_BRUSH
,
103 wxCURSOR_POINT_RIGHT
,
104 wxCURSOR_QUESTION_ARROW
,
105 wxCURSOR_RIGHT_BUTTON
,
116 wxCURSOR_DEFAULT
, // standard X11 cursor
119 wxCURSOR_COPY_ARROW
, // MacOS Theme Plus arrow
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(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 )
174 // This will usually mean something on any platform
175 #define wxICON(X) wxIcon(wxT(#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(wxT(#name), wxBITMAP_TYPE_RESOURCE)
184 #elif defined(__WXGTK__) || defined(__WXMOTIF__) || defined(__WXX11__) || defined(__WXMAC__) || defined(__WXMGL__) || defined(__WXCOCOA__)
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.
206 wxSize() : x(0), y(0) { }
207 wxSize(int xx
, int yy
) : x(xx
), y(yy
) { }
209 // no copy ctor or assignment operator - the defaults are ok
211 bool operator==(const wxSize
& sz
) const { return x
== sz
.x
&& y
== sz
.y
; }
212 bool operator!=(const wxSize
& sz
) const { return x
!= sz
.x
|| y
!= sz
.y
; }
214 // FIXME are these really useful? If they're, we should have += &c as well
215 wxSize
operator+(const wxSize
& sz
) { return wxSize(x
+ sz
.x
, y
+ sz
.y
); }
216 wxSize
operator-(const wxSize
& sz
) { return wxSize(x
- sz
.x
, y
- sz
.y
); }
218 void IncTo(const wxSize
& sz
)
219 { if ( sz
.x
> x
) x
= sz
.x
; if ( sz
.y
> y
) y
= sz
.y
; }
220 void DecTo(const wxSize
& sz
)
221 { if ( sz
.x
< x
) x
= sz
.x
; if ( sz
.y
< y
) y
= sz
.y
; }
224 void Set(int xx
, int yy
) { x
= xx
; y
= yy
; }
225 void SetWidth(int w
) { x
= w
; }
226 void SetHeight(int h
) { y
= h
; }
228 int GetWidth() const { return x
; }
229 int GetHeight() const { return y
; }
231 bool IsFullySpecified() const { return x
!= -1 && y
!= -1; }
233 // combine this size with the other one replacing the default (i.e. equal
234 // to -1) components of this object with those of the other
235 void SetDefaults(const wxSize
& size
)
244 int GetX() const { return x
; }
245 int GetY() const { return y
; }
248 // ---------------------------------------------------------------------------
249 // Point classes: with real or integer coordinates
250 // ---------------------------------------------------------------------------
252 class WXDLLEXPORT wxRealPoint
258 wxRealPoint() : x(0.0), y(0.0) { }
259 wxRealPoint(double xx
, double yy
) : x(xx
), y(yy
) { }
261 wxRealPoint
operator+(const wxRealPoint
& pt
) const { return wxRealPoint(x
+ pt
.x
, y
+ pt
.y
); }
262 wxRealPoint
operator-(const wxRealPoint
& pt
) const { return wxRealPoint(x
- pt
.x
, y
- pt
.y
); }
264 bool operator==(const wxRealPoint
& pt
) const { return x
== pt
.x
&& y
== pt
.y
; }
265 bool operator!=(const wxRealPoint
& pt
) const { return x
!= pt
.x
|| y
!= pt
.y
; }
268 class WXDLLEXPORT wxPoint
273 wxPoint() : x(0), y(0) { }
274 wxPoint(int xx
, int yy
) : x(xx
), y(yy
) { }
276 // no copy ctor or assignment operator - the defaults are ok
279 bool operator==(const wxPoint
& p
) const { return x
== p
.x
&& y
== p
.y
; }
280 bool operator!=(const wxPoint
& p
) const { return !(*this == p
); }
282 // arithmetic operations (component wise)
283 wxPoint
operator+(const wxPoint
& p
) const { return wxPoint(x
+ p
.x
, y
+ p
.y
); }
284 wxPoint
operator-(const wxPoint
& p
) const { return wxPoint(x
- p
.x
, y
- p
.y
); }
286 wxPoint
& operator+=(const wxPoint
& p
) { x
+= p
.x
; y
+= p
.y
; return *this; }
287 wxPoint
& operator-=(const wxPoint
& p
) { x
-= p
.x
; y
-= p
.y
; return *this; }
289 wxPoint
& operator+=(const wxSize
& s
) { x
+= s
.GetWidth(); y
+= s
.GetHeight(); return *this; }
290 wxPoint
& operator-=(const wxSize
& s
) { x
-= s
.GetWidth(); y
-= s
.GetHeight(); return *this; }
292 wxPoint
operator+(const wxSize
& s
) const { return wxPoint(x
+ s
.GetWidth(), y
+ s
.GetHeight()); }
293 wxPoint
operator-(const wxSize
& s
) const { return wxPoint(x
- s
.GetWidth(), y
- s
.GetHeight()); }
296 // ---------------------------------------------------------------------------
298 // ---------------------------------------------------------------------------
300 class WXDLLEXPORT wxRect
304 : x(0), y(0), width(0), height(0)
306 wxRect(int xx
, int yy
, int ww
, int hh
)
307 : x(xx
), y(yy
), width(ww
), height(hh
)
309 wxRect(const wxPoint
& topLeft
, const wxPoint
& bottomRight
);
310 wxRect(const wxPoint
& pos
, const wxSize
& size
);
312 // default copy ctor and assignment operators ok
314 int GetX() const { return x
; }
315 void SetX(int xx
) { x
= xx
; }
317 int GetY() const { return y
; }
318 void SetY(int yy
) { y
= yy
; }
320 int GetWidth() const { return width
; }
321 void SetWidth(int w
) { width
= w
; }
323 int GetHeight() const { return height
; }
324 void SetHeight(int h
) { height
= h
; }
326 wxPoint
GetPosition() const { return wxPoint(x
, y
); }
327 void SetPosition( const wxPoint
&p
) { x
= p
.x
; y
= p
.y
; }
329 wxSize
GetSize() const { return wxSize(width
, height
); }
330 void SetSize( const wxSize
&s
) { width
= s
.GetWidth(); height
= s
.GetHeight(); }
332 wxPoint
GetTopLeft() const { return GetPosition(); }
333 wxPoint
GetLeftTop() const { return GetTopLeft(); }
334 void SetTopLeft(const wxPoint
&p
) { SetPosition(p
); }
335 void SetLeftTop(const wxPoint
&p
) { SetTopLeft(p
); }
337 wxPoint
GetBottomRight() const { return wxPoint(GetRight(), GetBottom()); }
338 wxPoint
GetRightBottom() const { return GetBottomRight(); }
339 void SetBottomRight(const wxPoint
&p
) { SetRight(p
.x
); SetBottom(p
.y
); }
340 void SetRightBottom(const wxPoint
&p
) { SetBottomRight(p
); }
342 int GetLeft() const { return x
; }
343 int GetTop() const { return y
; }
344 int GetBottom() const { return y
+ height
- 1; }
345 int GetRight() const { return x
+ width
- 1; }
347 void SetLeft(int left
) { x
= left
; }
348 void SetRight(int right
) { width
= right
- x
+ 1; }
349 void SetTop(int top
) { y
= top
; }
350 void SetBottom(int bottom
) { height
= bottom
- y
+ 1; }
352 // operations with rect
353 wxRect
& Inflate(wxCoord dx
, wxCoord dy
);
354 wxRect
& Inflate(wxCoord d
) { return Inflate(d
, d
); }
355 wxRect
Inflate(wxCoord dx
, wxCoord dy
) const
362 wxRect
& Deflate(wxCoord dx
, wxCoord dy
) { return Inflate(-dx
, -dy
); }
363 wxRect
& Deflate(wxCoord d
) { return Inflate(-d
); }
364 wxRect
Deflate(wxCoord dx
, wxCoord dy
) const
371 void Offset(wxCoord dx
, wxCoord dy
) { x
+= dx
; y
+= dy
; }
372 void Offset(const wxPoint
& pt
) { Offset(pt
.x
, pt
.y
); }
374 wxRect
& Intersect(const wxRect
& rect
);
375 wxRect
Intersect(const wxRect
& rect
) const
382 wxRect
operator+(const wxRect
& rect
) const;
383 wxRect
& operator+=(const wxRect
& rect
);
385 // compare rectangles
386 bool operator==(const wxRect
& rect
) const;
387 bool operator!=(const wxRect
& rect
) const { return !(*this == rect
); }
389 // return TRUE if the point is (not strcitly) inside the rect
390 bool Inside(int x
, int y
) const;
391 bool Inside(const wxPoint
& pt
) const { return Inside(pt
.x
, pt
.y
); }
393 // return TRUE if the rectangles have a non empty intersection
394 bool Intersects(const wxRect
& rect
) const;
397 int x
, y
, width
, height
;
400 // ---------------------------------------------------------------------------
401 // Management of pens, brushes and fonts
402 // ---------------------------------------------------------------------------
404 typedef wxInt8 wxDash
;
406 class WXDLLEXPORT wxPenList
: public wxList
412 void AddPen(wxPen
*pen
);
413 void RemovePen(wxPen
*pen
);
414 wxPen
*FindOrCreatePen(const wxColour
& colour
, int width
, int style
);
417 class WXDLLEXPORT wxBrushList
: public wxList
423 void AddBrush(wxBrush
*brush
);
424 void RemoveBrush(wxBrush
*brush
);
425 wxBrush
*FindOrCreateBrush(const wxColour
& colour
, int style
);
428 class WXDLLEXPORT wxFontList
: public wxList
434 void AddFont(wxFont
*font
);
435 void RemoveFont(wxFont
*font
);
436 wxFont
*FindOrCreateFont(int pointSize
, int family
, int style
, int weight
,
437 bool underline
= FALSE
,
438 const wxString
& face
= wxEmptyString
,
439 wxFontEncoding encoding
= wxFONTENCODING_DEFAULT
);
442 class WXDLLEXPORT wxStringToColourHashMap
;
444 class WXDLLEXPORT wxColourDatabase
450 // find colour by name or name for the given colour
451 wxColour
Find(const wxString
& name
) const;
452 wxString
FindName(const wxColour
& colour
) const;
454 // add a new colour to the database
455 void AddColour(const wxString
& name
, const wxColour
& colour
);
457 // deprecated, use Find() instead
458 wxDEPRECATED( wxColour
*FindColour(const wxString
& name
) );
462 // PM keeps its own type of colour table
468 // load the database with the built in colour values when called for the
469 // first time, do nothing after this
472 wxStringToColourHashMap
*m_map
;
475 class WXDLLEXPORT wxBitmapList
: public wxList
481 void AddBitmap(wxBitmap
*bitmap
);
482 void RemoveBitmap(wxBitmap
*bitmap
);
485 class WXDLLEXPORT wxResourceCache
: public wxList
488 wxResourceCache() { }
490 wxResourceCache(const unsigned int keyType
) : wxList(keyType
) { }
495 // ---------------------------------------------------------------------------
497 // ---------------------------------------------------------------------------
499 // Lists of GDI objects
500 WXDLLEXPORT_DATA(extern wxPenList
*) wxThePenList
;
501 WXDLLEXPORT_DATA(extern wxBrushList
*) wxTheBrushList
;
502 WXDLLEXPORT_DATA(extern wxFontList
*) wxTheFontList
;
503 WXDLLEXPORT_DATA(extern wxBitmapList
*) wxTheBitmapList
;
506 WXDLLEXPORT_DATA(extern wxFont
*) wxNORMAL_FONT
;
507 WXDLLEXPORT_DATA(extern wxFont
*) wxSMALL_FONT
;
508 WXDLLEXPORT_DATA(extern wxFont
*) wxITALIC_FONT
;
509 WXDLLEXPORT_DATA(extern wxFont
*) wxSWISS_FONT
;
511 WXDLLEXPORT_DATA(extern wxPen
*) wxRED_PEN
;
512 WXDLLEXPORT_DATA(extern wxPen
*) wxCYAN_PEN
;
513 WXDLLEXPORT_DATA(extern wxPen
*) wxGREEN_PEN
;
514 WXDLLEXPORT_DATA(extern wxPen
*) wxBLACK_PEN
;
515 WXDLLEXPORT_DATA(extern wxPen
*) wxWHITE_PEN
;
516 WXDLLEXPORT_DATA(extern wxPen
*) wxTRANSPARENT_PEN
;
517 WXDLLEXPORT_DATA(extern wxPen
*) wxBLACK_DASHED_PEN
;
518 WXDLLEXPORT_DATA(extern wxPen
*) wxGREY_PEN
;
519 WXDLLEXPORT_DATA(extern wxPen
*) wxMEDIUM_GREY_PEN
;
520 WXDLLEXPORT_DATA(extern wxPen
*) wxLIGHT_GREY_PEN
;
522 WXDLLEXPORT_DATA(extern wxBrush
*) wxBLUE_BRUSH
;
523 WXDLLEXPORT_DATA(extern wxBrush
*) wxGREEN_BRUSH
;
524 WXDLLEXPORT_DATA(extern wxBrush
*) wxWHITE_BRUSH
;
525 WXDLLEXPORT_DATA(extern wxBrush
*) wxBLACK_BRUSH
;
526 WXDLLEXPORT_DATA(extern wxBrush
*) wxGREY_BRUSH
;
527 WXDLLEXPORT_DATA(extern wxBrush
*) wxMEDIUM_GREY_BRUSH
;
528 WXDLLEXPORT_DATA(extern wxBrush
*) wxLIGHT_GREY_BRUSH
;
529 WXDLLEXPORT_DATA(extern wxBrush
*) wxTRANSPARENT_BRUSH
;
530 WXDLLEXPORT_DATA(extern wxBrush
*) wxCYAN_BRUSH
;
531 WXDLLEXPORT_DATA(extern wxBrush
*) wxRED_BRUSH
;
533 WXDLLEXPORT_DATA(extern wxColour
*) wxBLACK
;
534 WXDLLEXPORT_DATA(extern wxColour
*) wxWHITE
;
535 WXDLLEXPORT_DATA(extern wxColour
*) wxRED
;
536 WXDLLEXPORT_DATA(extern wxColour
*) wxBLUE
;
537 WXDLLEXPORT_DATA(extern wxColour
*) wxGREEN
;
538 WXDLLEXPORT_DATA(extern wxColour
*) wxCYAN
;
539 WXDLLEXPORT_DATA(extern wxColour
*) wxLIGHT_GREY
;
542 WXDLLEXPORT_DATA(extern wxBitmap
) wxNullBitmap
;
543 WXDLLEXPORT_DATA(extern wxIcon
) wxNullIcon
;
544 WXDLLEXPORT_DATA(extern wxCursor
) wxNullCursor
;
545 WXDLLEXPORT_DATA(extern wxPen
) wxNullPen
;
546 WXDLLEXPORT_DATA(extern wxBrush
) wxNullBrush
;
547 WXDLLEXPORT_DATA(extern wxPalette
) wxNullPalette
;
548 WXDLLEXPORT_DATA(extern wxFont
) wxNullFont
;
549 WXDLLEXPORT_DATA(extern wxColour
) wxNullColour
;
551 // Stock cursors types
552 WXDLLEXPORT_DATA(extern wxCursor
*) wxSTANDARD_CURSOR
;
553 WXDLLEXPORT_DATA(extern wxCursor
*) wxHOURGLASS_CURSOR
;
554 WXDLLEXPORT_DATA(extern wxCursor
*) wxCROSS_CURSOR
;
556 WXDLLEXPORT_DATA(extern wxColourDatabase
*) wxTheColourDatabase
;
558 WXDLLEXPORT_DATA(extern const wxChar
*) wxPanelNameStr
;
560 WXDLLEXPORT_DATA(extern const wxSize
) wxDefaultSize
;
561 WXDLLEXPORT_DATA(extern const wxPoint
) wxDefaultPosition
;
563 // The list of objects which should be deleted
564 WXDLLEXPORT_DATA(extern wxList
) wxPendingDelete
;
566 // ---------------------------------------------------------------------------
568 // ---------------------------------------------------------------------------
570 // resource management
571 extern void WXDLLEXPORT
wxInitializeStockObjects();
572 extern void WXDLLEXPORT
wxInitializeStockLists();
573 extern void WXDLLEXPORT
wxDeleteStockObjects();
574 extern void WXDLLEXPORT
wxDeleteStockLists();
576 // is the display colour (or monochrome)?
577 extern bool WXDLLEXPORT
wxColourDisplay();
579 // Returns depth of screen
580 extern int WXDLLEXPORT
wxDisplayDepth();
581 #define wxGetDisplayDepth wxDisplayDepth
583 // get the display size
584 extern void WXDLLEXPORT
wxDisplaySize(int *width
, int *height
);
585 extern wxSize WXDLLEXPORT
wxGetDisplaySize();
586 extern void WXDLLEXPORT
wxDisplaySizeMM(int *width
, int *height
);
587 extern wxSize WXDLLEXPORT
wxGetDisplaySizeMM();
589 // Get position and size of the display workarea
590 extern void WXDLLEXPORT
wxClientDisplayRect(int *x
, int *y
, int *width
, int *height
);
591 extern wxRect WXDLLEXPORT
wxGetClientDisplayRect();
594 extern void WXDLLEXPORT
wxSetCursor(const wxCursor
& cursor
);