include/wx/gdicmn.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/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) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_GDICMNH__
  13 #define _WX_GDICMNH__
  14
  15 // ---------------------------------------------------------------------------
  16 // headers
  17 // ---------------------------------------------------------------------------
  18
  19 #include "wx/defs.h"
  20 #include "wx/list.h"
  21 #include "wx/string.h"
  22 #include "wx/fontenc.h"
  23 #include "wx/hashmap.h"
  24 #include "wx/math.h"
  25
  26 // ---------------------------------------------------------------------------
  27 // forward declarations
  28 // ---------------------------------------------------------------------------
  29
  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;
  42
  43 // ---------------------------------------------------------------------------
  44 // constants
  45 // ---------------------------------------------------------------------------
  46
  47 // Bitmap flags
  48 enum wxBitmapType
  49 {
  50     wxBITMAP_TYPE_INVALID,          // should be == 0 for compatibility!
  51     wxBITMAP_TYPE_BMP,
  52     wxBITMAP_TYPE_BMP_RESOURCE,
  53     wxBITMAP_TYPE_RESOURCE = wxBITMAP_TYPE_BMP_RESOURCE,
  54     wxBITMAP_TYPE_ICO,
  55     wxBITMAP_TYPE_ICO_RESOURCE,
  56     wxBITMAP_TYPE_CUR,
  57     wxBITMAP_TYPE_CUR_RESOURCE,
  58     wxBITMAP_TYPE_XBM,
  59     wxBITMAP_TYPE_XBM_DATA,
  60     wxBITMAP_TYPE_XPM,
  61     wxBITMAP_TYPE_XPM_DATA,
  62     wxBITMAP_TYPE_TIFF,
  63     wxBITMAP_TYPE_TIF = wxBITMAP_TYPE_TIFF,
  64     wxBITMAP_TYPE_TIFF_RESOURCE,
  65     wxBITMAP_TYPE_TIF_RESOURCE = wxBITMAP_TYPE_TIFF_RESOURCE,
  66     wxBITMAP_TYPE_GIF,
  67     wxBITMAP_TYPE_GIF_RESOURCE,
  68     wxBITMAP_TYPE_PNG,
  69     wxBITMAP_TYPE_PNG_RESOURCE,
  70     wxBITMAP_TYPE_JPEG,
  71     wxBITMAP_TYPE_JPEG_RESOURCE,
  72     wxBITMAP_TYPE_PNM,
  73     wxBITMAP_TYPE_PNM_RESOURCE,
  74     wxBITMAP_TYPE_PCX,
  75     wxBITMAP_TYPE_PCX_RESOURCE,
  76     wxBITMAP_TYPE_PICT,
  77     wxBITMAP_TYPE_PICT_RESOURCE,
  78     wxBITMAP_TYPE_ICON,
  79     wxBITMAP_TYPE_ICON_RESOURCE,
  80     wxBITMAP_TYPE_ANI,
  81     wxBITMAP_TYPE_IFF,
  82     wxBITMAP_TYPE_TGA,
  83     wxBITMAP_TYPE_MACCURSOR,
  84     wxBITMAP_TYPE_MACCURSOR_RESOURCE,
  85
  86     wxBITMAP_TYPE_MAX,
  87     wxBITMAP_TYPE_ANY = 50
  88 };
  89
  90 //  Polygon filling mode
  91 enum wxPolygonFillMode
  92 {
  93     wxODDEVEN_RULE = 1,
  94     wxWINDING_RULE
  95 };
  96
  97 // Standard cursors
  98 enum wxStockCursor
  99 {
 100     wxCURSOR_NONE,          // should be 0
 101     wxCURSOR_ARROW,
 102     wxCURSOR_RIGHT_ARROW,
 103     wxCURSOR_BULLSEYE,
 104     wxCURSOR_CHAR,
 105     wxCURSOR_CROSS,
 106     wxCURSOR_HAND,
 107     wxCURSOR_IBEAM,
 108     wxCURSOR_LEFT_BUTTON,
 109     wxCURSOR_MAGNIFIER,
 110     wxCURSOR_MIDDLE_BUTTON,
 111     wxCURSOR_NO_ENTRY,
 112     wxCURSOR_PAINT_BRUSH,
 113     wxCURSOR_PENCIL,
 114     wxCURSOR_POINT_LEFT,
 115     wxCURSOR_POINT_RIGHT,
 116     wxCURSOR_QUESTION_ARROW,
 117     wxCURSOR_RIGHT_BUTTON,
 118     wxCURSOR_SIZENESW,
 119     wxCURSOR_SIZENS,
 120     wxCURSOR_SIZENWSE,
 121     wxCURSOR_SIZEWE,
 122     wxCURSOR_SIZING,
 123     wxCURSOR_SPRAYCAN,
 124     wxCURSOR_WAIT,
 125     wxCURSOR_WATCH,
 126     wxCURSOR_BLANK,
 127 #ifdef __WXGTK__
 128     wxCURSOR_DEFAULT, // standard X11 cursor
 129 #endif
 130 #ifdef __WXMAC__
 131     wxCURSOR_COPY_ARROW , // MacOS Theme Plus arrow
 132 #endif
 133 #ifdef __X__
 134     // Not yet implemented for Windows
 135     wxCURSOR_CROSS_REVERSE,
 136     wxCURSOR_DOUBLE_ARROW,
 137     wxCURSOR_BASED_ARROW_UP,
 138     wxCURSOR_BASED_ARROW_DOWN,
 139 #endif // X11
 140     wxCURSOR_ARROWWAIT,
 141 #ifdef __WXMAC__
 142     wxCURSOR_OPEN_HAND,
 143     wxCURSOR_CLOSED_HAND,
 144 #endif
 145
 146     wxCURSOR_MAX
 147 };
 148
 149 #ifndef __WXGTK__
 150     #define wxCURSOR_DEFAULT        wxCURSOR_ARROW
 151 #endif
 152
 153 #ifndef __WXMAC__
 154     // TODO CS supply openhand and closedhand cursors
 155     #define wxCURSOR_OPEN_HAND      wxCURSOR_HAND
 156     #define wxCURSOR_CLOSED_HAND    wxCURSOR_HAND
 157 #endif
 158
 159 // ---------------------------------------------------------------------------
 160 // macros
 161 // ---------------------------------------------------------------------------
 162
 163 #if defined(__WINDOWS__) || defined(__WXPM__)
 164     #define wxHAS_IMAGES_IN_RESOURCES
 165 #endif
 166
 167 /* Useful macro for creating icons portably, for example:
 168
 169     wxIcon *icon = new wxICON(sample);
 170
 171   expands into:
 172
 173     wxIcon *icon = new wxIcon("sample");      // On Windows
 174     wxIcon *icon = new wxIcon(sample_xpm);    // On wxGTK/Linux
 175  */
 176
 177 #ifdef __WXMSW__
 178     // Load from a resource
 179     #define wxICON(X) wxIcon(wxT(#X))
 180 #elif defined(__WXPM__)
 181     // Load from a resource
 182     #define wxICON(X) wxIcon(wxT(#X))
 183 #elif defined(__WXDFB__)
 184     // Initialize from an included XPM
 185     #define wxICON(X) wxIcon( X##_xpm )
 186 #elif defined(__WXGTK__)
 187     // Initialize from an included XPM
 188     #define wxICON(X) wxIcon( X##_xpm )
 189 #elif defined(__WXMAC__)
 190     // Initialize from an included XPM
 191     #define wxICON(X) wxIcon( X##_xpm )
 192 #elif defined(__WXMOTIF__)
 193     // Initialize from an included XPM
 194     #define wxICON(X) wxIcon( X##_xpm )
 195 #elif defined(__WXX11__)
 196     // Initialize from an included XPM
 197     #define wxICON(X) wxIcon( X##_xpm )
 198 #else
 199     // This will usually mean something on any platform
 200     #define wxICON(X) wxIcon(wxT(#X))
 201 #endif // platform
 202
 203 /* Another macro: this one is for portable creation of bitmaps. We assume that
 204    under Unix bitmaps live in XPMs and under Windows they're in ressources.
 205  */
 206
 207 #if defined(__WXMSW__) || defined(__WXPM__)
 208     #define wxBITMAP(name) wxBitmap(wxT(#name), wxBITMAP_TYPE_BMP_RESOURCE)
 209 #elif defined(__WXGTK__)   || \
 210       defined(__WXMOTIF__) || \
 211       defined(__WXX11__)   || \
 212       defined(__WXMAC__)   || \
 213       defined(__WXDFB__)   || \
 214       defined(__WXCOCOA__)
 215     // Initialize from an included XPM
 216     #define wxBITMAP(name) wxBitmap(name##_xpm)
 217 #else // other platforms
 218     #define wxBITMAP(name) wxBitmap(name##_xpm, wxBITMAP_TYPE_XPM)
 219 #endif // platform
 220
 221 // ===========================================================================
 222 // classes
 223 // ===========================================================================
 224
 225 // ---------------------------------------------------------------------------
 226 // wxSize
 227 // ---------------------------------------------------------------------------
 228
 229 class WXDLLIMPEXP_CORE wxSize
 230 {
 231 public:
 232     // members are public for compatibility, don't use them directly.
 233     int x, y;
 234
 235     // constructors
 236     wxSize() : x(0), y(0) { }
 237     wxSize(int xx, int yy) : x(xx), y(yy) { }
 238
 239     // no copy ctor or assignment operator - the defaults are ok
 240
 241     wxSize& operator+=(const wxSize& sz) { x += sz.x; y += sz.y; return *this; }
 242     wxSize& operator-=(const wxSize& sz) { x -= sz.x; y -= sz.y; return *this; }
 243     wxSize& operator/=(int i) { x /= i; y /= i; return *this; }
 244     wxSize& operator*=(int i) { x *= i; y *= i; return *this; }
 245     wxSize& operator/=(unsigned int i) { x /= i; y /= i; return *this; }
 246     wxSize& operator*=(unsigned int i) { x *= i; y *= i; return *this; }
 247     wxSize& operator/=(long i) { x /= i; y /= i; return *this; }
 248     wxSize& operator*=(long i) { x *= i; y *= i; return *this; }
 249     wxSize& operator/=(unsigned long i) { x /= i; y /= i; return *this; }
 250     wxSize& operator*=(unsigned long i) { x *= i; y *= i; return *this; }
 251     wxSize& operator/=(double i) { x = int(x/i); y = int(y/i); return *this; }
 252     wxSize& operator*=(double i) { x = int(x*i); y = int(y*i); return *this; }
 253
 254     void IncTo(const wxSize& sz)
 255         { if ( sz.x > x ) x = sz.x; if ( sz.y > y ) y = sz.y; }
 256     void DecTo(const wxSize& sz)
 257         { if ( sz.x < x ) x = sz.x; if ( sz.y < y ) y = sz.y; }
 258
 259     void IncBy(int dx, int dy) { x += dx; y += dy; }
 260     void IncBy(const wxPoint& pt);
 261     void IncBy(const wxSize& sz) { IncBy(sz.x, sz.y); }
 262     void IncBy(int d) { IncBy(d, d); }
 263
 264     void DecBy(int dx, int dy) { IncBy(-dx, -dy); }
 265     void DecBy(const wxPoint& pt);
 266     void DecBy(const wxSize& sz) { DecBy(sz.x, sz.y); }
 267     void DecBy(int d) { DecBy(d, d); }
 268
 269
 270     wxSize& Scale(float xscale, float yscale)
 271         { x = (int)(x*xscale); y = (int)(y*yscale); return *this; }
 272
 273     // accessors
 274     void Set(int xx, int yy) { x = xx; y = yy; }
 275     void SetWidth(int w) { x = w; }
 276     void SetHeight(int h) { y = h; }
 277
 278     int GetWidth() const { return x; }
 279     int GetHeight() const { return y; }
 280
 281     bool IsFullySpecified() const { return x != wxDefaultCoord && y != wxDefaultCoord; }
 282
 283     // combine this size with the other one replacing the default (i.e. equal
 284     // to wxDefaultCoord) components of this object with those of the other
 285     void SetDefaults(const wxSize& size)
 286     {
 287         if ( x == wxDefaultCoord )
 288             x = size.x;
 289         if ( y == wxDefaultCoord )
 290             y = size.y;
 291     }
 292
 293     // compatibility
 294     int GetX() const { return x; }
 295     int GetY() const { return y; }
 296 };
 297
 298 inline bool operator==(const wxSize& s1, const wxSize& s2)
 299 {
 300     return s1.x == s2.x && s1.y == s2.y;
 301 }
 302
 303 inline bool operator!=(const wxSize& s1, const wxSize& s2)
 304 {
 305     return s1.x != s2.x || s1.y != s2.y;
 306 }
 307
 308 inline wxSize operator+(const wxSize& s1, const wxSize& s2)
 309 {
 310     return wxSize(s1.x + s2.x, s1.y + s2.y);
 311 }
 312
 313 inline wxSize operator-(const wxSize& s1, const wxSize& s2)
 314 {
 315     return wxSize(s1.x - s2.x, s1.y - s2.y);
 316 }
 317
 318 inline wxSize operator/(const wxSize& s, int i)
 319 {
 320     return wxSize(s.x / i, s.y / i);
 321 }
 322
 323 inline wxSize operator*(const wxSize& s, int i)
 324 {
 325     return wxSize(s.x * i, s.y * i);
 326 }
 327
 328 inline wxSize operator*(int i, const wxSize& s)
 329 {
 330     return wxSize(s.x * i, s.y * i);
 331 }
 332
 333 inline wxSize operator/(const wxSize& s, unsigned int i)
 334 {
 335     return wxSize(s.x / i, s.y / i);
 336 }
 337
 338 inline wxSize operator*(const wxSize& s, unsigned int i)
 339 {
 340     return wxSize(s.x * i, s.y * i);
 341 }
 342
 343 inline wxSize operator*(unsigned int i, const wxSize& s)
 344 {
 345     return wxSize(s.x * i, s.y * i);
 346 }
 347
 348 inline wxSize operator/(const wxSize& s, long i)
 349 {
 350     return wxSize(s.x / i, s.y / i);
 351 }
 352
 353 inline wxSize operator*(const wxSize& s, long i)
 354 {
 355     return wxSize(s.x * i, s.y * i);
 356 }
 357
 358 inline wxSize operator*(long i, const wxSize& s)
 359 {
 360     return wxSize(s.x * i, s.y * i);
 361 }
 362
 363 inline wxSize operator/(const wxSize& s, unsigned long i)
 364 {
 365     return wxSize(s.x / i, s.y / i);
 366 }
 367
 368 inline wxSize operator*(const wxSize& s, unsigned long i)
 369 {
 370     return wxSize(s.x * i, s.y * i);
 371 }
 372
 373 inline wxSize operator*(unsigned long i, const wxSize& s)
 374 {
 375     return wxSize(s.x * i, s.y * i);
 376 }
 377
 378 inline wxSize operator*(const wxSize& s, double i)
 379 {
 380     return wxSize(int(s.x * i), int(s.y * i));
 381 }
 382
 383 inline wxSize operator*(double i, const wxSize& s)
 384 {
 385     return wxSize(int(s.x * i), int(s.y * i));
 386 }
 387
 388
 389
 390 // ---------------------------------------------------------------------------
 391 // Point classes: with real or integer coordinates
 392 // ---------------------------------------------------------------------------
 393
 394 class WXDLLIMPEXP_CORE wxRealPoint
 395 {
 396 public:
 397     double x;
 398     double y;
 399
 400     wxRealPoint() : x(0.0), y(0.0) { }
 401     wxRealPoint(double xx, double yy) : x(xx), y(yy) { }
 402     wxRealPoint(const wxPoint& pt);
 403
 404     // no copy ctor or assignment operator - the defaults are ok
 405
 406     //assignment operators
 407     wxRealPoint& operator+=(const wxRealPoint& p) { x += p.x; y += p.y; return *this; }
 408     wxRealPoint& operator-=(const wxRealPoint& p) { x -= p.x; y -= p.y; return *this; }
 409
 410     wxRealPoint& operator+=(const wxSize& s) { x += s.GetWidth(); y += s.GetHeight(); return *this; }
 411     wxRealPoint& operator-=(const wxSize& s) { x -= s.GetWidth(); y -= s.GetHeight(); return *this; }
 412 };
 413
 414
 415 inline bool operator==(const wxRealPoint& p1, const wxRealPoint& p2)
 416 {
 417     return wxIsSameDouble(p1.x, p2.x) && wxIsSameDouble(p1.y, p2.y);
 418 }
 419
 420 inline bool operator!=(const wxRealPoint& p1, const wxRealPoint& p2)
 421 {
 422     return !(p1 == p2);
 423 }
 424
 425 inline wxRealPoint operator+(const wxRealPoint& p1, const wxRealPoint& p2)
 426 {
 427     return wxRealPoint(p1.x + p2.x, p1.y + p2.y);
 428 }
 429
 430
 431 inline wxRealPoint operator-(const wxRealPoint& p1, const wxRealPoint& p2)
 432 {
 433     return wxRealPoint(p1.x - p2.x, p1.y - p2.y);
 434 }
 435
 436
 437 inline wxRealPoint operator/(const wxRealPoint& s, int i)
 438 {
 439     return wxRealPoint(s.x / i, s.y / i);
 440 }
 441
 442 inline wxRealPoint operator*(const wxRealPoint& s, int i)
 443 {
 444     return wxRealPoint(s.x * i, s.y * i);
 445 }
 446
 447 inline wxRealPoint operator*(int i, const wxRealPoint& s)
 448 {
 449     return wxRealPoint(s.x * i, s.y * i);
 450 }
 451
 452 inline wxRealPoint operator/(const wxRealPoint& s, unsigned int i)
 453 {
 454     return wxRealPoint(s.x / i, s.y / i);
 455 }
 456
 457 inline wxRealPoint operator*(const wxRealPoint& s, unsigned int i)
 458 {
 459     return wxRealPoint(s.x * i, s.y * i);
 460 }
 461
 462 inline wxRealPoint operator*(unsigned int i, const wxRealPoint& s)
 463 {
 464     return wxRealPoint(s.x * i, s.y * i);
 465 }
 466
 467 inline wxRealPoint operator/(const wxRealPoint& s, long i)
 468 {
 469     return wxRealPoint(s.x / i, s.y / i);
 470 }
 471
 472 inline wxRealPoint operator*(const wxRealPoint& s, long i)
 473 {
 474     return wxRealPoint(s.x * i, s.y * i);
 475 }
 476
 477 inline wxRealPoint operator*(long i, const wxRealPoint& s)
 478 {
 479     return wxRealPoint(s.x * i, s.y * i);
 480 }
 481
 482 inline wxRealPoint operator/(const wxRealPoint& s, unsigned long i)
 483 {
 484     return wxRealPoint(s.x / i, s.y / i);
 485 }
 486
 487 inline wxRealPoint operator*(const wxRealPoint& s, unsigned long i)
 488 {
 489     return wxRealPoint(s.x * i, s.y * i);
 490 }
 491
 492 inline wxRealPoint operator*(unsigned long i, const wxRealPoint& s)
 493 {
 494     return wxRealPoint(s.x * i, s.y * i);
 495 }
 496
 497 inline wxRealPoint operator*(const wxRealPoint& s, double i)
 498 {
 499     return wxRealPoint(int(s.x * i), int(s.y * i));
 500 }
 501
 502 inline wxRealPoint operator*(double i, const wxRealPoint& s)
 503 {
 504     return wxRealPoint(int(s.x * i), int(s.y * i));
 505 }
 506
 507
 508 // ----------------------------------------------------------------------------
 509 // wxPoint: 2D point with integer coordinates
 510 // ----------------------------------------------------------------------------
 511
 512 class WXDLLIMPEXP_CORE wxPoint
 513 {
 514 public:
 515     int x, y;
 516
 517     wxPoint() : x(0), y(0) { }
 518     wxPoint(int xx, int yy) : x(xx), y(yy) { }
 519     wxPoint(const wxRealPoint& pt) : x(int(pt.x)), y(int(pt.y)) { }
 520
 521     // no copy ctor or assignment operator - the defaults are ok
 522
 523     //assignment operators
 524     wxPoint& operator+=(const wxPoint& p) { x += p.x; y += p.y; return *this; }
 525     wxPoint& operator-=(const wxPoint& p) { x -= p.x; y -= p.y; return *this; }
 526
 527     wxPoint& operator+=(const wxSize& s) { x += s.GetWidth(); y += s.GetHeight(); return *this; }
 528     wxPoint& operator-=(const wxSize& s) { x -= s.GetWidth(); y -= s.GetHeight(); return *this; }
 529
 530     // check if both components are set/initialized
 531     bool IsFullySpecified() const { return x != wxDefaultCoord && y != wxDefaultCoord; }
 532
 533     // fill in the unset components with the values from the other point
 534     void SetDefaults(const wxPoint& pt)
 535     {
 536         if ( x == wxDefaultCoord )
 537             x = pt.x;
 538         if ( y == wxDefaultCoord )
 539             y = pt.y;
 540     }
 541 };
 542
 543
 544 // comparison
 545 inline bool operator==(const wxPoint& p1, const wxPoint& p2)
 546 {
 547     return p1.x == p2.x && p1.y == p2.y;
 548 }
 549
 550 inline bool operator!=(const wxPoint& p1, const wxPoint& p2)
 551 {
 552     return !(p1 == p2);
 553 }
 554
 555
 556 // arithmetic operations (component wise)
 557 inline wxPoint operator+(const wxPoint& p1, const wxPoint& p2)
 558 {
 559     return wxPoint(p1.x + p2.x, p1.y + p2.y);
 560 }
 561
 562 inline wxPoint operator-(const wxPoint& p1, const wxPoint& p2)
 563 {
 564     return wxPoint(p1.x - p2.x, p1.y - p2.y);
 565 }
 566
 567 inline wxPoint operator+(const wxPoint& p, const wxSize& s)
 568 {
 569     return wxPoint(p.x + s.x, p.y + s.y);
 570 }
 571
 572 inline wxPoint operator-(const wxPoint& p, const wxSize& s)
 573 {
 574     return wxPoint(p.x - s.x, p.y - s.y);
 575 }
 576
 577 inline wxPoint operator+(const wxSize& s, const wxPoint& p)
 578 {
 579     return wxPoint(p.x + s.x, p.y + s.y);
 580 }
 581
 582 inline wxPoint operator-(const wxSize& s, const wxPoint& p)
 583 {
 584     return wxPoint(s.x - p.x, s.y - p.y);
 585 }
 586
 587 inline wxPoint operator-(const wxPoint& p)
 588 {
 589     return wxPoint(-p.x, -p.y);
 590 }
 591
 592 inline wxPoint operator/(const wxPoint& s, int i)
 593 {
 594     return wxPoint(s.x / i, s.y / i);
 595 }
 596
 597 inline wxPoint operator*(const wxPoint& s, int i)
 598 {
 599     return wxPoint(s.x * i, s.y * i);
 600 }
 601
 602 inline wxPoint operator*(int i, const wxPoint& s)
 603 {
 604     return wxPoint(s.x * i, s.y * i);
 605 }
 606
 607 inline wxPoint operator/(const wxPoint& s, unsigned int i)
 608 {
 609     return wxPoint(s.x / i, s.y / i);
 610 }
 611
 612 inline wxPoint operator*(const wxPoint& s, unsigned int i)
 613 {
 614     return wxPoint(s.x * i, s.y * i);
 615 }
 616
 617 inline wxPoint operator*(unsigned int i, const wxPoint& s)
 618 {
 619     return wxPoint(s.x * i, s.y * i);
 620 }
 621
 622 inline wxPoint operator/(const wxPoint& s, long i)
 623 {
 624     return wxPoint(s.x / i, s.y / i);
 625 }
 626
 627 inline wxPoint operator*(const wxPoint& s, long i)
 628 {
 629     return wxPoint(s.x * i, s.y * i);
 630 }
 631
 632 inline wxPoint operator*(long i, const wxPoint& s)
 633 {
 634     return wxPoint(s.x * i, s.y * i);
 635 }
 636
 637 inline wxPoint operator/(const wxPoint& s, unsigned long i)
 638 {
 639     return wxPoint(s.x / i, s.y / i);
 640 }
 641
 642 inline wxPoint operator*(const wxPoint& s, unsigned long i)
 643 {
 644     return wxPoint(s.x * i, s.y * i);
 645 }
 646
 647 inline wxPoint operator*(unsigned long i, const wxPoint& s)
 648 {
 649     return wxPoint(s.x * i, s.y * i);
 650 }
 651
 652 inline wxPoint operator*(const wxPoint& s, double i)
 653 {
 654     return wxPoint(int(s.x * i), int(s.y * i));
 655 }
 656
 657 inline wxPoint operator*(double i, const wxPoint& s)
 658 {
 659     return wxPoint(int(s.x * i), int(s.y * i));
 660 }
 661
 662 WX_DECLARE_LIST_WITH_DECL(wxPoint, wxPointList, class WXDLLIMPEXP_CORE);
 663
 664 // ---------------------------------------------------------------------------
 665 // wxRect
 666 // ---------------------------------------------------------------------------
 667
 668 class WXDLLIMPEXP_CORE wxRect
 669 {
 670 public:
 671     wxRect()
 672         : x(0), y(0), width(0), height(0)
 673         { }
 674     wxRect(int xx, int yy, int ww, int hh)
 675         : x(xx), y(yy), width(ww), height(hh)
 676         { }
 677     wxRect(const wxPoint& topLeft, const wxPoint& bottomRight);
 678     wxRect(const wxPoint& pt, const wxSize& size)
 679         : x(pt.x), y(pt.y), width(size.x), height(size.y)
 680         { }
 681     wxRect(const wxSize& size)
 682         : x(0), y(0), width(size.x), height(size.y)
 683         { }
 684
 685     // default copy ctor and assignment operators ok
 686
 687     int GetX() const { return x; }
 688     void SetX(int xx) { x = xx; }
 689
 690     int GetY() const { return y; }
 691     void SetY(int yy) { y = yy; }
 692
 693     int GetWidth() const { return width; }
 694     void SetWidth(int w) { width = w; }
 695
 696     int GetHeight() const { return height; }
 697     void SetHeight(int h) { height = h; }
 698
 699     wxPoint GetPosition() const { return wxPoint(x, y); }
 700     void SetPosition( const wxPoint &p ) { x = p.x; y = p.y; }
 701
 702     wxSize GetSize() const { return wxSize(width, height); }
 703     void SetSize( const wxSize &s ) { width = s.GetWidth(); height = s.GetHeight(); }
 704
 705     bool IsEmpty() const { return (width <= 0) || (height <= 0); }
 706
 707     int GetLeft()   const { return x; }
 708     int GetTop()    const { return y; }
 709     int GetBottom() const { return y + height - 1; }
 710     int GetRight()  const { return x + width - 1; }
 711
 712     void SetLeft(int left) { x = left; }
 713     void SetRight(int right) { width = right - x + 1; }
 714     void SetTop(int top) { y = top; }
 715     void SetBottom(int bottom) { height = bottom - y + 1; }
 716
 717     wxPoint GetTopLeft() const { return GetPosition(); }
 718     wxPoint GetLeftTop() const { return GetTopLeft(); }
 719     void SetTopLeft(const wxPoint &p) { SetPosition(p); }
 720     void SetLeftTop(const wxPoint &p) { SetTopLeft(p); }
 721
 722     wxPoint GetBottomRight() const { return wxPoint(GetRight(), GetBottom()); }
 723     wxPoint GetRightBottom() const { return GetBottomRight(); }
 724     void SetBottomRight(const wxPoint &p) { SetRight(p.x); SetBottom(p.y); }
 725     void SetRightBottom(const wxPoint &p) { SetBottomRight(p); }
 726
 727     wxPoint GetTopRight() const { return wxPoint(GetRight(), GetTop()); }
 728     wxPoint GetRightTop() const { return GetTopRight(); }
 729     void SetTopRight(const wxPoint &p) { SetRight(p.x); SetTop(p.y); }
 730     void SetRightTop(const wxPoint &p) { SetTopRight(p); }
 731
 732     wxPoint GetBottomLeft() const { return wxPoint(GetLeft(), GetBottom()); }
 733     wxPoint GetLeftBottom() const { return GetBottomLeft(); }
 734     void SetBottomLeft(const wxPoint &p) { SetLeft(p.x); SetBottom(p.y); }
 735     void SetLeftBottom(const wxPoint &p) { SetBottomLeft(p); }
 736
 737     // operations with rect
 738     wxRect& Inflate(wxCoord dx, wxCoord dy);
 739     wxRect& Inflate(const wxSize& d) { return Inflate(d.x, d.y); }
 740     wxRect& Inflate(wxCoord d) { return Inflate(d, d); }
 741     wxRect Inflate(wxCoord dx, wxCoord dy) const
 742     {
 743         wxRect r = *this;
 744         r.Inflate(dx, dy);
 745         return r;
 746     }
 747
 748     wxRect& Deflate(wxCoord dx, wxCoord dy) { return Inflate(-dx, -dy); }
 749     wxRect& Deflate(const wxSize& d) { return Inflate(-d.x, -d.y); }
 750     wxRect& Deflate(wxCoord d) { return Inflate(-d); }
 751     wxRect Deflate(wxCoord dx, wxCoord dy) const
 752     {
 753         wxRect r = *this;
 754         r.Deflate(dx, dy);
 755         return r;
 756     }
 757
 758     void Offset(wxCoord dx, wxCoord dy) { x += dx; y += dy; }
 759     void Offset(const wxPoint& pt) { Offset(pt.x, pt.y); }
 760
 761     wxRect& Intersect(const wxRect& rect);
 762     wxRect Intersect(const wxRect& rect) const
 763     {
 764         wxRect r = *this;
 765         r.Intersect(rect);
 766         return r;
 767     }
 768
 769     wxRect& Union(const wxRect& rect);
 770     wxRect Union(const wxRect& rect) const
 771     {
 772         wxRect r = *this;
 773         r.Union(rect);
 774         return r;
 775     }
 776
 777     // return true if the point is (not strcitly) inside the rect
 778     bool Contains(int x, int y) const;
 779     bool Contains(const wxPoint& pt) const { return Contains(pt.x, pt.y); }
 780     // return true if the rectangle 'rect' is (not strictly) inside this rect
 781     bool Contains(const wxRect& rect) const;
 782
 783 #if WXWIN_COMPATIBILITY_2_6
 784     // use Contains() instead
 785     wxDEPRECATED( bool Inside(int x, int y) const );
 786     wxDEPRECATED( bool Inside(const wxPoint& pt) const );
 787     wxDEPRECATED( bool Inside(const wxRect& rect) const );
 788 #endif // WXWIN_COMPATIBILITY_2_6
 789
 790     // return true if the rectangles have a non empty intersection
 791     bool Intersects(const wxRect& rect) const;
 792
 793     // like Union() but don't ignore empty rectangles
 794     wxRect& operator+=(const wxRect& rect);
 795
 796     // intersections of two rectrangles not testing for empty rectangles
 797     wxRect& operator*=(const wxRect& rect);
 798
 799     // centre this rectangle in the given (usually, but not necessarily,
 800     // larger) one
 801     wxRect CentreIn(const wxRect& r, int dir = wxBOTH) const
 802     {
 803         return wxRect(dir & wxHORIZONTAL ? r.x + (r.width - width)/2 : x,
 804                       dir & wxVERTICAL ? r.y + (r.height - height)/2 : y,
 805                       width, height);
 806     }
 807
 808     wxRect CenterIn(const wxRect& r, int dir = wxBOTH) const
 809     {
 810         return CentreIn(r, dir);
 811     }
 812
 813 public:
 814     int x, y, width, height;
 815 };
 816
 817
 818 // compare rectangles
 819 inline bool operator==(const wxRect& r1, const wxRect& r2)
 820 {
 821     return (r1.x == r2.x) && (r1.y == r2.y) &&
 822            (r1.width == r2.width) && (r1.height == r2.height);
 823 }
 824
 825 inline bool operator!=(const wxRect& r1, const wxRect& r2)
 826 {
 827     return !(r1 == r2);
 828 }
 829
 830 // like Union() but don't treat empty rectangles specially
 831 WXDLLIMPEXP_CORE wxRect operator+(const wxRect& r1, const wxRect& r2);
 832
 833 // intersections of two rectangles
 834 WXDLLIMPEXP_CORE wxRect operator*(const wxRect& r1, const wxRect& r2);
 835
 836
 837
 838
 839 #if WXWIN_COMPATIBILITY_2_6
 840 inline bool wxRect::Inside(int cx, int cy) const { return Contains(cx, cy); }
 841 inline bool wxRect::Inside(const wxPoint& pt) const { return Contains(pt); }
 842 inline bool wxRect::Inside(const wxRect& rect) const { return Contains(rect); }
 843 #endif // WXWIN_COMPATIBILITY_2_6
 844
 845
 846 // define functions which couldn't be defined above because of declarations
 847 // order
 848 inline void wxSize::IncBy(const wxPoint& pt) { IncBy(pt.x, pt.y); }
 849 inline void wxSize::DecBy(const wxPoint& pt) { DecBy(pt.x, pt.y); }
 850
 851 // ---------------------------------------------------------------------------
 852 // Management of pens, brushes and fonts
 853 // ---------------------------------------------------------------------------
 854
 855 typedef wxInt8 wxDash;
 856
 857 class WXDLLIMPEXP_CORE wxGDIObjListBase {
 858 public:
 859     wxGDIObjListBase();
 860     ~wxGDIObjListBase();
 861
 862 protected:
 863     wxList list;
 864 };
 865
 866 WX_DECLARE_STRING_HASH_MAP(wxColour*, wxStringToColourHashMap);
 867
 868 class WXDLLIMPEXP_CORE wxColourDatabase
 869 {
 870 public:
 871     wxColourDatabase();
 872     ~wxColourDatabase();
 873
 874     // find colour by name or name for the given colour
 875     wxColour Find(const wxString& name) const;
 876     wxString FindName(const wxColour& colour) const;
 877
 878     // add a new colour to the database
 879     void AddColour(const wxString& name, const wxColour& colour);
 880
 881 #if WXWIN_COMPATIBILITY_2_6
 882     // deprecated, use Find() instead
 883     wxDEPRECATED( wxColour *FindColour(const wxString& name) );
 884 #endif // WXWIN_COMPATIBILITY_2_6
 885
 886
 887 #ifdef __WXPM__
 888     // PM keeps its own type of colour table
 889     long*                           m_palTable;
 890     size_t                          m_nSize;
 891 #endif
 892
 893 private:
 894     // load the database with the built in colour values when called for the
 895     // first time, do nothing after this
 896     void Initialize();
 897
 898     wxStringToColourHashMap *m_map;
 899 };
 900
 901 class WXDLLIMPEXP_CORE wxResourceCache: public wxList
 902 {
 903 public:
 904     wxResourceCache() { }
 905 #if !wxUSE_STD_CONTAINERS
 906     wxResourceCache(const unsigned int keyType) : wxList(keyType) { }
 907 #endif
 908     virtual ~wxResourceCache();
 909 };
 910
 911 // ---------------------------------------------------------------------------
 912 // global variables
 913 // ---------------------------------------------------------------------------
 914
 915
 916 /* Stock objects
 917
 918   wxStockGDI creates the stock GDI objects on demand.  Pointers to the
 919   created objects are stored in the ms_stockObject array, which is indexed
 920   by the Item enum values.  Platorm-specific fonts can be created by
 921   implementing a derived class with an override for the GetFont function.
 922   wxStockGDI operates as a singleton, accessed through the ms_instance
 923   pointer.  By default this pointer is set to an instance of wxStockGDI.
 924   A derived class must arrange to set this pointer to an instance of itself.
 925 */
 926 class WXDLLIMPEXP_CORE wxStockGDI
 927 {
 928 public:
 929     enum Item {
 930         BRUSH_BLACK,
 931         BRUSH_BLUE,
 932         BRUSH_CYAN,
 933         BRUSH_GREEN,
 934         BRUSH_YELLOW,
 935         BRUSH_GREY,
 936         BRUSH_LIGHTGREY,
 937         BRUSH_MEDIUMGREY,
 938         BRUSH_RED,
 939         BRUSH_TRANSPARENT,
 940         BRUSH_WHITE,
 941         COLOUR_BLACK,
 942         COLOUR_BLUE,
 943         COLOUR_CYAN,
 944         COLOUR_GREEN,
 945         COLOUR_YELLOW,
 946         COLOUR_LIGHTGREY,
 947         COLOUR_RED,
 948         COLOUR_WHITE,
 949         CURSOR_CROSS,
 950         CURSOR_HOURGLASS,
 951         CURSOR_STANDARD,
 952         FONT_ITALIC,
 953         FONT_NORMAL,
 954         FONT_SMALL,
 955         FONT_SWISS,
 956         PEN_BLACK,
 957         PEN_BLACKDASHED,
 958         PEN_BLUE,
 959         PEN_CYAN,
 960         PEN_GREEN,
 961         PEN_YELLOW,
 962         PEN_GREY,
 963         PEN_LIGHTGREY,
 964         PEN_MEDIUMGREY,
 965         PEN_RED,
 966         PEN_TRANSPARENT,
 967         PEN_WHITE,
 968         ITEMCOUNT
 969     };
 970
 971     wxStockGDI();
 972     virtual ~wxStockGDI();
 973     static void DeleteAll();
 974
 975     static wxStockGDI& instance() { return *ms_instance; }
 976
 977     static const wxBrush* GetBrush(Item item);
 978     static const wxColour* GetColour(Item item);
 979     static const wxCursor* GetCursor(Item item);
 980     // Can be overridden by platform-specific derived classes
 981     virtual const wxFont* GetFont(Item item);
 982     static const wxPen* GetPen(Item item);
 983
 984 protected:
 985     static wxStockGDI* ms_instance;
 986
 987     static wxObject* ms_stockObject[ITEMCOUNT];
 988
 989     wxDECLARE_NO_COPY_CLASS(wxStockGDI);
 990 };
 991
 992 #define wxITALIC_FONT  wxStockGDI::instance().GetFont(wxStockGDI::FONT_ITALIC)
 993 #define wxNORMAL_FONT  wxStockGDI::instance().GetFont(wxStockGDI::FONT_NORMAL)
 994 #define wxSMALL_FONT   wxStockGDI::instance().GetFont(wxStockGDI::FONT_SMALL)
 995 #define wxSWISS_FONT   wxStockGDI::instance().GetFont(wxStockGDI::FONT_SWISS)
 996
 997 #define wxBLACK_DASHED_PEN  wxStockGDI::GetPen(wxStockGDI::PEN_BLACKDASHED)
 998 #define wxBLACK_PEN         wxStockGDI::GetPen(wxStockGDI::PEN_BLACK)
 999 #define wxBLUE_PEN          wxStockGDI::GetPen(wxStockGDI::PEN_BLUE)
