1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Common GDI classes, types and declarations
4 // Author: Julian Smart
8 // Copyright: (c) Julian Smart
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
15 // ---------------------------------------------------------------------------
17 // ---------------------------------------------------------------------------
21 #include "wx/string.h"
22 #include "wx/fontenc.h"
23 #include "wx/hashmap.h"
26 // ---------------------------------------------------------------------------
27 // forward declarations
28 // ---------------------------------------------------------------------------
30 class WXDLLIMPEXP_FWD_CORE wxBitmap
;
31 class WXDLLIMPEXP_FWD_CORE wxBrush
;
32 class WXDLLIMPEXP_FWD_CORE wxColour
;
33 class WXDLLIMPEXP_FWD_CORE wxCursor
;
34 class WXDLLIMPEXP_FWD_CORE wxFont
;
35 class WXDLLIMPEXP_FWD_CORE wxIcon
;
36 class WXDLLIMPEXP_FWD_CORE wxPalette
;
37 class WXDLLIMPEXP_FWD_CORE wxPen
;
38 class WXDLLIMPEXP_FWD_CORE wxRegion
;
39 class WXDLLIMPEXP_FWD_BASE wxString
;
40 class WXDLLIMPEXP_FWD_CORE wxIconBundle
;
41 class WXDLLIMPEXP_FWD_CORE wxPoint
;
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
,
81 wxBITMAP_TYPE_MACCURSOR
,
82 wxBITMAP_TYPE_MACCURSOR_RESOURCE
,
85 wxBITMAP_TYPE_ANY
= 50
88 // Polygon filling mode
89 enum wxPolygonFillMode
98 wxCURSOR_NONE
, // should be 0
100 wxCURSOR_RIGHT_ARROW
,
106 wxCURSOR_LEFT_BUTTON
,
108 wxCURSOR_MIDDLE_BUTTON
,
110 wxCURSOR_PAINT_BRUSH
,
113 wxCURSOR_POINT_RIGHT
,
114 wxCURSOR_QUESTION_ARROW
,
115 wxCURSOR_RIGHT_BUTTON
,
126 wxCURSOR_DEFAULT
, // standard X11 cursor
129 wxCURSOR_COPY_ARROW
, // MacOS Theme Plus arrow
132 // Not yet implemented for Windows
133 wxCURSOR_CROSS_REVERSE
,
134 wxCURSOR_DOUBLE_ARROW
,
135 wxCURSOR_BASED_ARROW_UP
,
136 wxCURSOR_BASED_ARROW_DOWN
,
141 wxCURSOR_CLOSED_HAND
,
148 #define wxCURSOR_DEFAULT wxCURSOR_ARROW
152 // TODO CS supply openhand and closedhand cursors
153 #define wxCURSOR_OPEN_HAND wxCURSOR_HAND
154 #define wxCURSOR_CLOSED_HAND wxCURSOR_HAND
157 // ---------------------------------------------------------------------------
159 // ---------------------------------------------------------------------------
161 /* Useful macro for creating icons portably, for example:
163 wxIcon *icon = new wxICON(mondrian);
167 wxIcon *icon = new wxIcon("mondrian"); // On wxMSW
168 wxIcon *icon = new wxIcon(mondrian_xpm); // On wxGTK
172 // Load from a resource
173 #define wxICON(X) wxIcon(wxT(#X))
174 #elif defined(__WXPM__)
175 // Load from a resource
176 #define wxICON(X) wxIcon(wxT(#X))
177 #elif defined(__WXMGL__)
178 // Initialize from an included XPM
179 #define wxICON(X) wxIcon( X##_xpm )
180 #elif defined(__WXDFB__)
181 // Initialize from an included XPM
182 #define wxICON(X) wxIcon( X##_xpm )
183 #elif defined(__WXGTK__)
184 // Initialize from an included XPM
185 #define wxICON(X) wxIcon( X##_xpm )
186 #elif defined(__WXMAC__)
187 // Initialize from an included XPM
188 #define wxICON(X) wxIcon( X##_xpm )
189 #elif defined(__WXMOTIF__)
190 // Initialize from an included XPM
191 #define wxICON(X) wxIcon( X##_xpm )
192 #elif defined(__WXX11__)
193 // Initialize from an included XPM
194 #define wxICON(X) wxIcon( X##_xpm )
196 // This will usually mean something on any platform
197 #define wxICON(X) wxIcon(wxT(#X))
200 /* Another macro: this one is for portable creation of bitmaps. We assume that
201 under Unix bitmaps live in XPMs and under Windows they're in ressources.
204 #if defined(__WXMSW__) || defined(__WXPM__)
205 #define wxBITMAP(name) wxBitmap(wxT(#name), wxBITMAP_TYPE_RESOURCE)
206 #elif defined(__WXGTK__) || \
207 defined(__WXMOTIF__) || \
208 defined(__WXX11__) || \
209 defined(__WXMAC__) || \
210 defined(__WXMGL__) || \
211 defined(__WXDFB__) || \
213 // Initialize from an included XPM
214 #define wxBITMAP(name) wxBitmap(name##_xpm)
215 #else // other platforms
216 #define wxBITMAP(name) wxBitmap(name##_xpm, wxBITMAP_TYPE_XPM)
219 // ===========================================================================
221 // ===========================================================================
223 // ---------------------------------------------------------------------------
225 // ---------------------------------------------------------------------------
227 class WXDLLIMPEXP_CORE wxSize
230 // members are public for compatibility, don't use them directly.
234 wxSize() : x(0), y(0) { }
235 wxSize(int xx
, int yy
) : x(xx
), y(yy
) { }
237 // no copy ctor or assignment operator - the defaults are ok
239 wxSize
& operator+=(const wxSize
& sz
) { x
+= sz
.x
; y
+= sz
.y
; return *this; }
240 wxSize
& operator-=(const wxSize
& sz
) { x
-= sz
.x
; y
-= sz
.y
; return *this; }
241 wxSize
& operator/=(int i
) { x
/= i
; y
/= i
; return *this; }
242 wxSize
& operator*=(int i
) { x
*= i
; y
*= i
; return *this; }
243 wxSize
& operator/=(unsigned int i
) { x
/= i
; y
/= i
; return *this; }
244 wxSize
& operator*=(unsigned int i
) { x
*= i
; y
*= i
; return *this; }
245 wxSize
& operator/=(long i
) { x
/= i
; y
/= i
; return *this; }
246 wxSize
& operator*=(long i
) { x
*= i
; y
*= i
; return *this; }
247 wxSize
& operator/=(unsigned long i
) { x
/= i
; y
/= i
; return *this; }
248 wxSize
& operator*=(unsigned long i
) { x
*= i
; y
*= i
; return *this; }
249 wxSize
& operator/=(double i
) { x
= int(x
/i
); y
= int(y
/i
); return *this; }
250 wxSize
& operator*=(double i
) { x
= int(x
*i
); y
= int(y
*i
); return *this; }
252 void IncTo(const wxSize
& sz
)
253 { if ( sz
.x
> x
) x
= sz
.x
; if ( sz
.y
> y
) y
= sz
.y
; }
254 void DecTo(const wxSize
& sz
)
255 { if ( sz
.x
< x
) x
= sz
.x
; if ( sz
.y
< y
) y
= sz
.y
; }
257 void IncBy(int dx
, int dy
) { x
+= dx
; y
+= dy
; }
258 void IncBy(const wxSize
& sz
) { IncBy(sz
.x
, sz
.y
); }
259 void IncBy(int d
) { IncBy(d
, d
); }
261 void DecBy(int dx
, int dy
) { IncBy(-dx
, -dy
); }
262 void DecBy(const wxSize
& sz
) { DecBy(sz
.x
, sz
.y
); }
263 void DecBy(int d
) { DecBy(d
, d
); }
266 wxSize
& Scale(float xscale
, float yscale
)
267 { x
= (int)(x
*xscale
); y
= (int)(y
*yscale
); return *this; }
270 void Set(int xx
, int yy
) { x
= xx
; y
= yy
; }
271 void SetWidth(int w
) { x
= w
; }
272 void SetHeight(int h
) { y
= h
; }
274 int GetWidth() const { return x
; }
275 int GetHeight() const { return y
; }
277 bool IsFullySpecified() const { return x
!= wxDefaultCoord
&& y
!= wxDefaultCoord
; }
279 // combine this size with the other one replacing the default (i.e. equal
280 // to wxDefaultCoord) components of this object with those of the other
281 void SetDefaults(const wxSize
& size
)
283 if ( x
== wxDefaultCoord
)
285 if ( y
== wxDefaultCoord
)
290 int GetX() const { return x
; }
291 int GetY() const { return y
; }
294 inline bool operator==(const wxSize
& s1
, const wxSize
& s2
)
296 return s1
.x
== s2
.x
&& s1
.y
== s2
.y
;
299 inline bool operator!=(const wxSize
& s1
, const wxSize
& s2
)
301 return s1
.x
!= s2
.x
|| s1
.y
!= s2
.y
;
304 inline wxSize
operator+(const wxSize
& s1
, const wxSize
& s2
)
306 return wxSize(s1
.x
+ s2
.x
, s1
.y
+ s2
.y
);
309 inline wxSize
operator-(const wxSize
& s1
, const wxSize
& s2
)
311 return wxSize(s1
.x
- s2
.x
, s1
.y
- s2
.y
);
314 inline wxSize
operator/(const wxSize
& s
, int i
)
316 return wxSize(s
.x
/ i
, s
.y
/ i
);
319 inline wxSize
operator*(const wxSize
& s
, int i
)
321 return wxSize(s
.x
* i
, s
.y
* i
);
324 inline wxSize
operator*(int i
, const wxSize
& s
)
326 return wxSize(s
.x
* i
, s
.y
* i
);
329 inline wxSize
operator/(const wxSize
& s
, unsigned int i
)
331 return wxSize(s
.x
/ i
, s
.y
/ i
);
334 inline wxSize
operator*(const wxSize
& s
, unsigned int i
)
336 return wxSize(s
.x
* i
, s
.y
* i
);
339 inline wxSize
operator*(unsigned int i
, const wxSize
& s
)
341 return wxSize(s
.x
* i
, s
.y
* i
);
344 inline wxSize
operator/(const wxSize
& s
, long i
)
346 return wxSize(s
.x
/ i
, s
.y
/ i
);
349 inline wxSize
operator*(const wxSize
& s
, long i
)
351 return wxSize(s
.x
* i
, s
.y
* i
);
354 inline wxSize
operator*(long i
, const wxSize
& s
)
356 return wxSize(s
.x
* i
, s
.y
* i
);
359 inline wxSize
operator/(const wxSize
& s
, unsigned long i
)
361 return wxSize(s
.x
/ i
, s
.y
/ i
);
364 inline wxSize
operator*(const wxSize
& s
, unsigned long i
)
366 return wxSize(s
.x
* i
, s
.y
* i
);
369 inline wxSize
operator*(unsigned long i
, const wxSize
& s
)
371 return wxSize(s
.x
* i
, s
.y
* i
);
374 inline wxSize
operator*(const wxSize
& s
, double i
)
376 return wxSize(int(s
.x
* i
), int(s
.y
* i
));
379 inline wxSize
operator*(double i
, const wxSize
& s
)
381 return wxSize(int(s
.x
* i
), int(s
.y
* i
));
386 // ---------------------------------------------------------------------------
387 // Point classes: with real or integer coordinates
388 // ---------------------------------------------------------------------------
390 class WXDLLIMPEXP_CORE wxRealPoint
396 wxRealPoint() : x(0.0), y(0.0) { }
397 wxRealPoint(double xx
, double yy
) : x(xx
), y(yy
) { }
401 inline bool operator==(const wxRealPoint
& p1
, const wxRealPoint
& p2
)
403 return wxIsSameDouble(p1
.x
, p2
.x
) && wxIsSameDouble(p1
.y
, p2
.y
);
407 inline bool operator!=(const wxRealPoint
& p1
, const wxRealPoint
& p2
)
413 inline wxRealPoint
operator+(const wxRealPoint
& p1
, const wxRealPoint
& p2
)
415 return wxRealPoint(p1
.x
+ p2
.x
, p1
.y
+ p2
.y
);
419 inline wxRealPoint
operator-(const wxRealPoint
& p1
, const wxRealPoint
& p2
)
421 return wxRealPoint(p1
.x
- p2
.x
, p1
.y
- p2
.y
);
425 // ----------------------------------------------------------------------------
426 // wxPoint: 2D point with integer coordinates
427 // ----------------------------------------------------------------------------
429 class WXDLLIMPEXP_CORE wxPoint
434 wxPoint() : x(0), y(0) { }
435 wxPoint(int xx
, int yy
) : x(xx
), y(yy
) { }
437 // no copy ctor or assignment operator - the defaults are ok
439 //assignment operators
440 wxPoint
& operator+=(const wxPoint
& p
) { x
+= p
.x
; y
+= p
.y
; return *this; }
441 wxPoint
& operator-=(const wxPoint
& p
) { x
-= p
.x
; y
-= p
.y
; return *this; }
443 wxPoint
& operator+=(const wxSize
& s
) { x
+= s
.GetWidth(); y
+= s
.GetHeight(); return *this; }
444 wxPoint
& operator-=(const wxSize
& s
) { x
-= s
.GetWidth(); y
-= s
.GetHeight(); return *this; }
449 inline bool operator==(const wxPoint
& p1
, const wxPoint
& p2
)
451 return p1
.x
== p2
.x
&& p1
.y
== p2
.y
;
454 inline bool operator!=(const wxPoint
& p1
, const wxPoint
& p2
)
460 // arithmetic operations (component wise)
461 inline wxPoint
operator+(const wxPoint
& p1
, const wxPoint
& p2
)
463 return wxPoint(p1
.x
+ p2
.x
, p1
.y
+ p2
.y
);
466 inline wxPoint
operator-(const wxPoint
& p1
, const wxPoint
& p2
)
468 return wxPoint(p1
.x
- p2
.x
, p1
.y
- p2
.y
);
471 inline wxPoint
operator+(const wxPoint
& p
, const wxSize
& s
)
473 return wxPoint(p
.x
+ s
.x
, p
.y
+ s
.y
);
476 inline wxPoint
operator-(const wxPoint
& p
, const wxSize
& s
)
478 return wxPoint(p
.x
- s
.x
, p
.y
- s
.y
);
481 inline wxPoint
operator+(const wxSize
& s
, const wxPoint
& p
)
483 return wxPoint(p
.x
+ s
.x
, p
.y
+ s
.y
);
486 inline wxPoint
operator-(const wxSize
& s
, const wxPoint
& p
)
488 return wxPoint(s
.x
- p
.x
, s
.y
- p
.y
);
491 inline wxPoint
operator-(const wxPoint
& p
)
493 return wxPoint(-p
.x
, -p
.y
);
496 WX_DECLARE_LIST_WITH_DECL(wxPoint
, wxPointList
, class WXDLLIMPEXP_CORE
);
498 // ---------------------------------------------------------------------------
500 // ---------------------------------------------------------------------------
502 class WXDLLIMPEXP_CORE wxRect
506 : x(0), y(0), width(0), height(0)
508 wxRect(int xx
, int yy
, int ww
, int hh
)
509 : x(xx
), y(yy
), width(ww
), height(hh
)
511 wxRect(const wxPoint
& topLeft
, const wxPoint
& bottomRight
);
512 wxRect(const wxPoint
& pt
, const wxSize
& size
)
513 : x(pt
.x
), y(pt
.y
), width(size
.x
), height(size
.y
)
515 wxRect(const wxSize
& size
)
516 : x(0), y(0), width(size
.x
), height(size
.y
)
519 // default copy ctor and assignment operators ok
521 int GetX() const { return x
; }
522 void SetX(int xx
) { x
= xx
; }
524 int GetY() const { return y
; }
525 void SetY(int yy
) { y
= yy
; }
527 int GetWidth() const { return width
; }
528 void SetWidth(int w
) { width
= w
; }
530 int GetHeight() const { return height
; }
531 void SetHeight(int h
) { height
= h
; }
533 wxPoint
GetPosition() const { return wxPoint(x
, y
); }
534 void SetPosition( const wxPoint
&p
) { x
= p
.x
; y
= p
.y
; }
536 wxSize
GetSize() const { return wxSize(width
, height
); }
537 void SetSize( const wxSize
&s
) { width
= s
.GetWidth(); height
= s
.GetHeight(); }
539 bool IsEmpty() const { return (width
<= 0) || (height
<= 0); }
541 int GetLeft() const { return x
; }
542 int GetTop() const { return y
; }
543 int GetBottom() const { return y
+ height
- 1; }
544 int GetRight() const { return x
+ width
- 1; }
546 void SetLeft(int left
) { x
= left
; }
547 void SetRight(int right
) { width
= right
- x
+ 1; }
548 void SetTop(int top
) { y
= top
; }
549 void SetBottom(int bottom
) { height
= bottom
- y
+ 1; }
551 wxPoint
GetTopLeft() const { return GetPosition(); }
552 wxPoint
GetLeftTop() const { return GetTopLeft(); }
553 void SetTopLeft(const wxPoint
&p
) { SetPosition(p
); }
554 void SetLeftTop(const wxPoint
&p
) { SetTopLeft(p
); }
556 wxPoint
GetBottomRight() const { return wxPoint(GetRight(), GetBottom()); }
557 wxPoint
GetRightBottom() const { return GetBottomRight(); }
558 void SetBottomRight(const wxPoint
&p
) { SetRight(p
.x
); SetBottom(p
.y
); }
559 void SetRightBottom(const wxPoint
&p
) { SetBottomRight(p
); }
561 wxPoint
GetTopRight() const { return wxPoint(GetRight(), GetTop()); }
562 wxPoint
GetRightTop() const { return GetTopRight(); }
563 void SetTopRight(const wxPoint
&p
) { SetRight(p
.x
); SetTop(p
.y
); }
564 void SetRightTop(const wxPoint
&p
) { SetTopLeft(p
); }
566 wxPoint
GetBottomLeft() const { return wxPoint(GetLeft(), GetBottom()); }
567 wxPoint
GetLeftBottom() const { return GetBottomLeft(); }
568 void SetBottomLeft(const wxPoint
&p
) { SetLeft(p
.x
); SetBottom(p
.y
); }
569 void SetLeftBottom(const wxPoint
&p
) { SetBottomLeft(p
); }
571 // operations with rect
572 wxRect
& Inflate(wxCoord dx
, wxCoord dy
);
573 wxRect
& Inflate(const wxSize
& d
) { return Inflate(d
.x
, d
.y
); }
574 wxRect
& Inflate(wxCoord d
) { return Inflate(d
, d
); }
575 wxRect
Inflate(wxCoord dx
, wxCoord dy
) const
582 wxRect
& Deflate(wxCoord dx
, wxCoord dy
) { return Inflate(-dx
, -dy
); }
583 wxRect
& Deflate(const wxSize
& d
) { return Inflate(-d
.x
, -d
.y
); }
584 wxRect
& Deflate(wxCoord d
) { return Inflate(-d
); }
585 wxRect
Deflate(wxCoord dx
, wxCoord dy
) const
592 void Offset(wxCoord dx
, wxCoord dy
) { x
+= dx
; y
+= dy
; }
593 void Offset(const wxPoint
& pt
) { Offset(pt
.x
, pt
.y
); }
595 wxRect
& Intersect(const wxRect
& rect
);
596 wxRect
Intersect(const wxRect
& rect
) const
603 wxRect
& Union(const wxRect
& rect
);
604 wxRect
Union(const wxRect
& rect
) const
611 // return true if the point is (not strcitly) inside the rect
612 bool Contains(int x
, int y
) const;
613 bool Contains(const wxPoint
& pt
) const { return Contains(pt
.x
, pt
.y
); }
614 // return true if the rectangle 'rect' is (not strictly) inside this rect
615 bool Contains(const wxRect
& rect
) const;
617 #if WXWIN_COMPATIBILITY_2_6
618 // use Contains() instead
619 wxDEPRECATED( bool Inside(int x
, int y
) const );
620 wxDEPRECATED( bool Inside(const wxPoint
& pt
) const );
621 wxDEPRECATED( bool Inside(const wxRect
& rect
) const );
622 #endif // WXWIN_COMPATIBILITY_2_6
624 // return true if the rectangles have a non empty intersection
625 bool Intersects(const wxRect
& rect
) const;
627 // like Union() but don't ignore empty rectangles
628 wxRect
& operator+=(const wxRect
& rect
);
630 // intersections of two rectrangles not testing for empty rectangles
631 wxRect
& operator*=(const wxRect
& rect
);
633 // centre this rectangle in the given (usually, but not necessarily,
635 wxRect
CentreIn(const wxRect
& r
, int dir
= wxBOTH
) const
637 return wxRect(dir
& wxHORIZONTAL
? r
.x
+ (r
.width
- width
)/2 : x
,
638 dir
& wxVERTICAL
? r
.y
+ (r
.height
- height
)/2 : y
,
642 wxRect
CenterIn(const wxRect
& r
, int dir
= wxBOTH
) const
644 return CentreIn(r
, dir
);
648 int x
, y
, width
, height
;
652 // compare rectangles
653 inline bool operator==(const wxRect
& r1
, const wxRect
& r2
)
655 return (r1
.x
== r2
.x
) && (r1
.y
== r2
.y
) &&
656 (r1
.width
== r2
.width
) && (r1
.height
== r2
.height
);
659 inline bool operator!=(const wxRect
& r1
, const wxRect
& r2
)
664 // like Union() but don't treat empty rectangles specially
665 WXDLLIMPEXP_CORE wxRect
operator+(const wxRect
& r1
, const wxRect
& r2
);
667 // intersections of two rectangles
668 WXDLLIMPEXP_CORE wxRect
operator*(const wxRect
& r1
, const wxRect
& r2
);
673 #if WXWIN_COMPATIBILITY_2_6
674 inline bool wxRect::Inside(int cx
, int cy
) const { return Contains(cx
, cy
); }
675 inline bool wxRect::Inside(const wxPoint
& pt
) const { return Contains(pt
); }
676 inline bool wxRect::Inside(const wxRect
& rect
) const { return Contains(rect
); }
677 #endif // WXWIN_COMPATIBILITY_2_6
680 // ---------------------------------------------------------------------------
681 // Management of pens, brushes and fonts
682 // ---------------------------------------------------------------------------
684 typedef wxInt8 wxDash
;
686 class WXDLLIMPEXP_CORE wxGDIObjListBase
{
695 WX_DECLARE_STRING_HASH_MAP(wxColour
*, wxStringToColourHashMap
);
697 class WXDLLIMPEXP_CORE wxColourDatabase
703 // find colour by name or name for the given colour
704 wxColour
Find(const wxString
& name
) const;
705 wxString
FindName(const wxColour
& colour
) const;
707 // add a new colour to the database
708 void AddColour(const wxString
& name
, const wxColour
& colour
);
710 #if WXWIN_COMPATIBILITY_2_6
711 // deprecated, use Find() instead
712 wxDEPRECATED( wxColour
*FindColour(const wxString
& name
) );
713 #endif // WXWIN_COMPATIBILITY_2_6
717 // PM keeps its own type of colour table
723 // load the database with the built in colour values when called for the
724 // first time, do nothing after this
727 wxStringToColourHashMap
*m_map
;
730 class WXDLLIMPEXP_CORE wxResourceCache
: public wxList
733 wxResourceCache() { }
735 wxResourceCache(const unsigned int keyType
) : wxList(keyType
) { }
737 virtual ~wxResourceCache();
740 // ---------------------------------------------------------------------------
742 // ---------------------------------------------------------------------------
747 wxStockGDI creates the stock GDI objects on demand. Pointers to the
748 created objects are stored in the ms_stockObject array, which is indexed
749 by the Item enum values. Platorm-specific fonts can be created by
750 implementing a derived class with an override for the GetFont function.
751 wxStockGDI operates as a singleton, accessed through the ms_instance
752 pointer. By default this pointer is set to an instance of wxStockGDI.
753 A derived class must arrange to set this pointer to an instance of itself.
755 class WXDLLIMPEXP_CORE wxStockGDI
798 virtual ~wxStockGDI();
799 static void DeleteAll();
801 static wxStockGDI
& instance() { return *ms_instance
; }
803 static const wxBrush
* GetBrush(Item item
);
804 static const wxColour
* GetColour(Item item
);
805 static const wxCursor
* GetCursor(Item item
);
806 // Can be overridden by platform-specific derived classes
807 virtual const wxFont
* GetFont(Item item
);
808 static const wxPen
* GetPen(Item item
);
811 static wxStockGDI
* ms_instance
;
813 static wxObject
* ms_stockObject
[ITEMCOUNT
];
815 wxDECLARE_NO_COPY_CLASS(wxStockGDI
);
818 #define wxITALIC_FONT wxStockGDI::instance().GetFont(wxStockGDI::FONT_ITALIC)
819 #define wxNORMAL_FONT wxStockGDI::instance().GetFont(wxStockGDI::FONT_NORMAL)
820 #define wxSMALL_FONT wxStockGDI::instance().GetFont(wxStockGDI::FONT_SMALL)
821 #define wxSWISS_FONT wxStockGDI::instance().GetFont(wxStockGDI::FONT_SWISS)
823 #define wxBLACK_DASHED_PEN wxStockGDI::GetPen(wxStockGDI::PEN_BLACKDASHED)
824 #define wxBLACK_PEN wxStockGDI::GetPen(wxStockGDI::PEN_BLACK)
825 #define wxBLUE_PEN wxStockGDI::GetPen(wxStockGDI::PEN_BLUE)
826 #define wxCYAN_PEN wxStockGDI::GetPen(wxStockGDI::PEN_CYAN)
827 #define wxGREEN_PEN wxStockGDI::GetPen(wxStockGDI::PEN_GREEN)
828 #define wxGREY_PEN wxStockGDI::GetPen(wxStockGDI::PEN_GREY)
829 #define wxLIGHT_GREY_PEN wxStockGDI::GetPen(wxStockGDI::PEN_LIGHTGREY)
830 #define wxMEDIUM_GREY_PEN wxStockGDI::GetPen(wxStockGDI::PEN_MEDIUMGREY)
831 #define wxRED_PEN wxStockGDI::GetPen(wxStockGDI::PEN_RED)
832 #define wxTRANSPARENT_PEN wxStockGDI::GetPen(wxStockGDI::PEN_TRANSPARENT)
833 #define wxWHITE_PEN wxStockGDI::GetPen(wxStockGDI::PEN_WHITE)
835 #define wxBLACK_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_BLACK)
836 #define wxBLUE_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_BLUE)
837 #define wxCYAN_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_CYAN)
838 #define wxGREEN_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_GREEN)
839 #define wxGREY_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_GREY)
840 #define wxLIGHT_GREY_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_LIGHTGREY)
841 #define wxMEDIUM_GREY_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_MEDIUMGREY)
842 #define wxRED_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_RED)
843 #define wxTRANSPARENT_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_TRANSPARENT)
844 #define wxWHITE_BRUSH wxStockGDI::GetBrush(wxStockGDI::BRUSH_WHITE)
846 #define wxBLACK wxStockGDI::GetColour(wxStockGDI::COLOUR_BLACK)
847 #define wxBLUE wxStockGDI::GetColour(wxStockGDI::COLOUR_BLUE)
848 #define wxCYAN wxStockGDI::GetColour(wxStockGDI::COLOUR_CYAN)
849 #define wxGREEN wxStockGDI::GetColour(wxStockGDI::COLOUR_GREEN)
850 #define wxLIGHT_GREY wxStockGDI::GetColour(wxStockGDI::COLOUR_LIGHTGREY)
851 #define wxRED wxStockGDI::GetColour(wxStockGDI::COLOUR_RED)
852 #define wxWHITE wxStockGDI::GetColour(wxStockGDI::COLOUR_WHITE)
854 #define wxCROSS_CURSOR wxStockGDI::GetCursor(wxStockGDI::CURSOR_CROSS)
855 #define wxHOURGLASS_CURSOR wxStockGDI::GetCursor(wxStockGDI::CURSOR_HOURGLASS)
856 #define wxSTANDARD_CURSOR wxStockGDI::GetCursor(wxStockGDI::CURSOR_STANDARD)
859 extern WXDLLIMPEXP_DATA_CORE(wxBitmap
) wxNullBitmap
;
860 extern WXDLLIMPEXP_DATA_CORE(wxIcon
) wxNullIcon
;
861 extern WXDLLIMPEXP_DATA_CORE(wxCursor
) wxNullCursor
;
862 extern WXDLLIMPEXP_DATA_CORE(wxPen
) wxNullPen
;
863 extern WXDLLIMPEXP_DATA_CORE(wxBrush
) wxNullBrush
;
864 extern WXDLLIMPEXP_DATA_CORE(wxPalette
) wxNullPalette
;
865 extern WXDLLIMPEXP_DATA_CORE(wxFont
) wxNullFont
;
866 extern WXDLLIMPEXP_DATA_CORE(wxColour
) wxNullColour
;
867 extern WXDLLIMPEXP_DATA_CORE(wxIconBundle
) wxNullIconBundle
;
869 extern WXDLLIMPEXP_DATA_CORE(wxColourDatabase
*) wxTheColourDatabase
;
871 extern WXDLLIMPEXP_DATA_CORE(const char) wxPanelNameStr
[];
873 extern WXDLLIMPEXP_DATA_CORE(const wxSize
) wxDefaultSize
;
874 extern WXDLLIMPEXP_DATA_CORE(const wxPoint
) wxDefaultPosition
;
876 // ---------------------------------------------------------------------------
878 // ---------------------------------------------------------------------------
880 // resource management
881 extern void WXDLLIMPEXP_CORE
wxInitializeStockLists();
882 extern void WXDLLIMPEXP_CORE
wxDeleteStockLists();
884 // is the display colour (or monochrome)?
885 extern bool WXDLLIMPEXP_CORE
wxColourDisplay();
887 // Returns depth of screen
888 extern int WXDLLIMPEXP_CORE
wxDisplayDepth();
889 #define wxGetDisplayDepth wxDisplayDepth
891 // get the display size
892 extern void WXDLLIMPEXP_CORE
wxDisplaySize(int *width
, int *height
);
893 extern wxSize WXDLLIMPEXP_CORE
wxGetDisplaySize();
894 extern void WXDLLIMPEXP_CORE
wxDisplaySizeMM(int *width
, int *height
);
895 extern wxSize WXDLLIMPEXP_CORE
wxGetDisplaySizeMM();
896 extern wxSize WXDLLIMPEXP_CORE
wxGetDisplayPPI();
898 // Get position and size of the display workarea
899 extern void WXDLLIMPEXP_CORE
wxClientDisplayRect(int *x
, int *y
, int *width
, int *height
);
900 extern wxRect WXDLLIMPEXP_CORE
wxGetClientDisplayRect();
903 extern void WXDLLIMPEXP_CORE
wxSetCursor(const wxCursor
& cursor
);