X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b21126db7a8232fa9e64b29f916d73d6b0153bef..7cfac8c83a1db4c17ebf2091c2de795ca01b542a:/interface/wx/gdicmn.h diff --git a/interface/wx/gdicmn.h b/interface/wx/gdicmn.h index fb5089f714..192a6b6bd2 100644 --- a/interface/wx/gdicmn.h +++ b/interface/wx/gdicmn.h @@ -49,7 +49,23 @@ enum wxBitmapType }; /** - Standard cursors. See wxCursor. + Polygon filling mode. See wxDC::DrawPolygon. +*/ +enum wxPolygonFillMode +{ + wxODDEVEN_RULE = 1, + wxWINDING_RULE +}; + +/** + Standard cursors. + + Notice that under wxMSW some of these cursors are defined in @c wx.rc file + and not by the system itself so you should include this file from your own + resource file (possibly creating a trivial resource file just containing a + single include line if you don't need it otherwise) to be able to use them. + + See wxCursor. */ enum wxStockCursor { @@ -97,8 +113,11 @@ enum wxStockCursor A wxRealPoint is a useful data structure for graphics operations. - It contains floating point @e x and @e y members. See wxPoint for an - integer version. + It contains floating point @e x and @e y members. + See wxPoint for an integer version. + + Note that the coordinates stored inside a wxRealPoint object may be negative + and that wxRealPoint functions do not perform any check against negative values. @library{wxcore} @category{data} @@ -108,6 +127,9 @@ enum wxStockCursor class wxRealPoint { public: + /** + Initializes to zero the x and y members. + */ wxRealPoint(); /** @@ -133,6 +155,10 @@ public: A class for manipulating rectangles. + Note that the x, y coordinates and the width and height stored inside a wxRect + object may be negative and that wxRect functions do not perform any check against + negative values. + @library{wxcore} @category{data} @@ -143,6 +169,7 @@ class wxRect public: /** Default constructor. + Initializes to zero the internal @a x, @a y, @a width and @a height members. */ wxRect(); /** @@ -154,7 +181,7 @@ public: */ wxRect(const wxPoint& topLeft, const wxPoint& bottomRight); /** - Creates a wxRect object from position and @a size values. + Creates a wxRect object from position @a pos and @a size values. */ wxRect(const wxPoint& pos, const wxSize& size); /** @@ -442,8 +469,12 @@ public: A wxPoint is a useful data structure for graphics operations. - It contains integer @e x and @e y members. See wxRealPoint for a floating - point version. + It contains integer @e x and @e y members. + See wxRealPoint for a floating point version. + + Note that the width and height stored inside a wxPoint object may be negative + and that wxPoint functions do not perform any check against negative values + (this is used to e.g. store the special -1 value in ::wxDefaultPosition instance). @library{wxcore} @category{data} @@ -456,17 +487,28 @@ public: class wxPoint { public: - //@{ /** Constructs a point. + Initializes the internal x and y coordinates to zero. */ wxPoint(); + + /** + Initializes the point object with the given @a x and @a y coordinates. + */ wxPoint(int x, int y); - //@} /** - Assignment operator. + @name Miscellaneous operators + + Note that these operators are documented as class members + (to make them easier to find) but, as their prototype shows, + they are implemented as global operators; note that this is + transparent to the user but it helps to understand why the + following functions are documented to take the wxPoint they + operate on as an explicit argument. */ + //@{ wxPoint& operator=(const wxPoint& pt); bool operator ==(const wxPoint& p1, const wxPoint& p2); @@ -485,7 +527,14 @@ public: wxPoint& operator +=(const wxSize& sz); wxPoint& operator -=(const wxSize& sz); - + + wxSize operator /(const wxPoint& sz, int factor); + wxSize operator *(const wxPoint& sz, int factor); + wxSize operator *(int factor, const wxSize& sz); + wxSize& operator /=(int factor); + wxSize& operator *=(int factor); + //@} + /** x member. */ @@ -630,8 +679,14 @@ public: /** @class wxSize - A wxSize is a useful data structure for graphics operations. It simply - contains integer @e width and @e height members. + A wxSize is a useful data structure for graphics operations. + It simply contains integer @e width and @e height members. + + Note that the width and height stored inside a wxSize object may be negative + and that wxSize functions do not perform any check against negative values + (this is used to e.g. store the special -1 value in ::wxDefaultSize instance). + See also IsFullySpecified() and SetDefaults() for utility functions regarding + the special -1 value. wxSize is used throughout wxWidgets as well as wxPoint which, although almost equivalent to wxSize, has a different meaning: wxPoint represents a @@ -653,13 +708,15 @@ public: class wxSize { public: - //@{ /** - Creates a size object. + Initializes this size object with zero width and height. */ wxSize(); + + /** + Initializes this size object with the given @a width and @a height. + */ wxSize(int width, int height); - //@} //@{ /** @@ -759,9 +816,18 @@ public: */ void SetWidth(int width); + /** - Assignment operator. + @name Miscellaneous operators + + Note that these operators are documented as class members + (to make them easier to find) but, as their prototype shows, + they are implemented as global operators; note that this is + transparent to the user but it helps to understand why the + following functions are documented to take the wxSize they + operate on as an explicit argument. */ + //@{ wxSize& operator=(const wxSize& sz); bool operator ==(const wxSize& s1, const wxSize& s2); @@ -777,6 +843,7 @@ public: wxSize operator *(int factor, const wxSize& sz); wxSize& operator /=(int factor); wxSize& operator *=(int factor); + //@} }; /** @@ -814,7 +881,7 @@ wxSize wxDefaultSize; @header{wx/gdicmn.h} */ -wxICON(); +#define wxICON(iconName) /** Returns @true if the display is colour, @false otherwise.