#include <wx/gdicmn.h>
A wxPoint is a useful data structure for graphics operations.
It contains integer x and 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).
Predefined objects/pointers: wxDefaultPosition
Public Member Functions | |
wxPoint () | |
Constructs a point. More... | |
wxPoint (int x, int y) | |
Initializes the point object with the given x and y coordinates. More... | |
wxPoint (const wxRealPoint &pt) | |
Converts the given wxRealPoint (with floating point coordinates) to a wxPoint instance. More... | |
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) |
bool | operator!= (const wxPoint &p1, const wxPoint &p2) |
wxPoint | operator+ (const wxPoint &p1, const wxPoint &p2) |
wxPoint | operator- (const wxPoint &p1, const wxPoint &p2) |
wxPoint & | operator+= (const wxPoint &pt) |
wxPoint & | operator-= (const wxPoint &pt) |
wxPoint | operator+ (const wxPoint &pt, const wxSize &sz) |
wxPoint | operator- (const wxPoint &pt, const wxSize &sz) |
wxPoint | operator+ (const wxSize &sz, const wxPoint &pt) |
wxPoint | operator- (const wxSize &sz, const wxPoint &pt) |
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) |
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 | |
bool | IsFullySpecified () const |
Returns true if neither of the point components is equal to wxDefaultCoord. More... | |
void | SetDefaults (const wxPoint &pt) |
Combine this object with another one replacing the uninitialized values. More... | |
Public Attributes | |
int | x |
x member. More... | |
int | y |
y member. More... | |
wxPoint::wxPoint | ( | ) |
Constructs a point.
Initializes the internal x and y coordinates to zero.
wxPoint::wxPoint | ( | int | x, |
int | y | ||
) |
Initializes the point object with the given x and y coordinates.
wxPoint::wxPoint | ( | const wxRealPoint & | pt | ) |
Converts the given wxRealPoint (with floating point coordinates) to a wxPoint instance.
Notice that this truncates the floating point values of pt components, if you want to round them instead you need to do it manually, e.g.
bool wxPoint::IsFullySpecified | ( | ) | const |
Returns true if neither of the point components is equal to wxDefaultCoord.
This method is typically used before calling SetDefaults().
wxSize& wxPoint::operator*= | ( | int | factor | ) |
wxSize& wxPoint::operator/= | ( | int | factor | ) |
void wxPoint::SetDefaults | ( | const wxPoint & | pt | ) |
Combine this object with another one replacing the uninitialized values.
It is typically used like this:
int wxPoint::x |
x member.
int wxPoint::y |
y member.