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