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
,
81 wxBITMAP_TYPE_MACCURSOR
,
82 wxBITMAP_TYPE_MACCURSOR_RESOURCE
,
83 wxBITMAP_TYPE_ANY
= 50
89 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 // Not yet implemented for Windows
120 wxCURSOR_CROSS_REVERSE
,
121 wxCURSOR_DOUBLE_ARROW
,
122 wxCURSOR_BASED_ARROW_UP
,
123 wxCURSOR_BASED_ARROW_DOWN
,
132 #define wxCURSOR_DEFAULT wxCURSOR_ARROW
135 // ---------------------------------------------------------------------------
137 // ---------------------------------------------------------------------------
139 /* Useful macro for creating icons portably, for example:
141 wxIcon *icon = new wxICON(mondrian);
145 wxIcon *icon = new wxIcon("mondrian"); // On wxMSW
146 wxIcon *icon = new wxIcon(mondrian_xpm); // On wxGTK
150 // Load from a resource
151 #define wxICON(X) wxIcon("" #X "")
152 #elif defined(__WXPM__)
153 // Load from a resource
154 #define wxICON(X) wxIcon("" #X "")
155 #elif defined(__WXMGL__)
156 // Load from a resource
157 #define wxICON(X) wxIcon("" #X "")
158 #elif defined(__WXGTK__)
159 // Initialize from an included XPM
160 #define wxICON(X) wxIcon( (const char**) X##_xpm )
161 #elif defined(__WXMOTIF__)
162 // Initialize from an included XPM
163 #define wxICON(X) wxIcon( X##_xpm )
165 // This will usually mean something on any platform
166 #define wxICON(X) wxIcon("" #X "")
169 /* Another macro: this one is for portable creation of bitmaps. We assume that
170 under Unix bitmaps live in XPMs and under Windows they're in ressources.
173 #if defined(__WXMSW__) || defined(__WXPM__) || defined(__WXMGL__)
174 #define wxBITMAP(name) wxBitmap(#name, wxBITMAP_TYPE_RESOURCE)
175 #elif defined(__WXGTK__) || defined(__WXMOTIF__) || defined(__WXMAC__)
176 // Initialize from an included XPM
177 #define wxBITMAP(name) wxBitmap( (const char**) name##_xpm )
178 #else // other platforms
179 #define wxBITMAP(name) wxBitmap(name##_xpm, wxBITMAP_TYPE_XPM)
182 // ===========================================================================
184 // ===========================================================================
186 // ---------------------------------------------------------------------------
188 // ---------------------------------------------------------------------------
190 class WXDLLEXPORT wxSize
193 // members are public for compatibility (don't use them directly,
194 // especially that there names were chosen very unfortunately - they should
195 // have been called width and height)
199 wxSize() { x
= y
= 0; }
200 wxSize(int xx
, int yy
) { Set(xx
, yy
); }
202 // no copy ctor or assignment operator - the defaults are ok
204 bool operator==(const wxSize
& sz
) const { return x
== sz
.x
&& y
== sz
.y
; }
205 bool operator!=(const wxSize
& sz
) const { return x
!= sz
.x
|| y
!= sz
.y
; }
207 // FIXME are these really useful? If they're, we should have += &c as well
208 wxSize
operator+(const wxSize
& sz
) { return wxSize(x
+ sz
.x
, y
+ sz
.y
); }
209 wxSize
operator-(const wxSize
& sz
) { return wxSize(x
- sz
.x
, y
- sz
.y
); }
212 void Set(int xx
, int yy
) { x
= xx
; y
= yy
; }
213 void SetWidth(int w
) { x
= w
; }
214 void SetHeight(int h
) { y
= h
; }
216 int GetWidth() const { return x
; }
217 int GetHeight() const { return y
; }
220 int GetX() const { return x
; }
221 int GetY() const { return y
; }
224 // ---------------------------------------------------------------------------
225 // Point classes: with real or integer coordinates
226 // ---------------------------------------------------------------------------
228 class WXDLLEXPORT wxRealPoint
234 wxRealPoint() { x
= y
= 0.0; };
235 wxRealPoint(double xx
, double yy
) { x
= xx
; y
= yy
; };
237 wxRealPoint
operator+(const wxRealPoint
& pt
) const { return wxRealPoint(x
+ pt
.x
, y
+ pt
.y
); }
238 wxRealPoint
operator-(const wxRealPoint
& pt
) const { return wxRealPoint(x
- pt
.x
, y
- pt
.y
); }
240 bool operator==(const wxRealPoint
& pt
) const { return x
== pt
.x
&& y
== pt
.y
; }
243 class WXDLLEXPORT wxPoint
248 wxPoint() { x
= y
= 0; };
249 wxPoint(int xx
, int yy
) { x
= xx
; y
= yy
; };
251 // no copy ctor or assignment operator - the defaults are ok
254 bool operator==(const wxPoint
& p
) const { return x
== p
.x
&& y
== p
.y
; }
255 bool operator!=(const wxPoint
& p
) const { return !(*this == p
); }
257 // arithmetic operations (component wise)
258 wxPoint
operator+(const wxPoint
& p
) const { return wxPoint(x
+ p
.x
, y
+ p
.y
); }
259 wxPoint
operator-(const wxPoint
& p
) const { return wxPoint(x
- p
.x
, y
- p
.y
); }
261 wxPoint
& operator+=(const wxPoint
& p
) { x
+= p
.x
; y
+= p
.y
; return *this; }
262 wxPoint
& operator-=(const wxPoint
& p
) { x
-= p
.x
; y
-= p
.y
; return *this; }
265 #if WXWIN_COMPATIBILITY
266 #define wxIntPoint wxPoint
267 #define wxRectangle wxRect
268 #endif // WXWIN_COMPATIBILITY
270 // ---------------------------------------------------------------------------
272 // ---------------------------------------------------------------------------
274 class WXDLLEXPORT wxRect
277 wxRect() { x
= y
= width
= height
= 0; }
278 wxRect(int xx
, int yy
, int ww
, int hh
)
279 { x
= xx
; y
= yy
; width
= ww
; height
= hh
; }
280 wxRect(const wxPoint
& topLeft
, const wxPoint
& bottomRight
);
281 wxRect(const wxPoint
& pos
, const wxSize
& size
);
283 // default copy ctor and assignment operators ok
285 int GetX() const { return x
; }
286 void SetX(int xx
) { x
= xx
; }
288 int GetY() const { return y
; }
289 void SetY(int yy
) { y
= yy
; }
291 int GetWidth() const { return width
; }
292 void SetWidth(int w
) { width
= w
; }
294 int GetHeight() const { return height
; }
295 void SetHeight(int h
) { height
= h
; }
297 wxPoint
GetPosition() const { return wxPoint(x
, y
); }
298 wxSize
GetSize() const { return wxSize(width
, height
); }
300 int GetLeft() const { return x
; }
301 int GetTop() const { return y
; }
302 int GetBottom() const { return y
+ height
- 1; }
303 int GetRight() const { return x
+ width
- 1; }
305 void SetLeft(int left
) { x
= left
; }
306 void SetRight(int right
) { width
= right
- x
+ 1; }
307 void SetTop(int top
) { y
= top
; }
308 void SetBottom(int bottom
) { height
= bottom
- y
+ 1; }
310 // operations with rect
311 wxRect
& Inflate(wxCoord dx
, wxCoord dy
);
312 wxRect
& Inflate(wxCoord d
) { return Inflate(d
, d
); }
313 wxRect
Inflate(wxCoord dx
, wxCoord dy
) const
320 wxRect
& Deflate(wxCoord dx
, wxCoord dy
) { return Inflate(-dx
, -dy
); }
321 wxRect
& Deflate(wxCoord d
) { return Inflate(-d
); }
322 wxRect
Deflate(wxCoord dx
, wxCoord dy
) const
329 void Offset(wxCoord dx
, wxCoord dy
) { x
+= dx
; y
+= dy
; }
330 void Offset(const wxPoint
& pt
) { Offset(pt
.x
, pt
.y
); }
332 wxRect
& Intersect(const wxRect
& rect
);
333 wxRect
Intersect(const wxRect
& rect
) const
340 wxRect
operator+(const wxRect
& rect
) const;
341 wxRect
& operator+=(const wxRect
& rect
);
343 // compare rectangles
344 bool operator==(const wxRect
& rect
) const;
345 bool operator!=(const wxRect
& rect
) const { return !(*this == rect
); }
347 // return TRUE if the point is (not strcitly) inside the rect
348 bool Inside(int x
, int y
) const;
349 bool Inside(const wxPoint
& pt
) const { return Inside(pt
.x
, pt
.y
); }
351 // return TRUE if the rectangles have a non empty intersection
352 bool Intersects(const wxRect
& rect
) const;
355 int x
, y
, width
, height
;
358 // ---------------------------------------------------------------------------
359 // Management of pens, brushes and fonts
360 // ---------------------------------------------------------------------------
362 typedef wxInt8 wxDash
;
364 class WXDLLEXPORT wxPenList
: public wxList
366 DECLARE_DYNAMIC_CLASS(wxPenList
)
372 void AddPen(wxPen
*pen
);
373 void RemovePen(wxPen
*pen
);
374 wxPen
*FindOrCreatePen(const wxColour
& colour
, int width
, int style
);
377 class WXDLLEXPORT wxBrushList
: public wxList
379 DECLARE_DYNAMIC_CLASS(wxBrushList
)
385 void AddBrush(wxBrush
*brush
);
386 void RemoveBrush(wxBrush
*brush
);
387 wxBrush
*FindOrCreateBrush(const wxColour
& colour
, int style
);
390 WXDLLEXPORT_DATA(extern const wxChar
*) wxEmptyString
;
392 class WXDLLEXPORT wxFontList
: public wxList
394 DECLARE_DYNAMIC_CLASS(wxFontList
)
400 void AddFont(wxFont
*font
);
401 void RemoveFont(wxFont
*font
);
402 wxFont
*FindOrCreateFont(int pointSize
, int family
, int style
, int weight
,
403 bool underline
= FALSE
,
404 const wxString
& face
= wxEmptyString
,
405 wxFontEncoding encoding
= wxFONTENCODING_DEFAULT
);
408 class WXDLLEXPORT wxColourDatabase
: public wxList
410 DECLARE_CLASS(wxColourDatabase
)
413 wxColourDatabase(int type
);
414 ~wxColourDatabase() ;
416 // Not const because it may add a name to the database
417 wxColour
*FindColour(const wxString
& colour
) ;
418 wxString
FindName(const wxColour
& colour
) const;
421 // PM keeps its own type of colour table
427 class WXDLLEXPORT wxBitmapList
: public wxList
429 DECLARE_DYNAMIC_CLASS(wxBitmapList
)
435 void AddBitmap(wxBitmap
*bitmap
);
436 void RemoveBitmap(wxBitmap
*bitmap
);
439 class WXDLLEXPORT wxResourceCache
: public wxList
442 wxResourceCache() { }
443 wxResourceCache(const unsigned int keyType
) : wxList(keyType
) { }
447 DECLARE_DYNAMIC_CLASS(wxResourceCache
)
450 // ---------------------------------------------------------------------------
452 // ---------------------------------------------------------------------------
454 // Lists of GDI objects
455 WXDLLEXPORT_DATA(extern wxPenList
*) wxThePenList
;
456 WXDLLEXPORT_DATA(extern wxBrushList
*) wxTheBrushList
;
457 WXDLLEXPORT_DATA(extern wxFontList
*) wxTheFontList
;
458 WXDLLEXPORT_DATA(extern wxBitmapList
*) wxTheBitmapList
;
461 WXDLLEXPORT_DATA(extern wxFont
*) wxNORMAL_FONT
;
462 WXDLLEXPORT_DATA(extern wxFont
*) wxSMALL_FONT
;
463 WXDLLEXPORT_DATA(extern wxFont
*) wxITALIC_FONT
;
464 WXDLLEXPORT_DATA(extern wxFont
*) wxSWISS_FONT
;
466 WXDLLEXPORT_DATA(extern wxPen
*) wxRED_PEN
;
467 WXDLLEXPORT_DATA(extern wxPen
*) wxCYAN_PEN
;
468 WXDLLEXPORT_DATA(extern wxPen
*) wxGREEN_PEN
;
469 WXDLLEXPORT_DATA(extern wxPen
*) wxBLACK_PEN
;
470 WXDLLEXPORT_DATA(extern wxPen
*) wxWHITE_PEN
;
471 WXDLLEXPORT_DATA(extern wxPen
*) wxTRANSPARENT_PEN
;
472 WXDLLEXPORT_DATA(extern wxPen
*) wxBLACK_DASHED_PEN
;
473 WXDLLEXPORT_DATA(extern wxPen
*) wxGREY_PEN
;
474 WXDLLEXPORT_DATA(extern wxPen
*) wxMEDIUM_GREY_PEN
;
475 WXDLLEXPORT_DATA(extern wxPen
*) wxLIGHT_GREY_PEN
;
477 WXDLLEXPORT_DATA(extern wxBrush
*) wxBLUE_BRUSH
;
478 WXDLLEXPORT_DATA(extern wxBrush
*) wxGREEN_BRUSH
;
479 WXDLLEXPORT_DATA(extern wxBrush
*) wxWHITE_BRUSH
;
480 WXDLLEXPORT_DATA(extern wxBrush
*) wxBLACK_BRUSH
;
481 WXDLLEXPORT_DATA(extern wxBrush
*) wxGREY_BRUSH
;
482 WXDLLEXPORT_DATA(extern wxBrush
*) wxMEDIUM_GREY_BRUSH
;
483 WXDLLEXPORT_DATA(extern wxBrush
*) wxLIGHT_GREY_BRUSH
;
484 WXDLLEXPORT_DATA(extern wxBrush
*) wxTRANSPARENT_BRUSH
;
485 WXDLLEXPORT_DATA(extern wxBrush
*) wxCYAN_BRUSH
;
486 WXDLLEXPORT_DATA(extern wxBrush
*) wxRED_BRUSH
;
488 WXDLLEXPORT_DATA(extern wxColour
*) wxBLACK
;
489 WXDLLEXPORT_DATA(extern wxColour
*) wxWHITE
;
490 WXDLLEXPORT_DATA(extern wxColour
*) wxRED
;
491 WXDLLEXPORT_DATA(extern wxColour
*) wxBLUE
;
492 WXDLLEXPORT_DATA(extern wxColour
*) wxGREEN
;
493 WXDLLEXPORT_DATA(extern wxColour
*) wxCYAN
;
494 WXDLLEXPORT_DATA(extern wxColour
*) wxLIGHT_GREY
;
497 WXDLLEXPORT_DATA(extern wxBitmap
) wxNullBitmap
;
498 WXDLLEXPORT_DATA(extern wxIcon
) wxNullIcon
;
499 WXDLLEXPORT_DATA(extern wxCursor
) wxNullCursor
;
500 WXDLLEXPORT_DATA(extern wxPen
) wxNullPen
;
501 WXDLLEXPORT_DATA(extern wxBrush
) wxNullBrush
;
502 WXDLLEXPORT_DATA(extern wxPalette
) wxNullPalette
;
503 WXDLLEXPORT_DATA(extern wxFont
) wxNullFont
;
504 WXDLLEXPORT_DATA(extern wxColour
) wxNullColour
;
506 // Stock cursors types
507 WXDLLEXPORT_DATA(extern wxCursor
*) wxSTANDARD_CURSOR
;
508 WXDLLEXPORT_DATA(extern wxCursor
*) wxHOURGLASS_CURSOR
;
509 WXDLLEXPORT_DATA(extern wxCursor
*) wxCROSS_CURSOR
;
511 WXDLLEXPORT_DATA(extern wxColourDatabase
*) wxTheColourDatabase
;
513 WXDLLEXPORT_DATA(extern const wxChar
*) wxPanelNameStr
;
515 WXDLLEXPORT_DATA(extern const wxSize
) wxDefaultSize
;
516 WXDLLEXPORT_DATA(extern const wxPoint
) wxDefaultPosition
;
518 // The list of objects which should be deleted
519 WXDLLEXPORT_DATA(extern wxList
) wxPendingDelete
;
521 // ---------------------------------------------------------------------------
523 // ---------------------------------------------------------------------------
525 // resource management
526 extern void WXDLLEXPORT
wxInitializeStockObjects();
527 extern void WXDLLEXPORT
wxInitializeStockLists();
528 extern void WXDLLEXPORT
wxDeleteStockObjects();
529 extern void WXDLLEXPORT
wxDeleteStockLists();
531 // is the display colour (or monochrome)?
532 extern bool WXDLLEXPORT
wxColourDisplay();
534 // Returns depth of screen
535 extern int WXDLLEXPORT
wxDisplayDepth();
536 #define wxGetDisplayDepth wxDisplayDepth
538 // get the display size
539 extern void WXDLLEXPORT
wxDisplaySize(int *width
, int *height
);
540 extern wxSize WXDLLEXPORT
wxGetDisplaySize();
541 extern void WXDLLEXPORT
wxDisplaySizeMM(int *width
, int *height
);
542 extern wxSize WXDLLEXPORT
wxGetDisplaySizeMM();
544 // Get position and size of the display workarea
545 extern void WXDLLEXPORT
wxClientDisplayRect(int *x
, int *y
, int *width
, int *height
);
546 extern wxRect WXDLLEXPORT
wxGetClientDisplayRect();
549 extern void WXDLLEXPORT
wxSetCursor(const wxCursor
& cursor
);