interface/wx/gdicmn.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        gdicmn.h
   3 // Purpose:     interface of wxRealPoint
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows licence
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9
  10 /**
  11     Bitmap type flags. See wxBitmap and wxImage classes.
  12 */
  13 enum wxBitmapType
  14 {
  15     wxBITMAP_TYPE_INVALID,
  16     wxBITMAP_TYPE_BMP,
  17     wxBITMAP_TYPE_BMP_RESOURCE,
  18     wxBITMAP_TYPE_RESOURCE = wxBITMAP_TYPE_BMP_RESOURCE,
  19     wxBITMAP_TYPE_ICO,
  20     wxBITMAP_TYPE_ICO_RESOURCE,
  21     wxBITMAP_TYPE_CUR,
  22     wxBITMAP_TYPE_CUR_RESOURCE,
  23     wxBITMAP_TYPE_XBM,
  24     wxBITMAP_TYPE_XBM_DATA,
  25     wxBITMAP_TYPE_XPM,
  26     wxBITMAP_TYPE_XPM_DATA,
  27     wxBITMAP_TYPE_TIFF,
  28     wxBITMAP_TYPE_TIF = wxBITMAP_TYPE_TIFF,
  29     wxBITMAP_TYPE_TIFF_RESOURCE,
  30     wxBITMAP_TYPE_TIF_RESOURCE = wxBITMAP_TYPE_TIFF_RESOURCE,
  31     wxBITMAP_TYPE_GIF,
  32     wxBITMAP_TYPE_GIF_RESOURCE,
  33     wxBITMAP_TYPE_PNG,
  34     wxBITMAP_TYPE_PNG_RESOURCE,
  35     wxBITMAP_TYPE_JPEG,
  36     wxBITMAP_TYPE_JPEG_RESOURCE,
  37     wxBITMAP_TYPE_PNM,
  38     wxBITMAP_TYPE_PNM_RESOURCE,
  39     wxBITMAP_TYPE_PCX,
  40     wxBITMAP_TYPE_PCX_RESOURCE,
  41     wxBITMAP_TYPE_PICT,
  42     wxBITMAP_TYPE_PICT_RESOURCE,
  43     wxBITMAP_TYPE_ICON,
  44     wxBITMAP_TYPE_ICON_RESOURCE,
  45     wxBITMAP_TYPE_ANI,
  46     wxBITMAP_TYPE_IFF,
  47     wxBITMAP_TYPE_TGA,
  48     wxBITMAP_TYPE_MACCURSOR,
  49     wxBITMAP_TYPE_MACCURSOR_RESOURCE,
  50     wxBITMAP_TYPE_ANY = 50
  51 };
  52
  53 /**
  54     Polygon filling mode. See wxDC::DrawPolygon.
  55 */
  56 enum wxPolygonFillMode
  57 {
  58     wxODDEVEN_RULE = 1,
  59     wxWINDING_RULE
  60 };
  61
  62 /**
  63     Standard cursors.
  64
  65     Notice that under wxMSW some of these cursors are defined in @c wx.rc file
  66     and not by the system itself so you should include this file from your own
  67     resource file (possibly creating a trivial resource file just containing a
  68     single include line if you don't need it otherwise) to be able to use them.
  69
  70     See wxCursor.
  71 */
  72 enum wxStockCursor
  73 {
  74     wxCURSOR_NONE,
  75     wxCURSOR_ARROW,             ///< A standard arrow cursor.
  76     wxCURSOR_RIGHT_ARROW,       ///< A standard arrow cursor pointing to the right.
  77     wxCURSOR_BULLSEYE,          ///< Bullseye cursor.
  78     wxCURSOR_CHAR,              ///< Rectangular character cursor.
  79     wxCURSOR_CROSS,             ///< A cross cursor.
  80     wxCURSOR_HAND,              ///< A hand cursor.
  81     wxCURSOR_IBEAM,             ///< An I-beam cursor (vertical line).
  82     wxCURSOR_LEFT_BUTTON,       ///< Represents a mouse with the left button depressed.
  83     wxCURSOR_MAGNIFIER,         ///< A magnifier icon.
  84     wxCURSOR_MIDDLE_BUTTON,     ///< Represents a mouse with the middle button depressed.
  85     wxCURSOR_NO_ENTRY,          ///< A no-entry sign cursor.
  86     wxCURSOR_PAINT_BRUSH,       ///< A paintbrush cursor.
  87     wxCURSOR_PENCIL,            ///< A pencil cursor.
  88     wxCURSOR_POINT_LEFT,        ///< A cursor that points left.
  89     wxCURSOR_POINT_RIGHT,       ///< A cursor that points right.
  90     wxCURSOR_QUESTION_ARROW,    ///< An arrow and question mark.
  91     wxCURSOR_RIGHT_BUTTON,      ///< Represents a mouse with the right button depressed.
  92     wxCURSOR_SIZENESW,          ///< A sizing cursor pointing NE-SW.
  93     wxCURSOR_SIZENS,            ///< A sizing cursor pointing N-S.
  94     wxCURSOR_SIZENWSE,          ///< A sizing cursor pointing NW-SE.
  95     wxCURSOR_SIZEWE,            ///< A sizing cursor pointing W-E.
  96     wxCURSOR_SIZING,            ///< A general sizing cursor.
  97     wxCURSOR_SPRAYCAN,          ///< A spraycan cursor.
  98     wxCURSOR_WAIT,              ///< A wait cursor.
  99     wxCURSOR_WATCH,             ///< A watch cursor.
 100     wxCURSOR_BLANK,             ///< Transparent cursor.
 101     wxCURSOR_DEFAULT,           ///< Standard X11 cursor (only in wxGTK).
 102     wxCURSOR_COPY_ARROW ,       ///< MacOS Theme Plus arrow (only in wxMac).
 103     wxCURSOR_CROSS_REVERSE,     ///< Only available on wxX11.
 104     wxCURSOR_DOUBLE_ARROW,      ///< Only available on wxX11.
 105     wxCURSOR_BASED_ARROW_UP,    ///< Only available on wxX11.
 106     wxCURSOR_BASED_ARROW_DOWN,  ///< Only available on wxX11.
 107     wxCURSOR_ARROWWAIT,         ///< A wait cursor with a standard arrow.
 108     wxCURSOR_MAX
 109 };
 110
 111
 112
 113 /**
 114     @class wxRealPoint
 115
 116     A wxRealPoint is a useful data structure for graphics operations.
 117
 118     It contains floating point @e x and @e y members.
 119     See wxPoint for an integer version.
 120
 121     Note that the coordinates stored inside a wxRealPoint object may be negative
 122     and that wxRealPoint functions do not perform any check against negative values.
 123
 124     @library{wxcore}
 125     @category{data}
 126
 127     @see wxPoint
 128 */
 129 class wxRealPoint
 130 {
 131 public:
 132     /**
 133         Initializes to zero the x and y members.
 134     */
 135     wxRealPoint();
 136
 137     /**
 138         Initializes the point with the given coordinates.
 139     */
 140     wxRealPoint(double x, double y);
 141
 142     /**
 143         Converts the given wxPoint (with integer coordinates) to a wxRealPoint.
 144     */
 145     wxRealPoint(const wxPoint& pt);
 146
 147     /**
 148         @name Miscellaneous operators
 149
 150         Note that these operators are documented as class members
 151         (to make them easier to find) but, as their prototype shows,
 152         they are implemented as global operators; note that this is
 153         transparent to the user but it helps to understand why the
 154         following functions are documented to take the wxPoint they
 155         operate on as an explicit argument.
 156     */
 157     //@{
 158     wxRealPoint& operator=(const wxRealPoint& pt);
 159
 160     bool operator ==(const wxRealPoint& p1, const wxRealPoint& p2);
 161     bool operator !=(const wxRealPoint& p1, const wxRealPoint& p2);
 162
 163     wxRealPoint operator +(const wxRealPoint& p1, const wxRealPoint& p2);
 164     wxRealPoint operator -(const wxRealPoint& p1, const wxRealPoint& p2);
 165
 166     wxRealPoint& operator +=(const wxRealPoint& pt);
 167     wxRealPoint& operator -=(const wxRealPoint& pt);
 168
 169     wxRealPoint operator +(const wxRealPoint& pt, const wxSize& sz);
 170     wxRealPoint operator -(const wxRealPoint& pt, const wxSize& sz);
 171     wxRealPoint operator +(const wxSize& sz, const wxRealPoint& pt);
 172     wxRealPoint operator -(const wxSize& sz, const wxRealPoint& pt);
 173
 174     wxRealPoint& operator +=(const wxSize& sz);
 175     wxRealPoint& operator -=(const wxSize& sz);
 176
 177     wxSize operator /(const wxRealPoint& sz, int factor);
 178     wxSize operator *(const wxRealPoint& sz, int factor);
 179     wxSize operator *(int factor, const wxSize& sz);
 180     wxSize& operator /=(int factor);
 181     wxSize& operator *=(int factor);
 182     //@}
 183
 184     /**
 185         X coordinate of this point.
 186     */
 187     double x;
 188
 189     /**
 190         Y coordinate of this point.
 191     */
 192     double y;
 193 };
 194
 195
 196
 197 /**
 198     @class wxRect
 199
 200     A class for manipulating rectangles.
 201
 202     Note that the x, y coordinates and the width and height stored inside a wxRect
 203     object may be negative and that wxRect functions do not perform any check against
 204     negative values.
 205
 206     @library{wxcore}
 207     @category{data}
 208
 209     @see wxPoint, wxSize
 210 */
 211 class wxRect
 212 {
 213 public:
 214     /**
 215         Default constructor.
 216         Initializes to zero the internal @a x, @a y, @a width and @a height members.
 217     */
 218     wxRect();
 219     /**
 220         Creates a wxRect object from @a x, @a y, @a width and @a height values.
 221     */
 222     wxRect(int x, int y, int width, int height);
 223     /**
 224         Creates a wxRect object from top-left and bottom-right points.
 225     */
 226     wxRect(const wxPoint& topLeft, const wxPoint& bottomRight);
 227     /**
 228         Creates a wxRect object from position @a pos and @a size values.
 229     */
 230     wxRect(const wxPoint& pos, const wxSize& size);
 231     /**
 232         Creates a wxRect object from @a size values at the origin.
 233     */
 234     wxRect(const wxSize& size);
 235
 236     //@{
 237     /**
 238         Returns the rectangle having the same size as this one but centered
 239         relatively to the given rectangle @a r. By default, rectangle is
 240         centred in both directions but if @a dir includes only @c wxVERTICAL or
 241         only @c wxHORIZONTAL, then it is only centered in this direction while
 242         the other component of its position remains unchanged.
 243     */
 244     wxRect CentreIn(const wxRect& r, int dir = wxBOTH) const;
 245     wxRect CenterIn(const wxRect& r, int dir = wxBOTH) const;
 246     //@}
 247
 248     /**
 249         Returns @true if the given point is inside the rectangle (or on its
 250         boundary) and @false otherwise.
 251     */
 252     bool Contains(int x, int y) const;
 253     /**
 254         Returns @true if the given point is inside the rectangle (or on its
 255         boundary) and @false otherwise.
 256     */
 257     bool Contains(const wxPoint& pt) const;
 258     /**
 259         Returns @true if the given rectangle is completely inside this
 260         rectangle (or touches its boundary) and @false otherwise.
 261     */
 262     bool Contains(const wxRect& rect) const;
 263
 264     //@{
 265     /**
 266         Decrease the rectangle size.
 267
 268         This method is the opposite from Inflate(): Deflate(a, b) is equivalent
 269         to Inflate(-a, -b). Please refer to Inflate() for full description.
 270     */
 271     wxRect& Deflate(wxCoord dx, wxCoord dy);
 272     wxRect& Deflate(const wxSize& diff);
 273     wxRect& Deflate(wxCoord diff);
 274     wxRect  Deflate(wxCoord dx, wxCoord dy) const;
 275     //@}
 276
 277     /**
 278         Gets the bottom point of the rectangle.
 279     */
 280     int GetBottom() const;
 281
 282     /**
 283         Gets the position of the bottom left corner.
 284     */
 285     wxPoint GetBottomLeft() const;
 286
 287     /**
 288         Gets the position of the bottom right corner.
 289     */
 290     wxPoint GetBottomRight() const;
 291
 292     /**
 293         Gets the height member.
 294     */
 295     int GetHeight() const;
 296
 297     /**
 298         Gets the left point of the rectangle (the same as GetX()).
 299     */
 300     int GetLeft() const;
 301
 302     /**
 303         Gets the position.
 304     */
 305     wxPoint GetPosition() const;
 306
 307     /**
 308         Gets the right point of the rectangle.
 309     */
 310     int GetRight() const;
 311
 312     /**
 313         Gets the size.
 314
 315         @see SetSize()
 316     */
 317     wxSize GetSize() const;
 318
 319     /**
 320         Gets the top point of the rectangle (the same as GetY()).
 321     */
 322     int GetTop() const;
 323
 324     /**
 325         Gets the position of the top left corner of the rectangle, same as
 326         GetPosition().
 327     */
 328     wxPoint GetTopLeft() const;
 329
 330     /**
 331         Gets the position of the top right corner.
 332     */
 333     wxPoint GetTopRight() const;
 334
 335     /**
 336         Gets the width member.
 337     */
 338     int GetWidth() const;
 339
 340     /**
 341         Gets the x member.
 342     */
 343     int GetX() const;
 344
 345     /**
 346         Gets the y member.
 347     */
 348     int GetY() const;
 349
 350     //@{
 351     /**
 352         Increases the size of the rectangle.
 353
 354         The left border is moved farther left and the right border is moved
 355         farther right by @a dx. The upper border is moved farther up and the
 356         bottom border is moved farther down by @a dy. (Note that the width and
 357         height of the rectangle thus change by 2*dx and 2*dy, respectively.) If
 358         one or both of @a dx and @a dy are negative, the opposite happens: the
 359         rectangle size decreases in the respective direction.
 360
 361         Inflating and deflating behaves "naturally". Defined more precisely,
 362         that means:
 363         -# "Real" inflates (that is, @a dx and/or @a dy = 0) are not
 364            constrained. Thus inflating a rectangle can cause its upper left
 365            corner to move into the negative numbers. (2.5.4 and older forced
 366            the top left coordinate to not fall below (0, 0), which implied a
 367            forced move of the rectangle.)
 368         -# Deflates are clamped to not reduce the width or height of the
 369            rectangle below zero. In such cases, the top-left corner is
 370            nonetheless handled properly. For example, a rectangle at (10, 10)
 371            with size (20, 40) that is inflated by (-15, -15) will become
 372            located at (20, 25) at size (0, 10). Finally, observe that the width
 373            and height are treated independently. In the above example, the
 374            width is reduced by 20, whereas the height is reduced by the full 30
 375            (rather than also stopping at 20, when the width reached zero).
 376
 377         @see Deflate()
 378     */
 379     wxRect& Inflate(wxCoord dx, wxCoord dy);
 380     wxRect& Inflate(const wxSize& diff);
 381     wxRect& Inflate(wxCoord diff);
 382     wxRect Inflate(wxCoord dx, wxCoord dy) const;
 383     //@}
 384
 385     /**
 386         Modifies this rectangle to contain the overlapping portion of this rectangle
 387         and the one passed in as parameter.
 388
 389         @return This rectangle, modified.
 390     */
 391     wxRect& Intersect(const wxRect& rect);
 392
 393     /**
 394         Returns the overlapping portion of this rectangle and the one passed in as
 395         parameter.
 396     */
 397     wxRect Intersect(const wxRect& rect) const;
 398
 399     /**
 400         Returns @true if this rectangle has a non-empty intersection with the
 401         rectangle @a rect and @false otherwise.
 402     */
 403     bool Intersects(const wxRect& rect) const;
 404
 405     /**
 406         Returns @true if this rectangle has a width or height less than or
 407         equal to 0 and @false otherwise.
 408     */
 409     bool IsEmpty() const;
 410
 411     //@{
 412     /**
 413         Moves the rectangle by the specified offset. If @a dx is positive, the
 414         rectangle is moved to the right, if @a dy is positive, it is moved to the
 415         bottom, otherwise it is moved to the left or top respectively.
 416     */
 417     void Offset(wxCoord dx, wxCoord dy);
 418     void Offset(const wxPoint& pt);
 419     //@}
 420
 421     /**
 422         Sets the height.
 423     */
 424     void SetHeight(int height);
 425
 426     /**
 427         Sets the size.
 428
 429         @see GetSize()
 430     */
 431     void SetSize(const wxSize& s);
 432
 433     /**
 434         Sets the width.
 435     */
 436     void SetWidth(int width);
 437
 438     /**
 439         Sets the x position.
 440     */
 441     void SetX(int x);
 442
 443     /**
 444         Sets the y position.
 445     */
 446     void SetY(int y);
 447
 448     /**
 449        Set the left side of the rectangle.
 450
 451        Notice that because the rectangle stores its left side and width,
 452        calling SetLeft() changes the right side position too -- but does
 453        preserve the width.
 454     */
 455     void SetLeft(int left);
 456
 457     /**
 458        Set the right side of the rectangle.
 459
 460        Notice that this doesn't affect GetLeft() return value but changes the
 461        rectangle width to set its right side to the given position.
 462      */
 463     void SetRight(int right);
 464
 465     /**
 466        Set the top edge of the rectangle.
 467
 468        Notice that because the rectangle stores its top side and height,
 469        calling SetTop() changes the bottom side position too -- but does
 470        preserve the height.
 471      */
 472     void SetTop(int top);
 473
 474     /**
 475        Set the bottom edge of the rectangle.
 476
 477        Notice that this doesn't affect GetTop() return value but changes the
 478        rectangle height to set its bottom side to the given position.
 479      */
 480     void SetBottom(int bottom);
 481
 482     /**
 483        Set the top-left point of the rectangle.
 484      */
 485     void SetTopLeft(const wxPoint &p);
 486
 487     /**
 488        Set the bottom-right point of the rectangle.
 489      */
 490     void SetBottomRight(const wxPoint &p);
 491
 492     /**
 493        Set the top-right point of the rectangle.
 494      */
 495     void SetTopRight(const wxPoint &p);
 496
 497     /**
 498        Set the bottom-left point of the rectangle.
 499      */
 500     void SetBottomLeft(const wxPoint &p);
 501
 502
 503     //@{
 504     /**
 505         Modifies the rectangle to contain the bounding box of this rectangle
 506         and the one passed in as parameter.
 507     */
 508     wxRect Union(const wxRect& rect) const;
 509     wxRect& Union(const wxRect& rect);
 510     //@}
 511
 512     /**
 513         Inequality operator.
 514     */
 515     bool operator !=(const wxRect& r1, const wxRect& r2);
 516
 517     //@{
 518     /**
 519         Like Union(), but doesn't treat empty rectangles specially.
 520     */
 521     wxRect operator +(const wxRect& r1, const wxRect& r2);
 522     wxRect& operator +=(const wxRect& r);
 523     //@}
 524
 525     //@{
 526     /**
 527         Returns the intersection of two rectangles (which may be empty).
 528     */
 529     wxRect operator *(const wxRect& r1, const wxRect& r2);
 530     wxRect& operator *=(const wxRect& r);
 531     //@}
 532
 533     /**
 534         Assignment operator.
 535     */
 536     wxRect& operator=(const wxRect& rect);
 537
 538     /**
 539         Equality operator.
 540     */
 541     bool operator ==(const wxRect& r1, const wxRect& r2);
 542
 543     /**
 544         Height member.
 545     */
 546     int height;
 547
 548     /**
 549         Width member.
 550     */
 551     int width;
 552
 553     /**
 554         x coordinate of the top-level corner of the rectangle.
 555     */
 556     int x;
 557
 558     /**
 559         y coordinate of the top-level corner of the rectangle.
 560     */
 561     int y;
 562 };
 563
 564
 565
 566 /**
 567     @class wxPoint
 568
 569     A wxPoint is a useful data structure for graphics operations.
 570
 571     It contains integer @e x and @e y members.
 572     See wxRealPoint for a floating point version.
 573
 574     Note that the width and height stored inside a wxPoint object may be negative
 575     and that wxPoint functions do not perform any check against negative values
 576     (this is used to e.g. store the special -1 value in ::wxDefaultPosition instance).
 577
 578     @library{wxcore}
 579     @category{data}
 580
 581     @stdobjects
 582     ::wxDefaultPosition
 583
 584     @see wxRealPoint
 585 */
 586 class wxPoint
 587 {
 588 public:
 589     /**
 590         Constructs a point.
 591         Initializes the internal x and y coordinates to zero.
 592     */
 593     wxPoint();
 594
 595     /**
 596         Initializes the point object with the given @a x and @a y coordinates.
 597     */
 598     wxPoint(int x, int y);
 599
 600     /**
 601         Converts the given wxRealPoint (with floating point coordinates) to a
 602         wxPoint instance.
 603     */
 604     wxPoint(const wxRealPoint& pt);
 605
 606     /**
 607         @name Miscellaneous operators
 608
 609         Note that these operators are documented as class members
 610         (to make them easier to find) but, as their prototype shows,
 611         they are implemented as global operators; note that this is
 612         transparent to the user but it helps to understand why the
 613         following functions are documented to take the wxPoint they
 614         operate on as an explicit argument.
 615     */
 616     //@{
 617     wxPoint& operator=(const wxPoint& pt);
 618
 619     bool operator ==(const wxPoint& p1, const wxPoint& p2);
 620     bool operator !=(const wxPoint& p1, const wxPoint& p2);
 621
 622     wxPoint operator +(const wxPoint& p1, const wxPoint& p2);
 623     wxPoint operator -(const wxPoint& p1, const wxPoint& p2);
 624
 625     wxPoint& operator +=(const wxPoint& pt);
 626     wxPoint& operator -=(const wxPoint& pt);
 627
 628     wxPoint operator +(const wxPoint& pt, const wxSize& sz);
 629     wxPoint operator -(const wxPoint& pt, const wxSize& sz);
 630     wxPoint operator +(const wxSize& sz, const wxPoint& pt);
 631     wxPoint operator -(const wxSize& sz, const wxPoint& pt);
 632
 633     wxPoint& operator +=(const wxSize& sz);
 634     wxPoint& operator -=(const wxSize& sz);
 635
 636     wxSize operator /(const wxPoint& sz, int factor);
 637     wxSize operator *(const wxPoint& sz, int factor);
 638     wxSize operator *(int factor, const wxSize& sz);
 639     wxSize& operator /=(int factor);
 640     wxSize& operator *=(int factor);
 641     //@}
 642
 643
 644     /**
 645         @name Defaults handling.
 646
 647         Test for and set non-specified wxPoint components.
 648
 649         Although a wxPoint is always initialized to (0, 0), wxWidgets commonly
 650         uses wxDefaultCoord (defined as @c -1) to indicate that a point hasn't
 651         been initialized or specified. In particular, ::wxDefaultPosition is
 652         used in many places with this meaning.
 653      */
 654     //@{
 655
 656     /**
 657         Returns @true if neither of the point components is equal to
 658         wxDefaultCoord.
 659
 660         This method is typically used before calling SetDefaults().
 661
 662         @since 2.9.2
 663     */
 664     bool IsFullySpecified() const;
 665
 666     /**
 667         Combine this object with another one replacing the uninitialized
 668         values.
 669
 670         It is typically used like this:
 671
 672         @code
 673         if ( !pos.IsFullySpecified() )
 674         {
 675             pos.SetDefaults(GetDefaultPosition());
 676         }
 677         @endcode
 678
 679         @see IsFullySpecified()
 680
 681         @since 2.9.2
 682     */
 683     void SetDefaults(const wxPoint& pt);
 684     //@}
 685
 686     /**
 687         x member.
 688     */
 689     int x;
 690
 691     /**
 692         y member.
 693     */
 694     int  y;
 695 };
 696
 697 /**
 698     Global instance of a wxPoint initialized with values (-1,-1).
 699 */
 700 const wxPoint wxDefaultPosition;
 701
 702
 703 /**
 704     @class wxColourDatabase
 705
 706     wxWidgets maintains a database of standard RGB colours for a predefined
 707     set of named colours. The application may add to this set if desired by
 708     using AddColour() and may use it to look up colours by names using Find()
 709     or find the names for the standard colour using FindName().
 710
 711     There is one predefined, global instance of this class called
 712     ::wxTheColourDatabase.
 713
 714     The standard database contains at least the following colours:
 715
 716     @beginTable
 717     <tr><td>
 718        AQUAMARINE
 719     @n BLACK
 720     @n BLUE
 721     @n BLUE VIOLET
 722     @n BROWN
 723     @n CADET BLUE
 724     @n CORAL
 725     @n CORNFLOWER BLUE
 726     @n CYAN
 727     @n DARK GREY
 728     @n DARK GREEN
 729     @n DARK OLIVE GREEN
 730     @n DARK ORCHID
 731     @n DARK SLATE BLUE
 732     @n DARK SLATE GREY
 733     @n DARK TURQUOISE
 734     @n DIM GREY
 735     </td><td>
 736        FIREBRICK
 737     @n FOREST GREEN
 738     @n GOLD
 739     @n GOLDENROD
 740     @n GREY
 741     @n GREEN
 742     @n GREEN YELLOW
 743     @n INDIAN RED
 744     @n KHAKI
 745     @n LIGHT BLUE
 746     @n LIGHT GREY
 747     @n LIGHT STEEL BLUE
 748     @n LIME GREEN
 749     @n MAGENTA
 750     @n MAROON
 751     @n MEDIUM AQUAMARINE
 752     @n MEDIUM BLUE
 753     </td><td>
 754        MEDIUM FOREST GREEN
 755     @n MEDIUM GOLDENROD
 756     @n MEDIUM ORCHID
 757     @n MEDIUM SEA GREEN
 758     @n MEDIUM SLATE BLUE
 759     @n MEDIUM SPRING GREEN
 760     @n MEDIUM TURQUOISE
 761     @n MEDIUM VIOLET RED
 762     @n MIDNIGHT BLUE
 763     @n NAVY
 764     @n ORANGE
 765     @n ORANGE RED
 766     @n ORCHID
 767     @n PALE GREEN
 768     @n PINK
 769     @n PLUM
 770     @n PURPLE
 771     </td><td>
 772        RED
 773     @n SALMON
 774     @n SEA GREEN
 775     @n SIENNA
 776     @n SKY BLUE
 777     @n SLATE BLUE
 778     @n SPRING GREEN
 779     @n STEEL BLUE
 780     @n TAN
 781     @n THISTLE
 782     @n TURQUOISE
 783     @n VIOLET
 784     @n VIOLET RED
 785     @n WHEAT
 786     @n WHITE
 787     @n YELLOW
 788     @n YELLOW GREEN
 789     </td></tr>
 790     @endTable
 791
 792     @library{wxcore}
 793     @category{gdi}
 794
 795     @see wxColour
 796 */
 797 class wxColourDatabase
 798 {
 799 public:
 800     /**
 801         Constructs the colour database. It will be initialized at the first
 802         use.
 803     */
 804     wxColourDatabase();
 805
 806     /**
 807         Adds a colour to the database. If a colour with the same name already
 808         exists, it is replaced.
 809     */
 810     void AddColour(const wxString& colourName, const wxColour& colour);
 811
 812     /**
 813         Finds a colour given the name. Returns an invalid colour object (that
 814         is, wxColour::IsOk() will return @false) if the colour wasn't found in
 815         the database.
 816     */
 817     wxColour Find(const wxString& colourName) const;
 818
 819     /**
 820         Finds a colour name given the colour. Returns an empty string if the
 821         colour is not found in the database.
 822     */
 823     wxString FindName(const wxColour& colour) const;
 824 };
 825
 826
 827 /**
 828     Global instance of a wxColourDatabase.
 829 */
 830 wxColourDatabase* wxTheColourDatabase;
 831
 832
 833 /**
 834     @class wxSize
 835
 836     A wxSize is a useful data structure for graphics operations.
 837     It simply contains integer @e width and @e height members.
 838
 839     Note that the width and height stored inside a wxSize object may be negative
 840     and that wxSize functions do not perform any check against negative values
 841     (this is used to e.g. store the special -1 value in ::wxDefaultSize instance).
 842     See also IsFullySpecified() and SetDefaults() for utility functions regarding
 843     the special -1 value.
 844
 845     wxSize is used throughout wxWidgets as well as wxPoint which, although
 846     almost equivalent to wxSize, has a different meaning: wxPoint represents a
 847     position while wxSize represents the size.
 848
 849     @library{wxcore}
 850     @category{data}
 851
 852     @stdobjects
 853     ::wxDefaultSize
 854
 855     @see wxPoint, wxRealPoint
 856 */
 857 class wxSize
 858 {
 859 public:
 860     /**
 861         Initializes this size object with zero width and height.
 862     */
 863     wxSize();
 864
 865     /**
 866         Initializes this size object with the given @a width and @a height.
 867     */
 868     wxSize(int width, int height);
 869
 870     //@{
 871     /**
 872         Decreases the size in both x and y directions.
 873
 874         @see IncBy()
 875     */
 876     void DecBy(const wxPoint& pt);
 877     void DecBy(const wxSize& size);
 878     void DecBy(int dx, int dy);
 879     void DecBy(int d);
 880     //@}
 881
 882     /**
 883         Decrements this object so that both of its dimensions are not greater
 884         than the corresponding dimensions of the @a size.
 885
 886         @see IncTo()
 887     */
 888     void DecTo(const wxSize& size);
 889
 890     /**
 891         Decrements this object to be not bigger than the given size ignoring
 892         non-specified components.
 893
 894         This is similar to DecTo() but doesn't do anything for x or y
 895         component if the same component of @a size is not specified, i.e. set
 896         to ::wxDefaultCoord.
 897
 898         @since 2.9.5
 899      */
 900     void DecToIfSpecified(const wxSize& size);
 901
 902     /**
 903         Gets the height member.
 904     */
 905     int GetHeight() const;
 906
 907     /**
 908         Gets the width member.
 909     */
 910     int GetWidth() const;
 911
 912     //@{
 913     /**
 914         Increases the size in both x and y directions.
 915
 916         @see DecBy()
 917     */
 918     void IncBy(const wxPoint& pt);
 919     void IncBy(const wxSize& size);
 920     void IncBy(int dx, int dy);
 921     void IncBy(int d);
 922     //@}
 923
 924     /**
 925         Increments this object so that both of its dimensions are not less than
 926         the corresponding dimensions of the @a size.
 927
 928         @see DecTo()
 929     */
 930     void IncTo(const wxSize& size);
 931
 932     /**
 933         Returns @true if neither of the size object components is equal to -1,
 934         which is used as default for the size values in wxWidgets (hence the
 935         predefined ::wxDefaultSize has both of its components equal to -1).
 936
 937         This method is typically used before calling SetDefaults().
 938     */
 939     bool IsFullySpecified() const;
 940
 941     /**
 942         Scales the dimensions of this object by the given factors. If you want
 943         to scale both dimensions by the same factor you can also use
 944         operator*=().
 945
 946         @return A reference to this object (so that you can concatenate other
 947                  operations in the same line).
 948     */
 949     wxSize& Scale(float xscale, float yscale);
 950
 951     /**
 952         Sets the width and height members.
 953     */
 954     void Set(int width, int height);
 955
 956     /**
 957         Combine this size object with another one replacing the default (i.e.\ equal to -1)
 958         components of this object with those of the other. It is typically used like this:
 959
 960         @code
 961         if ( !size.IsFullySpecified() )
 962         {
 963             size.SetDefaults(GetDefaultSize());
 964         }
 965         @endcode
 966
 967         @see IsFullySpecified()
 968     */
 969     void SetDefaults(const wxSize& sizeDefault);
 970
 971     /**
 972         Sets the height.
 973     */
 974     void SetHeight(int height);
 975
 976     /**
 977         Sets the width.
 978     */
 979     void SetWidth(int width);
 980
 981
 982     /**
 983         @name Miscellaneous operators
 984
 985         Note that these operators are documented as class members
 986         (to make them easier to find) but, as their prototype shows,
 987         they are implemented as global operators; note that this is
 988         transparent to the user but it helps to understand why the
 989         following functions are documented to take the wxSize they
 990         operate on as an explicit argument.
 991     */
 992     //@{
 993     wxSize& operator=(const wxSize& sz);
 994
 995     bool operator ==(const wxSize& s1, const wxSize& s2);
 996     bool operator !=(const wxSize& s1, const wxSize& s2);
 997
 998     wxSize operator +(const wxSize& s1, const wxSize& s2);
 999     wxSize operator -(const wxSize& s1, const wxSize& s2);
1000     wxSize& operator +=(const wxSize& sz);
1001     wxSize& operator -=(const wxSize& sz);
1002
1003     wxSize operator /(const wxSize& sz, int factor);
1004     wxSize operator *(const wxSize& sz, int factor);
1005     wxSize operator *(int factor, const wxSize& sz);
1006     wxSize& operator /=(int factor);
1007     wxSize& operator *=(int factor);
1008     //@}
1009 };
1010
1011 /**
1012     Global instance of a wxSize object initialized to (-1,-1).
1013 */
1014 const wxSize wxDefaultSize;
1015
1016
1017
1018
1019 // ============================================================================
1020 // Global functions/macros
1021 // ============================================================================
1022
1023 /** @addtogroup group_funcmacro_gdi */
1024 //@{
1025
1026 /**
1027     This macro loads a bitmap from either application resources (on the
1028     platforms for which they exist, i.e. Windows and OS2) or from an XPM file.
1029     This can help to avoid using @ifdef_ when creating bitmaps.
1030
1031     @see @ref overview_bitmap, wxICON()
1032
1033     @header{wx/gdicmn.h}
1034 */
1035 #define wxBITMAP(bitmapName)
1036
1037 /**
1038     Creates a bitmap from either application resources or embedded image data
1039     in PNG format.
1040
1041     This macro is similar to wxBITMAP() but works with bitmap data in PNG
1042     format and not BMP or XPM.
1043
1044     Under Windows the given @a bitmapName must be present in the application
1045     resource file with the type @c RCDATA and refer to a PNG image. I.e. you
1046     should have a definition similar to the following in your @c .rc file:
1047     @code
1048         mybitmap    RCDATA  "mybitmap.png"
1049     @endcode
1050     to be able to use @c wxBITMAP_PNG(mybitmap) in the code.
1051
1052     Under OS X the file with the specified name and "png" extension must be
1053     present in the "Resources" subdirectory of the application bundle.
1054
1055     Under the other platforms, this is equivalent to wxBITMAP_PNG_FROM_DATA()
1056     and so loads the image data from the array called @c bitmapName_png that
1057     must exist. Notice that it @e must be an array and not a pointer as the
1058     macro needs to be able to determine its size. Such an array can be produced
1059     by a number of conversion programs. A very simple one is included in
1060     wxWidgets distribution as @c misc/scripts/png2c.py.
1061
1062     Finally notice that you must register PNG image handler to be able to
1063     load bitmaps from PNG data. This can be done either by calling
1064     wxInitAllImageHandlers() which also registers all the other image formats
1065     or including the necessary header:
1066     @code
1067         #include <wx/imagpng.h>
1068     @endcode
1069     and calling
1070     @code
1071         wxImage::AddHandler(new wxPNGHandler);
1072     @endcode
1073     in your application startup code.
1074
1075     @see wxBITMAP_PNG_FROM_DATA()
1076
1077     @header{wx/gdicmn.h}
1078
1079     @since 2.9.5
1080  */
1081 #define wxBITMAP_PNG(bitmapName)
1082
1083 /**
1084     Creates a bitmap from embedded image data in PNG format.
1085
1086     This macro is a thin wrapper around wxBitmap::NewFromPNGData() and takes
1087     just the base name of the array containing the image data and computes its
1088     size internally. In other words, the array called @c bitmapName_png must
1089     exist. Notice that it @e must be an array and not a pointer as the macro
1090     needs to be able to determine its size. Such an array can be produced by a
1091     number of conversion programs. A very simple one is included in wxWidgets
1092     distribution as @c misc/scripts/png2c.py.
1093
1094     You can use wxBITMAP_PNG() to load the PNG bitmaps from resources on the
1095     platforms that support this and only fall back to loading them from data
1096     under the other ones (i.e. not Windows and not OS X).
1097
1098     @header{wx/gdicmn.h}
1099
1100     @since 2.9.5
1101  */
1102 #define wxBITMAP_PNG_FROM_DATA(bitmapName)
1103
1104 /**
1105     This macro loads an icon from either application resources (on the
1106     platforms for which they exist, i.e. Windows and OS2) or from an XPM file.
1107     This can help to avoid using @ifdef_ when creating icons.
1108
1109     @see @ref overview_bitmap, wxBITMAP()
1110
1111     @header{wx/gdicmn.h}
1112 */
1113 #define wxICON(iconName)
1114
1115 /**
1116     Returns @true if the display is colour, @false otherwise.
1117
1118     @header{wx/gdicmn.h}
1119 */
1120 bool wxColourDisplay();
1121
1122 /**
1123     Returns the depth of the display (a value of 1 denotes a monochrome
1124     display).
1125
1126     @header{wx/gdicmn.h}
1127 */
1128 int wxDisplayDepth();
1129
1130 /**
1131     Globally sets the cursor; only has an effect on Windows, Mac and GTK+. You
1132     should call this function with wxNullCursor to restore the system cursor.
1133
1134     @see wxCursor, wxWindow::SetCursor()
1135
1136     @header{wx/gdicmn.h}
1137 */
1138 void wxSetCursor(const wxCursor& cursor);
1139
1140 //@}
1141
1142 /** @addtogroup group_funcmacro_gdi */
1143 //@{
1144 /**
1145     Returns the dimensions of the work area on the display. On Windows this
1146     means the area not covered by the taskbar, etc. Other platforms are
1147     currently defaulting to the whole display until a way is found to provide
1148     this info for all window managers, etc.
1149
1150     @header{wx/gdicmn.h}
1151 */
1152 void wxClientDisplayRect(int* x, int* y, int* width, int* height);
1153 wxRect wxGetClientDisplayRect();
1154 //@}
1155
1156 /** @addtogroup group_funcmacro_gdi */
1157 //@{
1158 /**
1159     Returns the display resolution in pixels per inch.
1160
1161     The @c x component of the returned wxSize object contains the horizontal
1162     resolution and the @c y one -- the vertical resolution.
1163
1164     @header{wx/gdicmn.h}
1165
1166     @since 2.9.0
1167 */
1168 wxSize wxGetDisplayPPI();
1169 //@}
1170
1171 /** @addtogroup group_funcmacro_gdi */
1172 //@{
1173 /**
1174     Returns the display size in pixels.
1175
1176     For the version taking @a width and @a header arguments, either of them
1177     can be @NULL if the caller is not interested in the returned value.
1178
1179     @header{wx/gdicmn.h}
1180 */
1181 void wxDisplaySize(int* width, int* height);
1182 wxSize wxGetDisplaySize();
1183 //@}
1184
1185 /** @addtogroup group_funcmacro_gdi */
1186 //@{
1187 /**
1188     Returns the display size in millimeters.
1189
1190     For the version taking @a width and @a header arguments, either of them
1191     can be @NULL if the caller is not interested in the returned value.
1192
1193     @see wxGetDisplayPPI()
1194
1195     @header{wx/gdicmn.h}
1196 */
1197 void wxDisplaySizeMM(int* width, int* height);
1198 wxSize wxGetDisplaySizeMM();
1199 //@}
1200