1000 #define wxCYAN_PEN          wxStockGDI::GetPen(wxStockGDI::PEN_CYAN)
1001 #define wxGREEN_PEN         wxStockGDI::GetPen(wxStockGDI::PEN_GREEN)
1002 #define wxYELLOW_PEN        wxStockGDI::GetPen(wxStockGDI::PEN_YELLOW)
1003 #define wxGREY_PEN          wxStockGDI::GetPen(wxStockGDI::PEN_GREY)
1004 #define wxLIGHT_GREY_PEN    wxStockGDI::GetPen(wxStockGDI::PEN_LIGHTGREY)
1005 #define wxMEDIUM_GREY_PEN   wxStockGDI::GetPen(wxStockGDI::PEN_MEDIUMGREY)
1006 #define wxRED_PEN           wxStockGDI::GetPen(wxStockGDI::PEN_RED)
1007 #define wxTRANSPARENT_PEN   wxStockGDI::GetPen(wxStockGDI::PEN_TRANSPARENT)
1008 #define wxWHITE_PEN         wxStockGDI::GetPen(wxStockGDI::PEN_WHITE)
1009
1010 #define wxBLACK_BRUSH        wxStockGDI::GetBrush(wxStockGDI::BRUSH_BLACK)
1011 #define wxBLUE_BRUSH         wxStockGDI::GetBrush(wxStockGDI::BRUSH_BLUE)
1012 #define wxCYAN_BRUSH         wxStockGDI::GetBrush(wxStockGDI::BRUSH_CYAN)
1013 #define wxGREEN_BRUSH        wxStockGDI::GetBrush(wxStockGDI::BRUSH_GREEN)
1014 #define wxYELLOW_BRUSH       wxStockGDI::GetBrush(wxStockGDI::BRUSH_YELLOW)
1015 #define wxGREY_BRUSH         wxStockGDI::GetBrush(wxStockGDI::BRUSH_GREY)
1016 #define wxLIGHT_GREY_BRUSH   wxStockGDI::GetBrush(wxStockGDI::BRUSH_LIGHTGREY)
1017 #define wxMEDIUM_GREY_BRUSH  wxStockGDI::GetBrush(wxStockGDI::BRUSH_MEDIUMGREY)
1018 #define wxRED_BRUSH          wxStockGDI::GetBrush(wxStockGDI::BRUSH_RED)
1019 #define wxTRANSPARENT_BRUSH  wxStockGDI::GetBrush(wxStockGDI::BRUSH_TRANSPARENT)
1020 #define wxWHITE_BRUSH        wxStockGDI::GetBrush(wxStockGDI::BRUSH_WHITE)
1021
1022 #define wxBLACK       wxStockGDI::GetColour(wxStockGDI::COLOUR_BLACK)
1023 #define wxBLUE        wxStockGDI::GetColour(wxStockGDI::COLOUR_BLUE)
1024 #define wxCYAN        wxStockGDI::GetColour(wxStockGDI::COLOUR_CYAN)
1025 #define wxGREEN       wxStockGDI::GetColour(wxStockGDI::COLOUR_GREEN)
1026 #define wxYELLOW      wxStockGDI::GetColour(wxStockGDI::COLOUR_YELLOW)
1027 #define wxLIGHT_GREY  wxStockGDI::GetColour(wxStockGDI::COLOUR_LIGHTGREY)
1028 #define wxRED         wxStockGDI::GetColour(wxStockGDI::COLOUR_RED)
1029 #define wxWHITE       wxStockGDI::GetColour(wxStockGDI::COLOUR_WHITE)
1030
1031 #define wxCROSS_CURSOR      wxStockGDI::GetCursor(wxStockGDI::CURSOR_CROSS)
1032 #define wxHOURGLASS_CURSOR  wxStockGDI::GetCursor(wxStockGDI::CURSOR_HOURGLASS)
1033 #define wxSTANDARD_CURSOR   wxStockGDI::GetCursor(wxStockGDI::CURSOR_STANDARD)
1034
1035 // 'Null' objects
1036 extern WXDLLIMPEXP_DATA_CORE(wxBitmap)     wxNullBitmap;
1037 extern WXDLLIMPEXP_DATA_CORE(wxIcon)       wxNullIcon;
1038 extern WXDLLIMPEXP_DATA_CORE(wxCursor)     wxNullCursor;
1039 extern WXDLLIMPEXP_DATA_CORE(wxPen)        wxNullPen;
1040 extern WXDLLIMPEXP_DATA_CORE(wxBrush)      wxNullBrush;
1041 extern WXDLLIMPEXP_DATA_CORE(wxPalette)    wxNullPalette;
1042 extern WXDLLIMPEXP_DATA_CORE(wxFont)       wxNullFont;
1043 extern WXDLLIMPEXP_DATA_CORE(wxColour)     wxNullColour;
1044 extern WXDLLIMPEXP_DATA_CORE(wxIconBundle) wxNullIconBundle;
1045
1046 extern WXDLLIMPEXP_DATA_CORE(wxColourDatabase*)  wxTheColourDatabase;
1047
1048 extern WXDLLIMPEXP_DATA_CORE(const char) wxPanelNameStr[];
1049
1050 extern WXDLLIMPEXP_DATA_CORE(const wxSize) wxDefaultSize;
1051 extern WXDLLIMPEXP_DATA_CORE(const wxPoint) wxDefaultPosition;
1052
1053 // ---------------------------------------------------------------------------
1054 // global functions
1055 // ---------------------------------------------------------------------------
1056
1057 // resource management
1058 extern void WXDLLIMPEXP_CORE wxInitializeStockLists();
1059 extern void WXDLLIMPEXP_CORE wxDeleteStockLists();
1060
1061 // is the display colour (or monochrome)?
1062 extern bool WXDLLIMPEXP_CORE wxColourDisplay();
1063
1064 // Returns depth of screen
1065 extern int WXDLLIMPEXP_CORE wxDisplayDepth();
1066 #define wxGetDisplayDepth wxDisplayDepth
1067
1068 // get the display size
1069 extern void WXDLLIMPEXP_CORE wxDisplaySize(int *width, int *height);
1070 extern wxSize WXDLLIMPEXP_CORE wxGetDisplaySize();
1071 extern void WXDLLIMPEXP_CORE wxDisplaySizeMM(int *width, int *height);
1072 extern wxSize WXDLLIMPEXP_CORE wxGetDisplaySizeMM();
1073 extern wxSize WXDLLIMPEXP_CORE wxGetDisplayPPI();
1074
1075 // Get position and size of the display workarea
1076 extern void WXDLLIMPEXP_CORE wxClientDisplayRect(int *x, int *y, int *width, int *height);
1077 extern wxRect WXDLLIMPEXP_CORE wxGetClientDisplayRect();
1078
1079 // set global cursor
1080 extern void WXDLLIMPEXP_CORE wxSetCursor(const wxCursor& cursor);
1081
1082 #endif
1083     // _WX_GDICMNH__