X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a5664fd6ef32c7e7432a9213ad8a8f9550460fbf..ca282726be518ce2f214b890dbaafce736f14e36:/interface/wx/gdicmn.h?ds=sidebyside diff --git a/interface/wx/gdicmn.h b/interface/wx/gdicmn.h index 43a4aa596f..52a0fffe84 100644 --- a/interface/wx/gdicmn.h +++ b/interface/wx/gdicmn.h @@ -3,7 +3,7 @@ // Purpose: interface of wxRealPoint // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -24,8 +24,10 @@ enum wxBitmapType wxBITMAP_TYPE_XBM_DATA, wxBITMAP_TYPE_XPM, wxBITMAP_TYPE_XPM_DATA, - wxBITMAP_TYPE_TIF, - wxBITMAP_TYPE_TIF_RESOURCE, + wxBITMAP_TYPE_TIFF, + wxBITMAP_TYPE_TIF = wxBITMAP_TYPE_TIFF, + wxBITMAP_TYPE_TIFF_RESOURCE, + wxBITMAP_TYPE_TIF_RESOURCE = wxBITMAP_TYPE_TIFF_RESOURCE, wxBITMAP_TYPE_GIF, wxBITMAP_TYPE_GIF_RESOURCE, wxBITMAP_TYPE_PNG, @@ -113,10 +115,10 @@ enum wxStockCursor A wxRealPoint is a useful data structure for graphics operations. - It contains floating point @e x and @e y members. + 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 + 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} @@ -136,7 +138,7 @@ public: Initializes the point with the given coordinates. */ wxRealPoint(double x, double y); - + /** Converts the given wxPoint (with integer coordinates) to a wxRealPoint. */ @@ -144,7 +146,7 @@ public: /** @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 @@ -171,14 +173,14 @@ public: wxRealPoint& operator +=(const wxSize& sz); wxRealPoint& operator -=(const wxSize& sz); - + wxSize operator /(const wxRealPoint& sz, int factor); wxSize operator *(const wxRealPoint& sz, int factor); wxSize operator *(int factor, const wxSize& sz); wxSize& operator /=(int factor); wxSize& operator *=(int factor); //@} - + /** X coordinate of this point. */ @@ -197,8 +199,8 @@ 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 + 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} @@ -266,10 +268,10 @@ public: This method is the opposite from Inflate(): Deflate(a, b) is equivalent to Inflate(-a, -b). Please refer to Inflate() for full description. */ - void Deflate(wxCoord dx, wxCoord dy); - void Deflate(const wxSize& diff); - void Deflate(wxCoord diff); - wxRect Deflate(wxCoord dx, wxCoord dy) const; + wxRect& Deflate(wxCoord dx, wxCoord dy); + wxRect& Deflate(const wxSize& diff); + wxRect& Deflate(wxCoord diff); + wxRect Deflate(wxCoord dx, wxCoord dy) const; //@} /** @@ -351,7 +353,7 @@ public: The left border is moved farther left and the right border is moved farther right by @a dx. The upper border is moved farther up and the - bottom border is moved farther down by @a dy. (Note the the width and + bottom border is moved farther down by @a dy. (Note that the width and height of the rectangle thus change by 2*dx and 2*dy, respectively.) If one or both of @a dx and @a dy are negative, the opposite happens: the rectangle size decreases in the respective direction. @@ -374,9 +376,9 @@ public: @see Deflate() */ - void Inflate(wxCoord dx, wxCoord dy); - void Inflate(const wxSize& diff); - void Inflate(wxCoord diff); + wxRect& Inflate(wxCoord dx, wxCoord dy); + wxRect& Inflate(const wxSize& diff); + wxRect& Inflate(wxCoord diff); wxRect Inflate(wxCoord dx, wxCoord dy) const; //@} @@ -443,6 +445,61 @@ public: */ void SetY(int y); + /** + Set the left side of the rectangle. + + Notice that because the rectangle stores its left side and width, + calling SetLeft() changes the right side position too -- but does + preserve the width. + */ + void SetLeft(int left); + + /** + Set the right side of the rectangle. + + Notice that this doesn't affect GetLeft() return value but changes the + rectangle width to set its right side to the given position. + */ + void SetRight(int right); + + /** + Set the top edge of the rectangle. + + Notice that because the rectangle stores its top side and height, + calling SetTop() changes the bottom side position too -- but does + preserve the height. + */ + void SetTop(int top); + + /** + Set the bottom edge of the rectangle. + + Notice that this doesn't affect GetTop() return value but changes the + rectangle height to set its bottom side to the given position. + */ + void SetBottom(int bottom); + + /** + Set the top-left point of the rectangle. + */ + void SetTopLeft(const wxPoint &p); + + /** + Set the bottom-right point of the rectangle. + */ + void SetBottomRight(const wxPoint &p); + + /** + Set the top-right point of the rectangle. + */ + void SetTopRight(const wxPoint &p); + + /** + Set the bottom-left point of the rectangle. + */ + void SetBottomLeft(const wxPoint &p); + + //@{ /** Modifies the rectangle to contain the bounding box of this rectangle @@ -511,7 +568,7 @@ public: A wxPoint is a useful data structure for graphics operations. - It contains integer @e x and @e y members. + 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 @@ -534,12 +591,12 @@ public: 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); - + /** Converts the given wxRealPoint (with floating point coordinates) to a wxPoint instance. @@ -548,7 +605,7 @@ public: /** @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 @@ -575,14 +632,57 @@ 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); //@} - + + + /** + @name Defaults handling. + + Test for and set non-specified wxPoint components. + + Although a wxPoint is always initialized to (0, 0), wxWidgets commonly + uses wxDefaultCoord (defined as @c -1) to indicate that a point hasn't + been initialized or specified. In particular, ::wxDefaultPosition is + used in many places with this meaning. + */ + //@{ + + /** + Returns @true if neither of the point components is equal to + wxDefaultCoord. + + This method is typically used before calling SetDefaults(). + + @since 2.9.2 + */ + bool IsFullySpecified() const; + + /** + Combine this object with another one replacing the uninitialized + values. + + It is typically used like this: + + @code + if ( !pos.IsFullySpecified() ) + { + pos.SetDefaults(GetDefaultPosition()); + } + @endcode + + @see IsFullySpecified() + + @since 2.9.2 + */ + void SetDefaults(const wxPoint& pt); + //@} + /** x member. */ @@ -595,9 +695,9 @@ public: }; /** - Global istance of a wxPoint initialized with values (-1,-1). + Global instance of a wxPoint initialized with values (-1,-1). */ -wxPoint wxDefaultPosition; +const wxPoint wxDefaultPosition; /** @@ -724,12 +824,18 @@ public: }; +/** + Global instance of a wxColourDatabase. +*/ +wxColourDatabase* wxTheColourDatabase; + + /** @class wxSize - A wxSize is a useful data structure for graphics operations. + 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). @@ -740,11 +846,6 @@ public: almost equivalent to wxSize, has a different meaning: wxPoint represents a position while wxSize represents the size. - @beginWxPythonOnly - wxPython defines aliases for the @e x and @e y members named @e width and - @e height since it makes much more sense for sizes. - @endWxPythonOnly - @library{wxcore} @category{data} @@ -760,7 +861,7 @@ public: Initializes this size object with zero width and height. */ wxSize(); - + /** Initializes this size object with the given @a width and @a height. */ @@ -772,6 +873,7 @@ public: @see IncBy() */ + void DecBy(const wxPoint& pt); void DecBy(const wxSize& size); void DecBy(int dx, int dy); void DecBy(int d); @@ -785,6 +887,18 @@ public: */ void DecTo(const wxSize& size); + /** + Decrements this object to be not bigger than the given size ignoring + non-specified components. + + This is similar to DecTo() but doesn't do anything for x or y + component if the same component of @a size is not specified, i.e. set + to ::wxDefaultCoord. + + @since 2.9.5 + */ + void DecToIfSpecified(const wxSize& size); + /** Gets the height member. */ @@ -801,6 +915,7 @@ public: @see DecBy() */ + void IncBy(const wxPoint& pt); void IncBy(const wxSize& size); void IncBy(int dx, int dy); void IncBy(int d); @@ -864,10 +979,10 @@ public: */ void SetWidth(int width); - + /** @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 @@ -897,7 +1012,7 @@ public: /** Global instance of a wxSize object initialized to (-1,-1). */ -wxSize wxDefaultSize; +const wxSize wxDefaultSize; @@ -920,6 +1035,73 @@ wxSize wxDefaultSize; */ #define wxBITMAP(bitmapName) +/** + Creates a bitmap from either application resources or embedded image data + in PNG format. + + This macro is similar to wxBITMAP() but works with bitmap data in PNG + format and not BMP or XPM. + + Under Windows the given @a bitmapName must be present in the application + resource file with the type @c RCDATA and refer to a PNG image. I.e. you + should have a definition similar to the following in your @c .rc file: + @code + mybitmap RCDATA "mybitmap.png" + @endcode + to be able to use @c wxBITMAP_PNG(mybitmap) in the code. + + Under OS X the file with the specified name and "png" extension must be + present in the "Resources" subdirectory of the application bundle. + + Under the other platforms, this is equivalent to wxBITMAP_PNG_FROM_DATA() + and so loads the image data from the array called @c bitmapName_png that + must exist. Notice that it @e must be an array and not a pointer as the + macro needs to be able to determine its size. Such an array can be produced + by a number of conversion programs. A very simple one is included in + wxWidgets distribution as @c misc/scripts/png2c.py. + + Finally notice that you must register PNG image handler to be able to + load bitmaps from PNG data. This can be done either by calling + wxInitAllImageHandlers() which also registers all the other image formats + or including the necessary header: + @code + #include + @endcode + and calling + @code + wxImage::AddHandler(new wxPNGHandler); + @endcode + in your application startup code. + + @see wxBITMAP_PNG_FROM_DATA() + + @header{wx/gdicmn.h} + + @since 2.9.5 + */ +#define wxBITMAP_PNG(bitmapName) + +/** + Creates a bitmap from embedded image data in PNG format. + + This macro is a thin wrapper around wxBitmap::NewFromPNGData() and takes + just the base name of the array containing the image data and computes its + size internally. In other words, the array called @c bitmapName_png must + exist. Notice that it @e must be an array and not a pointer as the macro + needs to be able to determine its size. Such an array can be produced by a + number of conversion programs. A very simple one is included in wxWidgets + distribution as @c misc/scripts/png2c.py. + + You can use wxBITMAP_PNG() to load the PNG bitmaps from resources on the + platforms that support this and only fall back to loading them from data + under the other ones (i.e. not Windows and not OS X). + + @header{wx/gdicmn.h} + + @since 2.9.5 + */ +#define wxBITMAP_PNG_FROM_DATA(bitmapName) + /** This macro loads an icon from either application resources (on the platforms for which they exist, i.e. Windows and OS2) or from an XPM file.