include/wx/gdicmn.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        gdicmn.h
   3 // Purpose:     Common GDI classes, types and declarations
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c)
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_GDICMNH__
  13 #define _WX_GDICMNH__
  14
  15 // ---------------------------------------------------------------------------
  16 // headers
  17 // ---------------------------------------------------------------------------
  18
  19 #ifdef __GNUG__
  20     #pragma interface "gdicmn.h"
  21 #endif
  22
  23 #include "wx/object.h"
  24 #include "wx/list.h"
  25 #include "wx/hash.h"
  26 #include "wx/string.h"
  27 #include "wx/setup.h"
  28 #include "wx/colour.h"
  29
  30 // ---------------------------------------------------------------------------
  31 // forward declarations
  32 // ---------------------------------------------------------------------------
  33
  34 class WXDLLEXPORT wxBitmap;
  35 class WXDLLEXPORT wxBrush;
  36 class WXDLLEXPORT wxColour;
  37 class WXDLLEXPORT wxCursor;
  38 class WXDLLEXPORT wxFont;
  39 class WXDLLEXPORT wxIcon;
  40 class WXDLLEXPORT wxPalette;
  41 class WXDLLEXPORT wxPen;
  42 class WXDLLEXPORT wxRegion;
  43 class WXDLLEXPORT wxString;
  44
  45 // ---------------------------------------------------------------------------
  46 // constants
  47 // ---------------------------------------------------------------------------
  48
  49 // Bitmap flags
  50 enum
  51 {
  52     wxBITMAP_TYPE_BMP = 1,
  53     wxBITMAP_TYPE_BMP_RESOURCE,
  54     wxBITMAP_TYPE_RESOURCE = wxBITMAP_TYPE_BMP_RESOURCE,
  55     wxBITMAP_TYPE_ICO,
  56     wxBITMAP_TYPE_ICO_RESOURCE,
  57     wxBITMAP_TYPE_CUR,
  58     wxBITMAP_TYPE_CUR_RESOURCE,
  59     wxBITMAP_TYPE_XBM,
  60     wxBITMAP_TYPE_XBM_DATA,
  61     wxBITMAP_TYPE_XPM,
  62     wxBITMAP_TYPE_XPM_DATA,
  63     wxBITMAP_TYPE_TIF,
  64     wxBITMAP_TYPE_TIF_RESOURCE,
  65     wxBITMAP_TYPE_GIF,
  66     wxBITMAP_TYPE_GIF_RESOURCE,
  67     wxBITMAP_TYPE_PNG,
  68     wxBITMAP_TYPE_PNG_RESOURCE,
  69     wxBITMAP_TYPE_JPEG,
  70     wxBITMAP_TYPE_JPEG_RESOURCE,
  71     wxBITMAP_TYPE_ANY = 50
  72 };
  73
  74 // Standard cursors
  75 enum wxStockCursor
  76 {
  77     wxCURSOR_NONE,          // should be 0
  78     wxCURSOR_ARROW,
  79     wxCURSOR_BULLSEYE,
  80     wxCURSOR_CHAR,
  81     wxCURSOR_CROSS,
  82     wxCURSOR_HAND,
  83     wxCURSOR_IBEAM,
  84     wxCURSOR_LEFT_BUTTON,
  85     wxCURSOR_MAGNIFIER,
  86     wxCURSOR_MIDDLE_BUTTON,
  87     wxCURSOR_NO_ENTRY,
  88     wxCURSOR_PAINT_BRUSH,
  89     wxCURSOR_PENCIL,
  90     wxCURSOR_POINT_LEFT,
  91     wxCURSOR_POINT_RIGHT,
  92     wxCURSOR_QUESTION_ARROW,
  93     wxCURSOR_RIGHT_BUTTON,
  94     wxCURSOR_SIZENESW,
  95     wxCURSOR_SIZENS,
  96     wxCURSOR_SIZENWSE,
  97     wxCURSOR_SIZEWE,
  98     wxCURSOR_SIZING,
  99     wxCURSOR_SPRAYCAN,
 100     wxCURSOR_WAIT,
 101     wxCURSOR_WATCH,
 102     wxCURSOR_BLANK,
 103 #ifdef __X__
 104     // Not yet implemented for Windows
 105     wxCURSOR_CROSS_REVERSE,
 106     wxCURSOR_DOUBLE_ARROW,
 107     wxCURSOR_BASED_ARROW_UP,
 108     wxCURSOR_BASED_ARROW_DOWN,
 109 #endif // X11
 110
 111     wxCURSOR_MAX
 112 };
 113
 114 // ---------------------------------------------------------------------------
 115 // macros
 116 // ---------------------------------------------------------------------------
 117
 118 /* Useful macro for creating icons portably, for example:
 119
 120     wxIcon *icon = new wxICON(mondrian);
 121
 122   expands into:
 123
 124     wxIcon *icon = new wxIcon("mondrian");      // On wxMSW
 125     wxIcon *icon = new wxIcon(mondrian_xpm);    // On wxGTK
 126  */
 127
 128 #ifdef __WXMSW__
 129     // Load from a resource
 130     #define wxICON(X) wxIcon("" #X "")
 131 #elif defined(__WXGTK__)
 132     // Initialize from an included XPM
 133     #define wxICON(X) wxIcon( (const char**) X##_xpm )
 134 #elif defined(__WXMOTIF__)
 135     // Initialize from an included XPM
 136     #define wxICON(X) wxIcon( X##_xpm )
 137 #else
 138     // This will usually mean something on any platform
 139     #define wxICON(X) wxIcon("" #X "")
 140 #endif // platform
 141
 142 // ===========================================================================
 143 // classes
 144 // ===========================================================================
 145
 146 // ---------------------------------------------------------------------------
 147 // wxSize
 148 // ---------------------------------------------------------------------------
 149 class WXDLLEXPORT wxSize
 150 {
 151 public:
 152     // members are public for compatibility (don't use them directly,
 153     // especially that there names were chosen very unfortunately - they should
 154     // have been called width and height)
 155     long x;
 156     long y;
 157
 158     // constructors
 159     wxSize() { x = y = 0; }
 160     wxSize(long xx, long yy) { Set(xx, yy); }
 161
 162     // no copy ctor or assignment operator - the defaults are ok
 163     bool operator==(const wxSize& sz) const { return x == sz.x && y == sz.y; }
 164
 165     // FIXME are these really useful? If they're, we should have += &c as well
 166     wxSize operator+(const wxSize& sz) { return wxSize(x + sz.x, y + sz.y); }
 167     wxSize operator-(const wxSize& sz) { return wxSize(x - sz.x, y - sz.y); }
 168
 169     // accessors
 170     void Set(long xx, long yy) { x = xx; y = yy; }
 171     void SetWidth(long w) { x = w; }
 172     void SetHeight(long h) { y = h; }
 173
 174     long GetWidth() const { return x; }
 175     long GetHeight() const { return y; }
 176
 177     // compatibility
 178     long GetX() const { return x; }
 179     long GetY() const { return y; }
 180 };
 181
 182 // ---------------------------------------------------------------------------
 183 // Point classes: with real or integer coordinates
 184 // ---------------------------------------------------------------------------
 185
 186 class WXDLLEXPORT wxRealPoint
 187 {
 188 public:
 189     double x;
 190     double y;
 191
 192     wxRealPoint() { x = y = 0.0; };
 193     wxRealPoint(double xx, double yy) { x = xx; y = yy; };
 194
 195     wxRealPoint operator+(const wxRealPoint& pt) { return wxRealPoint(x + pt.x, y + pt.y); }
 196     wxRealPoint operator-(const wxRealPoint& pt) { return wxRealPoint(x - pt.x, y - pt.y); }
 197
 198     bool operator==(const wxRealPoint& pt) const { return x == pt.x && y == pt.y; }
 199 };
 200
 201 class WXDLLEXPORT wxPoint
 202 {
 203 public:
 204 #if defined(__WXMSW__) && !defined(__WIN32__)
 205     int x;
 206     int y;
 207 #else
 208     long x;
 209     long y;
 210 #endif
 211
 212     wxPoint() { x = y = 0; };
 213     wxPoint(long xx, long yy) { x = xx; y = yy; };
 214
 215     // no copy ctor or assignment operator - the defaults are ok
 216
 217     // comparison
 218     bool operator==(const wxPoint& p) const { return x == p.x && y == p.y; }
 219     bool operator!=(const wxPoint& p) const { return !(*this == p); }
 220
 221     // arithmetic operations (component wise)
 222     wxPoint operator+(const wxPoint& p) { return wxPoint(x + p.x, y + p.y); }
 223     wxPoint operator-(const wxPoint& p) { return wxPoint(x - p.x, y - p.y); }
 224
 225     wxPoint& operator+=(const wxPoint& p) { x += p.x; y += p.y; return *this; }
 226     wxPoint& operator-=(const wxPoint& p) { x -= p.x; y -= p.y; return *this; }
 227 };
 228
 229 #if WXWIN_COMPATIBILITY
 230     #define wxIntPoint wxPoint
 231     #define wxRectangle wxRect
 232 #endif // WXWIN_COMPATIBILITY
 233
 234 // ---------------------------------------------------------------------------
 235 // wxRect
 236 // ---------------------------------------------------------------------------
 237
 238 class WXDLLEXPORT wxRect
 239 {
 240 public:
 241     wxRect() { x = y = width = height = 0; }
 242     wxRect(long xx, long yy, long ww, long hh)
 243         { x = xx; y = yy; width = ww; height = hh; }
 244     wxRect(const wxPoint& topLeft, const wxPoint& bottomRight);
 245     wxRect(const wxPoint& pos, const wxSize& size);
 246
 247     // default copy ctor and assignment operators ok
 248
 249     long GetX() const { return x; }
 250     void SetX(long xx) { x = xx; }
 251
 252     long GetY() const { return y; }
 253     void SetY(long yy) { y = yy; }
 254
 255     long GetWidth() const { return width; }
 256     void SetWidth(long w) { width = w; }
 257
 258     long GetHeight() const { return height; }
 259     void SetHeight(long h) { height = h; }
 260
 261     wxPoint GetPosition() const { return wxPoint(x, y); }
 262     wxSize GetSize() const { return wxSize(width, height); }
 263
 264     long GetLeft()   const { return x; }
 265     long GetTop()    const { return y; }
 266     long GetBottom() const { return y + height; }
 267     long GetRight()  const { return x + width; }
 268
 269
 270     bool operator==(const wxRect& rect) const;
 271     bool operator!=(const wxRect& rect) const { return !(*this == rect); }
 272
 273     bool Inside(int cx, int cy) const;
 274     wxRect operator + (const wxRect& rect) const;
 275     const wxRect& operator += (const wxRect& rect);
 276
 277 public:
 278     long x, y, width, height;
 279 };
 280
 281 // ---------------------------------------------------------------------------
 282 // Management of pens, brushes and fonts
 283 // ---------------------------------------------------------------------------
 284
 285 class WXDLLEXPORT wxPenList : public wxList
 286 {
 287     DECLARE_DYNAMIC_CLASS(wxPenList)
 288
 289 public:
 290     wxPenList() { }
 291     ~wxPenList();
 292
 293     void AddPen(wxPen *pen);
 294     void RemovePen(wxPen *pen);
 295     wxPen *FindOrCreatePen(const wxColour& colour, int width, int style);
 296 };
 297
 298 class WXDLLEXPORT wxBrushList : public wxList
 299 {
 300     DECLARE_DYNAMIC_CLASS(wxBrushList)
 301
 302 public:
 303     wxBrushList() { }
 304     ~wxBrushList();
 305
 306     void AddBrush(wxBrush *brush);
 307     void RemoveBrush(wxBrush *brush);
 308     wxBrush *FindOrCreateBrush(const wxColour& colour, int style);
 309 };
 310
 311 WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
 312
 313 class WXDLLEXPORT wxFontList : public wxList
 314 {
 315     DECLARE_DYNAMIC_CLASS(wxFontList)
 316
 317 public:
 318     wxFontList() { }
 319     ~wxFontList();
 320
 321     void AddFont(wxFont *font);
 322     void RemoveFont(wxFont *font);
 323     wxFont *FindOrCreateFont(int pointSize, int family, int style, int weight,
 324                              bool underline = FALSE,
 325                              const wxString& face = wxEmptyString);
 326 };
 327
 328 class WXDLLEXPORT wxColourDatabase : public wxList
 329 {
 330     DECLARE_CLASS(wxColourDatabase)
 331
 332 public:
 333     wxColourDatabase(int type);
 334     ~wxColourDatabase() ;
 335
 336     // Not const because it may add a name to the database
 337     wxColour *FindColour(const wxString& colour) ;
 338     wxString FindName(const wxColour& colour) const;
 339     void Initialize();
 340 };
 341
 342 class WXDLLEXPORT wxBitmapList : public wxList
 343 {
 344     DECLARE_DYNAMIC_CLASS(wxBitmapList)
 345
 346 public:
 347     wxBitmapList();
 348     ~wxBitmapList();
 349
 350     void AddBitmap(wxBitmap *bitmap);
 351     void RemoveBitmap(wxBitmap *bitmap);
 352 };
 353
 354 class WXDLLEXPORT wxResourceCache: public wxList
 355 {
 356 public:
 357     wxResourceCache() { }
 358     wxResourceCache(const unsigned int keyType) : wxList(keyType) { }
 359     ~wxResourceCache();
 360
 361 private:
 362     DECLARE_DYNAMIC_CLASS(wxResourceCache)
 363 };
 364
 365 // ---------------------------------------------------------------------------
 366 // global variables
 367 // ---------------------------------------------------------------------------
 368
 369 // Lists of GDI objects
 370 WXDLLEXPORT_DATA(extern wxPenList*)   wxThePenList;
 371 WXDLLEXPORT_DATA(extern wxBrushList*)   wxTheBrushList;
 372 WXDLLEXPORT_DATA(extern wxFontList*)    wxTheFontList;
 373 WXDLLEXPORT_DATA(extern wxBitmapList*)  wxTheBitmapList;
 374
 375 // Stock objects
 376 WXDLLEXPORT_DATA(extern wxFont*)      wxNORMAL_FONT;
 377 WXDLLEXPORT_DATA(extern wxFont*)      wxSMALL_FONT;
 378 WXDLLEXPORT_DATA(extern wxFont*)      wxITALIC_FONT;
 379 WXDLLEXPORT_DATA(extern wxFont*)      wxSWISS_FONT;
 380
 381 WXDLLEXPORT_DATA(extern wxPen*)      wxRED_PEN;
 382 WXDLLEXPORT_DATA(extern wxPen*)      wxCYAN_PEN;
 383 WXDLLEXPORT_DATA(extern wxPen*)      wxGREEN_PEN;
 384 WXDLLEXPORT_DATA(extern wxPen*)      wxBLACK_PEN;
 385 WXDLLEXPORT_DATA(extern wxPen*)      wxWHITE_PEN;
 386 WXDLLEXPORT_DATA(extern wxPen*)      wxTRANSPARENT_PEN;
 387 WXDLLEXPORT_DATA(extern wxPen*)      wxBLACK_DASHED_PEN;
 388 WXDLLEXPORT_DATA(extern wxPen*)      wxGREY_PEN;
 389 WXDLLEXPORT_DATA(extern wxPen*)      wxMEDIUM_GREY_PEN;
 390 WXDLLEXPORT_DATA(extern wxPen*)      wxLIGHT_GREY_PEN;
 391
 392 WXDLLEXPORT_DATA(extern wxBrush*)    wxBLUE_BRUSH;
 393 WXDLLEXPORT_DATA(extern wxBrush*)    wxGREEN_BRUSH;
 394 WXDLLEXPORT_DATA(extern wxBrush*)    wxWHITE_BRUSH;
 395 WXDLLEXPORT_DATA(extern wxBrush*)    wxBLACK_BRUSH;
 396 WXDLLEXPORT_DATA(extern wxBrush*)    wxGREY_BRUSH;
 397 WXDLLEXPORT_DATA(extern wxBrush*)    wxMEDIUM_GREY_BRUSH;
 398 WXDLLEXPORT_DATA(extern wxBrush*)    wxLIGHT_GREY_BRUSH;
 399 WXDLLEXPORT_DATA(extern wxBrush*)    wxTRANSPARENT_BRUSH;
 400 WXDLLEXPORT_DATA(extern wxBrush*)    wxCYAN_BRUSH;
 401 WXDLLEXPORT_DATA(extern wxBrush*)    wxRED_BRUSH;
 402
 403 WXDLLEXPORT_DATA(extern wxColour*)    wxBLACK;
 404 WXDLLEXPORT_DATA(extern wxColour*)    wxWHITE;
 405 WXDLLEXPORT_DATA(extern wxColour*)    wxRED;
 406 WXDLLEXPORT_DATA(extern wxColour*)    wxBLUE;
 407 WXDLLEXPORT_DATA(extern wxColour*)    wxGREEN;
 408 WXDLLEXPORT_DATA(extern wxColour*)    wxCYAN;
 409 WXDLLEXPORT_DATA(extern wxColour*)    wxLIGHT_GREY;
 410
 411 // 'Null' objects
 412 WXDLLEXPORT_DATA(extern wxBitmap)     wxNullBitmap;
 413 WXDLLEXPORT_DATA(extern wxIcon)       wxNullIcon;
 414 WXDLLEXPORT_DATA(extern wxCursor)     wxNullCursor;
 415 WXDLLEXPORT_DATA(extern wxPen)        wxNullPen;
 416 WXDLLEXPORT_DATA(extern wxBrush)      wxNullBrush;
 417 WXDLLEXPORT_DATA(extern wxPalette)     wxNullPalette;
 418 WXDLLEXPORT_DATA(extern wxFont)       wxNullFont;
 419 WXDLLEXPORT_DATA(extern wxColour)     wxNullColour;
 420
 421 // Stock cursors types
 422 WXDLLEXPORT_DATA(extern wxCursor*)    wxSTANDARD_CURSOR;
 423 WXDLLEXPORT_DATA(extern wxCursor*)    wxHOURGLASS_CURSOR;
 424 WXDLLEXPORT_DATA(extern wxCursor*)    wxCROSS_CURSOR;
 425
 426 WXDLLEXPORT_DATA(extern wxColourDatabase*)  wxTheColourDatabase;
 427
 428 WXDLLEXPORT_DATA(extern const wxChar*) wxPanelNameStr;
 429
 430 WXDLLEXPORT_DATA(extern const wxSize) wxDefaultSize;
 431 WXDLLEXPORT_DATA(extern const wxPoint) wxDefaultPosition;
 432
 433 // The list of objects which should be deleted
 434 WXDLLEXPORT_DATA(extern wxList) wxPendingDelete;
 435
 436 // ---------------------------------------------------------------------------
 437 // global functions
 438 // ---------------------------------------------------------------------------
 439
 440 // resource management
 441 extern void WXDLLEXPORT wxInitializeStockObjects();
 442 extern void WXDLLEXPORT wxInitializeStockLists();
 443 extern void WXDLLEXPORT wxDeleteStockObjects();
 444 extern void WXDLLEXPORT wxDeleteStockLists();
 445
 446 // is the display colour (or monochrome)?
 447 extern bool WXDLLEXPORT wxColourDisplay();
 448
 449 // Returns depth of screen
 450 extern int WXDLLEXPORT wxDisplayDepth();
 451 #define wxGetDisplayDepth wxDisplayDepth
 452
 453 // get the diaplay size
 454 extern void WXDLLEXPORT wxDisplaySize(int *width, int *height);
 455 extern wxSize WXDLLEXPORT wxGetDisplaySize();
 456
 457 // set global cursor
 458 extern void WXDLLEXPORT wxSetCursor(const wxCursor& cursor);
 459
 460 #endif
 461     // _WX_GDICMNH__