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 #include "wx/font.h"
  30
  31 // ---------------------------------------------------------------------------
  32 // forward declarations
  33 // ---------------------------------------------------------------------------
  34
  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;
  45
  46 // ---------------------------------------------------------------------------
  47 // constants
  48 // ---------------------------------------------------------------------------
  49
  50 // Bitmap flags
  51 enum wxBitmapType
  52 {
  53     wxBITMAP_TYPE_INVALID,          // should be == 0 for compatibility!
  54     wxBITMAP_TYPE_BMP,
  55     wxBITMAP_TYPE_BMP_RESOURCE,
  56     wxBITMAP_TYPE_RESOURCE = wxBITMAP_TYPE_BMP_RESOURCE,
  57     wxBITMAP_TYPE_ICO,
  58     wxBITMAP_TYPE_ICO_RESOURCE,
  59     wxBITMAP_TYPE_CUR,
  60     wxBITMAP_TYPE_CUR_RESOURCE,
  61     wxBITMAP_TYPE_XBM,
  62     wxBITMAP_TYPE_XBM_DATA,
  63     wxBITMAP_TYPE_XPM,
  64     wxBITMAP_TYPE_XPM_DATA,
  65     wxBITMAP_TYPE_TIF,
  66     wxBITMAP_TYPE_TIF_RESOURCE,
  67     wxBITMAP_TYPE_GIF,
  68     wxBITMAP_TYPE_GIF_RESOURCE,
  69     wxBITMAP_TYPE_PNG,
  70     wxBITMAP_TYPE_PNG_RESOURCE,
  71     wxBITMAP_TYPE_JPEG,
  72     wxBITMAP_TYPE_JPEG_RESOURCE,
  73     wxBITMAP_TYPE_PNM,
  74     wxBITMAP_TYPE_PNM_RESOURCE,
  75     wxBITMAP_TYPE_PCX,
  76     wxBITMAP_TYPE_PCX_RESOURCE,
  77     wxBITMAP_TYPE_PICT,
  78     wxBITMAP_TYPE_PICT_RESOURCE,
  79     wxBITMAP_TYPE_ICON,
  80     wxBITMAP_TYPE_ICON_RESOURCE,
  81     wxBITMAP_TYPE_ANI,
  82     wxBITMAP_TYPE_IFF,
  83     wxBITMAP_TYPE_MACCURSOR,
  84     wxBITMAP_TYPE_MACCURSOR_RESOURCE,
  85     wxBITMAP_TYPE_ANY = 50
  86 };
  87
  88 // Standard cursors
  89 enum wxStockCursor
  90 {
  91     wxCURSOR_NONE,          // should be 0
  92     wxCURSOR_ARROW,
  93     wxCURSOR_BULLSEYE,
  94     wxCURSOR_CHAR,
  95     wxCURSOR_CROSS,
  96     wxCURSOR_HAND,
  97     wxCURSOR_IBEAM,
  98     wxCURSOR_LEFT_BUTTON,
  99     wxCURSOR_MAGNIFIER,
 100     wxCURSOR_MIDDLE_BUTTON,
 101     wxCURSOR_NO_ENTRY,
 102     wxCURSOR_PAINT_BRUSH,
 103     wxCURSOR_PENCIL,
 104     wxCURSOR_POINT_LEFT,
 105     wxCURSOR_POINT_RIGHT,
 106     wxCURSOR_QUESTION_ARROW,
 107     wxCURSOR_RIGHT_BUTTON,
 108     wxCURSOR_SIZENESW,
 109     wxCURSOR_SIZENS,
 110     wxCURSOR_SIZENWSE,
 111     wxCURSOR_SIZEWE,
 112     wxCURSOR_SIZING,
 113     wxCURSOR_SPRAYCAN,
 114     wxCURSOR_WAIT,
 115     wxCURSOR_WATCH,
 116     wxCURSOR_BLANK,
 117 #ifdef __WXGTK__
 118     wxCURSOR_DEFAULT, // standard X11 cursor
 119 #endif
 120 #ifdef __X__
 121     // Not yet implemented for Windows
 122     wxCURSOR_CROSS_REVERSE,
 123     wxCURSOR_DOUBLE_ARROW,
 124     wxCURSOR_BASED_ARROW_UP,
 125     wxCURSOR_BASED_ARROW_DOWN,
 126 #endif // X11
 127
 128     wxCURSOR_ARROWWAIT,
 129
 130     wxCURSOR_MAX
 131 };
 132
 133 #ifndef __WXGTK__
 134     #define wxCURSOR_DEFAULT wxCURSOR_ARROW
 135 #endif
 136
 137 // ---------------------------------------------------------------------------
 138 // macros
 139 // ---------------------------------------------------------------------------
 140
 141 /* Useful macro for creating icons portably, for example:
 142
 143     wxIcon *icon = new wxICON(mondrian);
 144
 145   expands into:
 146
 147     wxIcon *icon = new wxIcon("mondrian");      // On wxMSW
 148     wxIcon *icon = new wxIcon(mondrian_xpm);    // On wxGTK
 149  */
 150
 151 #ifdef __WXMSW__
 152     // Load from a resource
 153     #define wxICON(X) wxIcon("" #X "")
 154 #elif defined(__WXPM__)
 155     // Load from a resource
 156     #define wxICON(X) wxIcon("" #X "")
 157 #elif defined(__WXMGL__)
 158     // Initialize from an included XPM
 159     #define wxICON(X) wxIcon( (const char**) X##_xpm )
 160 #elif defined(__WXGTK__)
 161     // Initialize from an included XPM
 162     #define wxICON(X) wxIcon( (const char**) X##_xpm )
 163 #elif defined(__WXMAC__)
 164     // Initialize from an included XPM
 165     #define wxICON(X) wxIcon( (const char**) X##_xpm )
 166 #elif defined(__WXMOTIF__)
 167     // Initialize from an included XPM
 168     #define wxICON(X) wxIcon( X##_xpm )
 169 #else
 170     // This will usually mean something on any platform
 171     #define wxICON(X) wxIcon("" #X "")
 172 #endif // platform
 173
 174 /* Another macro: this one is for portable creation of bitmaps. We assume that
 175    under Unix bitmaps live in XPMs and under Windows they're in ressources.
 176  */
 177
 178 #if defined(__WXMSW__) || defined(__WXPM__)
 179     #define wxBITMAP(name) wxBitmap(#name, wxBITMAP_TYPE_RESOURCE)
 180 #elif defined(__WXGTK__) || defined(__WXMOTIF__) || defined(__WXMAC__) || defined(__WXMGL__)
 181     // Initialize from an included XPM
 182     #define wxBITMAP(name) wxBitmap( (const char**) name##_xpm )
 183 #else // other platforms
 184     #define wxBITMAP(name) wxBitmap(name##_xpm, wxBITMAP_TYPE_XPM)
 185 #endif // platform
 186
 187 // ===========================================================================
 188 // classes
 189 // ===========================================================================
 190
 191 // ---------------------------------------------------------------------------
 192 // wxSize
 193 // ---------------------------------------------------------------------------
 194
 195 class WXDLLEXPORT wxSize
 196 {
 197 public:
 198     // members are public for compatibility (don't use them directly,
 199     // especially that there names were chosen very unfortunately - they should
 200     // have been called width and height)
 201     int x, y;
 202
 203     // constructors
 204     wxSize() { x = y = 0; }
 205     wxSize(int xx, int yy) { Set(xx, yy); }
 206
 207     // no copy ctor or assignment operator - the defaults are ok
 208
 209     bool operator==(const wxSize& sz) const { return x == sz.x && y == sz.y; }
 210     bool operator!=(const wxSize& sz) const { return x != sz.x || y != sz.y; }
 211
 212     // FIXME are these really useful? If they're, we should have += &c as well
 213     wxSize operator+(const wxSize& sz) { return wxSize(x + sz.x, y + sz.y); }
 214     wxSize operator-(const wxSize& sz) { return wxSize(x - sz.x, y - sz.y); }
 215
 216     // accessors
 217     void Set(int xx, int yy) { x = xx; y = yy; }
 218     void SetWidth(int w) { x = w; }
 219     void SetHeight(int h) { y = h; }
 220
 221     int GetWidth() const { return x; }
 222     int GetHeight() const { return y; }
 223
 224     // compatibility
 225     int GetX() const { return x; }
 226     int GetY() const { return y; }
 227 };
 228
 229 // ---------------------------------------------------------------------------
 230 // Point classes: with real or integer coordinates
 231 // ---------------------------------------------------------------------------
 232
 233 class WXDLLEXPORT wxRealPoint
 234 {
 235 public:
 236     double x;
 237     double y;
 238
 239     wxRealPoint() { x = y = 0.0; };
 240     wxRealPoint(double xx, double yy) { x = xx; y = yy; };
 241
 242     wxRealPoint operator+(const wxRealPoint& pt) const { return wxRealPoint(x + pt.x, y + pt.y); }
 243     wxRealPoint operator-(const wxRealPoint& pt) const { return wxRealPoint(x - pt.x, y - pt.y); }
 244
 245     bool operator==(const wxRealPoint& pt) const { return x == pt.x && y == pt.y; }
 246 };
 247
 248 class WXDLLEXPORT wxPoint
 249 {
 250 public:
 251     int x, y;
 252
 253     wxPoint() { x = y = 0; };
 254     wxPoint(int xx, int yy) { x = xx; y = yy; };
 255
 256     // no copy ctor or assignment operator - the defaults are ok
 257
 258     // comparison
 259     bool operator==(const wxPoint& p) const { return x == p.x && y == p.y; }
 260     bool operator!=(const wxPoint& p) const { return !(*this == p); }
 261
 262     // arithmetic operations (component wise)
 263     wxPoint operator+(const wxPoint& p) const { return wxPoint(x + p.x, y + p.y); }
 264     wxPoint operator-(const wxPoint& p) const { return wxPoint(x - p.x, y - p.y); }
 265
 266     wxPoint& operator+=(const wxPoint& p) { x += p.x; y += p.y; return *this; }
 267     wxPoint& operator-=(const wxPoint& p) { x -= p.x; y -= p.y; return *this; }
 268 };
 269
 270 #if WXWIN_COMPATIBILITY
 271     #define wxIntPoint wxPoint
 272     #define wxRectangle wxRect
 273 #endif // WXWIN_COMPATIBILITY
 274
 275 // ---------------------------------------------------------------------------
 276 // wxRect
 277 // ---------------------------------------------------------------------------
 278
 279 class WXDLLEXPORT wxRect
 280 {
 281 public:
 282     wxRect() { x = y = width = height = 0; }
 283     wxRect(int xx, int yy, int ww, int hh)
 284         { x = xx; y = yy; width = ww; height = hh; }
 285     wxRect(const wxPoint& topLeft, const wxPoint& bottomRight);
 286     wxRect(const wxPoint& pos, const wxSize& size);
 287
 288     // default copy ctor and assignment operators ok
 289
 290     int GetX() const { return x; }
 291     void SetX(int xx) { x = xx; }
 292
 293     int GetY() const { return y; }
 294     void SetY(int yy) { y = yy; }
 295
 296     int GetWidth() const { return width; }
 297     void SetWidth(int w) { width = w; }
 298
 299     int GetHeight() const { return height; }
 300     void SetHeight(int h) { height = h; }
 301
 302     wxPoint GetPosition() const { return wxPoint(x, y); }
 303     wxSize GetSize() const { return wxSize(width, height); }
 304
 305     int GetLeft()   const { return x; }
 306     int GetTop()    const { return y; }
 307     int GetBottom() const { return y + height - 1; }
 308     int GetRight()  const { return x + width - 1; }
 309
 310     void SetLeft(int left) { x = left; }
 311     void SetRight(int right) { width = right - x + 1; }
 312     void SetTop(int top) { y = top; }
 313     void SetBottom(int bottom) { height = bottom - y + 1; }
 314
 315     // operations with rect
 316     wxRect& Inflate(wxCoord dx, wxCoord dy);
 317     wxRect& Inflate(wxCoord d) { return Inflate(d, d); }
 318     wxRect Inflate(wxCoord dx, wxCoord dy) const
 319     {
 320         wxRect r = *this;
 321         r.Inflate(dx, dy);
 322         return r;
 323     }
 324
 325     wxRect& Deflate(wxCoord dx, wxCoord dy) { return Inflate(-dx, -dy); }
 326     wxRect& Deflate(wxCoord d) { return Inflate(-d); }
 327     wxRect Deflate(wxCoord dx, wxCoord dy) const
 328     {
 329         wxRect r = *this;
 330         r.Deflate(dx, dy);
 331         return r;
 332     }
 333
 334     void Offset(wxCoord dx, wxCoord dy) { x += dx; y += dy; }
 335     void Offset(const wxPoint& pt) { Offset(pt.x, pt.y); }
 336
 337     wxRect& Intersect(const wxRect& rect);
 338     wxRect Intersect(const wxRect& rect) const
 339     {
 340         wxRect r = *this;
 341         r.Intersect(rect);
 342         return r;
 343     }
 344
 345     wxRect operator+(const wxRect& rect) const;
 346     wxRect& operator+=(const wxRect& rect);
 347
 348     // compare rectangles
 349     bool operator==(const wxRect& rect) const;
 350     bool operator!=(const wxRect& rect) const { return !(*this == rect); }
 351
 352     // return TRUE if the point is (not strcitly) inside the rect
 353     bool Inside(int x, int y) const;
 354     bool Inside(const wxPoint& pt) const { return Inside(pt.x, pt.y); }
 355
 356     // return TRUE if the rectangles have a non empty intersection
 357     bool Intersects(const wxRect& rect) const;
 358
 359 public:
 360     int x, y, width, height;
 361 };
 362
 363 // ---------------------------------------------------------------------------
 364 // Management of pens, brushes and fonts
 365 // ---------------------------------------------------------------------------
 366
 367 typedef wxInt8 wxDash;
 368
 369 class WXDLLEXPORT wxPenList : public wxList
 370 {
 371     DECLARE_DYNAMIC_CLASS(wxPenList)
 372
 373 public:
 374     wxPenList() { }
 375     ~wxPenList();
 376
 377     void AddPen(wxPen *pen);
 378     void RemovePen(wxPen *pen);
 379     wxPen *FindOrCreatePen(const wxColour& colour, int width, int style);
 380 };
 381
 382 class WXDLLEXPORT wxBrushList : public wxList
 383 {
 384     DECLARE_DYNAMIC_CLASS(wxBrushList)
 385
 386 public:
 387     wxBrushList() { }
 388     ~wxBrushList();
 389
 390     void AddBrush(wxBrush *brush);
 391     void RemoveBrush(wxBrush *brush);
 392     wxBrush *FindOrCreateBrush(const wxColour& colour, int style);
 393 };
 394
 395 WXDLLEXPORT_DATA(extern const wxChar*) wxEmptyString;
 396
 397 class WXDLLEXPORT wxFontList : public wxList
 398 {
 399     DECLARE_DYNAMIC_CLASS(wxFontList)
 400
 401 public:
 402     wxFontList() { }
 403     ~wxFontList();
 404
 405     void AddFont(wxFont *font);
 406     void RemoveFont(wxFont *font);
 407     wxFont *FindOrCreateFont(int pointSize, int family, int style, int weight,
 408                              bool underline = FALSE,
 409                              const wxString& face = wxEmptyString,
 410                              wxFontEncoding encoding = wxFONTENCODING_DEFAULT);
 411 };
 412
 413 class WXDLLEXPORT wxColourDatabase : public wxList
 414 {
 415     DECLARE_CLASS(wxColourDatabase)
 416
 417 public:
 418     wxColourDatabase(int type);
 419     ~wxColourDatabase() ;
 420
 421     // Not const because it may add a name to the database
 422     wxColour *FindColour(const wxString& colour) ;
 423     wxString FindName(const wxColour& colour) const;
 424     void Initialize();
 425 #ifdef __WXPM__
 426     // PM keeps its own type of colour table
 427     long*                           m_palTable;
 428     size_t                          m_nSize;
 429 #endif
 430 };
 431
 432 class WXDLLEXPORT wxBitmapList : public wxList
 433 {
 434     DECLARE_DYNAMIC_CLASS(wxBitmapList)
 435
 436 public:
 437     wxBitmapList();
 438     ~wxBitmapList();
 439
 440     void AddBitmap(wxBitmap *bitmap);
 441     void RemoveBitmap(wxBitmap *bitmap);
 442 };
 443
 444 class WXDLLEXPORT wxResourceCache: public wxList
 445 {
 446 public:
 447     wxResourceCache() { }
 448     wxResourceCache(const unsigned int keyType) : wxList(keyType) { }
 449     ~wxResourceCache();
 450
 451 private:
 452     DECLARE_DYNAMIC_CLASS(wxResourceCache)
 453 };
 454
 455 // ---------------------------------------------------------------------------
 456 // global variables
 457 // ---------------------------------------------------------------------------
 458
 459 // Lists of GDI objects
 460 WXDLLEXPORT_DATA(extern wxPenList*)   wxThePenList;
 461 WXDLLEXPORT_DATA(extern wxBrushList*)   wxTheBrushList;
 462 WXDLLEXPORT_DATA(extern wxFontList*)    wxTheFontList;
 463 WXDLLEXPORT_DATA(extern wxBitmapList*)  wxTheBitmapList;
 464
 465 // Stock objects
 466 WXDLLEXPORT_DATA(extern wxFont*)      wxNORMAL_FONT;
 467 WXDLLEXPORT_DATA(extern wxFont*)      wxSMALL_FONT;
 468 WXDLLEXPORT_DATA(extern wxFont*)      wxITALIC_FONT;
 469 WXDLLEXPORT_DATA(extern wxFont*)      wxSWISS_FONT;
 470
 471 WXDLLEXPORT_DATA(extern wxPen*)      wxRED_PEN;
 472 WXDLLEXPORT_DATA(extern wxPen*)      wxCYAN_PEN;
 473 WXDLLEXPORT_DATA(extern wxPen*)      wxGREEN_PEN;
 474 WXDLLEXPORT_DATA(extern wxPen*)      wxBLACK_PEN;
 475 WXDLLEXPORT_DATA(extern wxPen*)      wxWHITE_PEN;
 476 WXDLLEXPORT_DATA(extern wxPen*)      wxTRANSPARENT_PEN;
 477 WXDLLEXPORT_DATA(extern wxPen*)      wxBLACK_DASHED_PEN;
 478 WXDLLEXPORT_DATA(extern wxPen*)      wxGREY_PEN;
 479 WXDLLEXPORT_DATA(extern wxPen*)      wxMEDIUM_GREY_PEN;
 480 WXDLLEXPORT_DATA(extern wxPen*)      wxLIGHT_GREY_PEN;
 481
 482 WXDLLEXPORT_DATA(extern wxBrush*)    wxBLUE_BRUSH;
 483 WXDLLEXPORT_DATA(extern wxBrush*)    wxGREEN_BRUSH;
 484 WXDLLEXPORT_DATA(extern wxBrush*)    wxWHITE_BRUSH;
 485 WXDLLEXPORT_DATA(extern wxBrush*)    wxBLACK_BRUSH;
 486 WXDLLEXPORT_DATA(extern wxBrush*)    wxGREY_BRUSH;
 487 WXDLLEXPORT_DATA(extern wxBrush*)    wxMEDIUM_GREY_BRUSH;
 488 WXDLLEXPORT_DATA(extern wxBrush*)    wxLIGHT_GREY_BRUSH;
 489 WXDLLEXPORT_DATA(extern wxBrush*)    wxTRANSPARENT_BRUSH;
 490 WXDLLEXPORT_DATA(extern wxBrush*)    wxCYAN_BRUSH;
 491 WXDLLEXPORT_DATA(extern wxBrush*)    wxRED_BRUSH;
 492
 493 WXDLLEXPORT_DATA(extern wxColour*)    wxBLACK;
 494 WXDLLEXPORT_DATA(extern wxColour*)    wxWHITE;
 495 WXDLLEXPORT_DATA(extern wxColour*)    wxRED;
 496 WXDLLEXPORT_DATA(extern wxColour*)    wxBLUE;
 497 WXDLLEXPORT_DATA(extern wxColour*)    wxGREEN;
 498 WXDLLEXPORT_DATA(extern wxColour*)    wxCYAN;
 499 WXDLLEXPORT_DATA(extern wxColour*)    wxLIGHT_GREY;
 500
 501 // 'Null' objects
 502 WXDLLEXPORT_DATA(extern wxBitmap)     wxNullBitmap;
 503 WXDLLEXPORT_DATA(extern wxIcon)       wxNullIcon;
 504 WXDLLEXPORT_DATA(extern wxCursor)     wxNullCursor;
 505 WXDLLEXPORT_DATA(extern wxPen)        wxNullPen;
 506 WXDLLEXPORT_DATA(extern wxBrush)      wxNullBrush;
 507 WXDLLEXPORT_DATA(extern wxPalette)     wxNullPalette;
 508 WXDLLEXPORT_DATA(extern wxFont)       wxNullFont;
 509 WXDLLEXPORT_DATA(extern wxColour)     wxNullColour;
 510
 511 // Stock cursors types
 512 WXDLLEXPORT_DATA(extern wxCursor*)    wxSTANDARD_CURSOR;
 513 WXDLLEXPORT_DATA(extern wxCursor*)    wxHOURGLASS_CURSOR;
 514 WXDLLEXPORT_DATA(extern wxCursor*)    wxCROSS_CURSOR;
 515
 516 WXDLLEXPORT_DATA(extern wxColourDatabase*)  wxTheColourDatabase;
 517
 518 WXDLLEXPORT_DATA(extern const wxChar*) wxPanelNameStr;
 519
 520 WXDLLEXPORT_DATA(extern const wxSize) wxDefaultSize;
 521 WXDLLEXPORT_DATA(extern const wxPoint) wxDefaultPosition;
 522
 523 // The list of objects which should be deleted
 524 WXDLLEXPORT_DATA(extern wxList) wxPendingDelete;
 525
 526 // ---------------------------------------------------------------------------
 527 // global functions
 528 // ---------------------------------------------------------------------------
 529
 530 // resource management
 531 extern void WXDLLEXPORT wxInitializeStockObjects();
 532 extern void WXDLLEXPORT wxInitializeStockLists();
 533 extern void WXDLLEXPORT wxDeleteStockObjects();
 534 extern void WXDLLEXPORT wxDeleteStockLists();
 535
 536 // is the display colour (or monochrome)?
 537 extern bool WXDLLEXPORT wxColourDisplay();
 538
 539 // Returns depth of screen
 540 extern int WXDLLEXPORT wxDisplayDepth();
 541 #define wxGetDisplayDepth wxDisplayDepth
 542
 543 // get the display size
 544 extern void WXDLLEXPORT wxDisplaySize(int *width, int *height);
 545 extern wxSize WXDLLEXPORT wxGetDisplaySize();
 546 extern void WXDLLEXPORT wxDisplaySizeMM(int *width, int *height);
 547 extern wxSize WXDLLEXPORT wxGetDisplaySizeMM();
 548
 549 // Get position and size of the display workarea
 550 extern void WXDLLEXPORT wxClientDisplayRect(int *x, int *y, int *width, int *height);
 551 extern wxRect WXDLLEXPORT wxGetClientDisplayRect();
 552
 553 // set global cursor
 554 extern void WXDLLEXPORT wxSetCursor(const wxCursor& cursor);
 555
 556 #endif
 557     // _WX_GDICMNH__