%newgroup
DocStr( wxSize,
-"wx.Size is a useful data structure used to represent the size of something.
-It simply contians integer width and height proprtites. In most places in
-wxPython where a wx.Size is expected a (width,height) tuple can be used
-instead.");
+"wx.Size is a useful data structure used to represent the size of
+something. It simply contians integer width and height
+proprtites. In most places in wxPython where a wx.Size is
+expected a (width, height) tuple can be used instead.", "");
class wxSize
{
public:
- %name(width) int x;
- %name(height)int y;
+ %Rename(width, int, x);
+ %Rename(height,int, y);
%pythoncode { x = width; y = height }
DocCtorStr(
wxSize(int w=0, int h=0),
- "Creates a size object.");
+ "Creates a size object.", "");
~wxSize();
+// None/NULL is now handled properly by the typemap, so these are not needed.
+// %extend {
+// bool __eq__(const wxSize* other) { return other ? (*self == *other) : false; }
+// bool __ne__(const wxSize* other) { return other ? (*self != *other) : true; }
+// }
+
DocDeclStr(
bool, operator==(const wxSize& sz),
- "Test for equality of wx.Size objects.");
+ "Test for equality of wx.Size objects.", "");
DocDeclStr(
bool, operator!=(const wxSize& sz),
- "Test for inequality.");
+ "Test for inequality.", "");
DocDeclStr(
wxSize, operator+(const wxSize& sz),
- "Add sz's proprties to this and return the result.");
+ "Add sz's proprties to this and return the result.", "");
DocDeclStr(
wxSize, operator-(const wxSize& sz),
- "Subtract sz's properties from this and return the result.");
+ "Subtract sz's properties from this and return the result.", "");
DocDeclStr(
void, IncTo(const wxSize& sz),
- "Increments this object so that both of its dimensions are not less\n"
- "than the corresponding dimensions of the size.");
+ "Increments this object so that both of its dimensions are not less
+than the corresponding dimensions of the size.", "");
DocDeclStr(
void, DecTo(const wxSize& sz),
- "Decrements this object so that both of its dimensions are not greater\n"
- "than the corresponding dimensions of the size.");
+ "Decrements this object so that both of its dimensions are not greater
+than the corresponding dimensions of the size.", "");
DocDeclStr(
void, Set(int w, int h),
- "Set both width and height.");
+ "Set both width and height.", "");
void SetWidth(int w);
void SetHeight(int h);
int GetWidth() const;
int GetHeight() const;
+
+ DocDeclStr(
+ bool , IsFullySpecified() const,
+ "Returns True if both components of the size are non-default values.", "");
+
+
+ DocDeclStr(
+ void , SetDefaults(const wxSize& size),
+ "Combine this size with the other one replacing the default components
+of this object (i.e. equal to -1) with those of the other.", "");
+
+
//int GetX() const;
//int GetY() const;
%extend {
DocAStr(Get,
"Get() -> (width,height)",
- "Returns the width and height properties as a tuple.");
+ "Returns the width and height properties as a tuple.", "");
PyObject* Get() {
- wxPyBeginBlockThreads();
+ wxPyBlock_t blocked = wxPyBeginBlockThreads();
PyObject* tup = PyTuple_New(2);
PyTuple_SET_ITEM(tup, 0, PyInt_FromLong(self->x));
PyTuple_SET_ITEM(tup, 1, PyInt_FromLong(self->y));
- wxPyEndBlockThreads();
+ wxPyEndBlockThreads(blocked);
return tup;
}
}
%pythoncode {
- asTuple = Get
+ asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
def __str__(self): return str(self.Get())
def __repr__(self): return 'wx.Size'+str(self.Get())
def __len__(self): return len(self.Get())
%newgroup
DocStr( wxRealPoint,
-"A data structure for representing a point or position with floating point x
-and y properties. In wxPython most places that expect a wx.RealPoint can also
-accept a (x,y) tuple.");
+"A data structure for representing a point or position with floating
+point x and y properties. In wxPython most places that expect a
+wx.RealPoint can also accept a (x,y) tuple.", "");
class wxRealPoint
{
public:
DocCtorStr(
wxRealPoint(double x=0.0, double y=0.0),
- "Create a wx.RealPoint object");
+ "Create a wx.RealPoint object", "");
~wxRealPoint();
DocDeclStr(
bool, operator==(const wxRealPoint& pt),
- "Test for equality of wx.RealPoint objects.");
+ "Test for equality of wx.RealPoint objects.", "");
DocDeclStr(
bool, operator!=(const wxRealPoint& pt),
- "Test for inequality of wx.RealPoint objects.");
+ "Test for inequality of wx.RealPoint objects.", "");
DocDeclStr(
wxRealPoint, operator+(const wxRealPoint& pt),
- "Add pt's proprties to this and return the result.");
+ "Add pt's proprties to this and return the result.", "");
DocDeclStr(
wxRealPoint, operator-(const wxRealPoint& pt),
- "Subtract pt's proprties from this and return the result");
+ "Subtract pt's proprties from this and return the result", "");
%extend {
- DocStr(Set, "Set both the x and y properties");
+ DocStr(Set, "Set both the x and y properties", "");
void Set(double x, double y) {
self->x = x;
self->y = y;
DocAStr(Get,
"Get() -> (x,y)",
- "Return the x and y properties as a tuple. ");
+ "Return the x and y properties as a tuple. ", "");
PyObject* Get() {
- wxPyBeginBlockThreads();
+ wxPyBlock_t blocked = wxPyBeginBlockThreads();
PyObject* tup = PyTuple_New(2);
PyTuple_SET_ITEM(tup, 0, PyFloat_FromDouble(self->x));
PyTuple_SET_ITEM(tup, 1, PyFloat_FromDouble(self->y));
- wxPyEndBlockThreads();
+ wxPyEndBlockThreads(blocked);
return tup;
}
}
%pythoncode {
- asTuple = Get
+ asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
def __str__(self): return str(self.Get())
def __repr__(self): return 'wx.RealPoint'+str(self.Get())
def __len__(self): return len(self.Get())
DocStr(wxPoint,
-"A data structure for representing a point or position with integer x and y
-properties. Most places in wxPython that expect a wx.Point can also accept a
-(x,y) tuple.");
+"A data structure for representing a point or position with integer x
+and y properties. Most places in wxPython that expect a wx.Point can
+also accept a (x,y) tuple.", "");
class wxPoint
{
DocCtorStr(
wxPoint(int x=0, int y=0),
- "Create a wx.Point object");
+ "Create a wx.Point object", "");
~wxPoint();
DocDeclStr(
bool, operator==(const wxPoint& pt),
- "Test for equality of wx.Point objects.");
+ "Test for equality of wx.Point objects.", "");
DocDeclStr(
bool, operator!=(const wxPoint& pt),
- "Test for inequality of wx.Point objects.");
+ "Test for inequality of wx.Point objects.", "");
DocDeclStr(
wxPoint, operator+(const wxPoint& pt),
- "Add pt's proprties to this and return the result.");
+ "Add pt's proprties to this and return the result.", "");
DocDeclStr(
wxPoint, operator-(const wxPoint& pt),
- "Subtract pt's proprties from this and return the result");
+ "Subtract pt's proprties from this and return the result", "");
DocDeclStr(
wxPoint&, operator+=(const wxPoint& pt),
- "Add pt to this object.");
+ "Add pt to this object.", "");
DocDeclStr(
wxPoint&, operator-=(const wxPoint& pt),
- "Subtract pt from this object.");
+ "Subtract pt from this object.", "");
// DocDeclStr(
// wxPoint, operator+(const wxSize& sz),
-// "Add sz to this Point and return the result.");
+// "Add sz to this Point and return the result.", "");
// DocDeclStr(
// wxPoint, operator-(const wxSize& sz),
-// "Subtract sz from this Point and return the result");
+// "Subtract sz from this Point and return the result", "");
// DocDeclStr(
// wxPoint&, operator+=(const wxSize& sz),
-// "Add sz to this object.");
+// "Add sz to this object.", "");
// DocDeclStr(
// wxPoint&, operator-=(const wxSize& sz),
-// "Subtract sz from this object.");
+// "Subtract sz from this object.", "");
%extend {
- DocStr(Set, "Set both the x and y properties");
+ DocStr(Set, "Set both the x and y properties", "");
void Set(long x, long y) {
self->x = x;
self->y = y;
DocAStr(Get,
"Get() -> (x,y)",
- "Return the x and y properties as a tuple. ");
+ "Return the x and y properties as a tuple. ", "");
PyObject* Get() {
- wxPyBeginBlockThreads();
+ wxPyBlock_t blocked = wxPyBeginBlockThreads();
PyObject* tup = PyTuple_New(2);
PyTuple_SET_ITEM(tup, 0, PyInt_FromLong(self->x));
PyTuple_SET_ITEM(tup, 1, PyInt_FromLong(self->y));
- wxPyEndBlockThreads();
+ wxPyEndBlockThreads(blocked);
return tup;
}
}
%pythoncode {
- asTuple = Get
+ asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
def __str__(self): return str(self.Get())
def __repr__(self): return 'wx.Point'+str(self.Get())
def __len__(self): return len(self.Get())
DocStr(wxRect,
-"A class for representing and manipulating rectangles. It has x, y, width and
-height properties. In wxPython most palces that expect a wx.Rect can also
-accept a (x,y,width,height) tuple.");
+"A class for representing and manipulating rectangles. It has x, y,
+width and height properties. In wxPython most palces that expect a
+wx.Rect can also accept a (x,y,width,height) tuple.", "");
class wxRect
{
public:
DocCtorStr(
wxRect(int x=0, int y=0, int width=0, int height=0),
- "Create a new Rect object.");
+ "Create a new Rect object.", "");
DocCtorStrName(
wxRect(const wxPoint& topLeft, const wxPoint& bottomRight),
- "Create a new Rect object from Points representing two corners.",
+ "Create a new Rect object from Points representing two corners.", "",
RectPP);
DocCtorStrName(
wxRect(const wxPoint& pos, const wxSize& size),
- "Create a new Rect from a position and size.",
+ "Create a new Rect from a position and size.", "",
RectPS);
-
+
+ DocCtorStrName(
+ wxRect(const wxSize& size),
+ "Create a new Rect from a size only.", "",
+ RectS);
+
~wxRect();
int GetX() const;
wxSize GetSize() const;
void SetSize( const wxSize &s );
+ bool IsEmpty() const;
+
wxPoint GetTopLeft() const;
void SetTopLeft(const wxPoint &p);
wxPoint GetBottomRight() const;
DocDeclStr(
wxRect&, Inflate(wxCoord dx, wxCoord dy),
- "Increase the rectangle size by dx in x direction and dy in y direction. Both\n"
- "(or one of) parameters may be negative to decrease the rectangle size.");
+ "Increases the size of the rectangle.
+
+The left border is moved farther left and the right border is moved
+farther right by ``dx``. The upper border is moved farther up and the
+bottom border is moved farther down by ``dy``. (Note the the width and
+height of the rectangle thus change by ``2*dx`` and ``2*dy``,
+respectively.) If one or both of ``dx`` and ``dy`` are negative, the
+opposite happens: the rectangle size decreases in the respective
+direction.
+
+The change is made to the rectangle inplace, if instead you need a
+copy that is inflated, preserving the original then make the copy
+first::
+
+ copy = wx.Rect(*original)
+ copy.Inflate(10,15)
+
+", "
+Inflating and deflating behaves *naturally*. Defined more precisely,
+that means:
+
+ * Real inflates (that is, ``dx`` and/or ``dy`` >= 0) are not
+ constrained. Thus inflating a rectangle can cause its upper left
+ corner to move into the negative numbers. (The versions prior to
+ 2.5.4 forced the top left coordinate to not fall below (0, 0),
+ which implied a forced move of the rectangle.)
+
+ * Deflates are clamped to not reduce the width or height of the
+ rectangle below zero. In such cases, the top-left corner is
+ nonetheless handled properly. For example, a rectangle at (10,
+ 10) with size (20, 40) that is inflated by (-15, -15) will
+ become located at (20, 25) at size (0, 10). Finally, observe
+ that the width and height are treated independently. In the
+ above example, the width is reduced by 20, whereas the height is
+ reduced by the full 30 (rather than also stopping at 20, when
+ the width reached zero).
+
+:see: `Deflate`
+");
DocDeclStr(
wxRect&, Deflate(wxCoord dx, wxCoord dy),
- "Decrease the rectangle size by dx in x direction and dy in y direction. Both\n"
- "(or one of) parameters may be negative to increase the rectngle size. This\n"
- "method is the opposite of Inflate.");
+ "Decrease the rectangle size. This method is the opposite of `Inflate`
+in that Deflate(a,b) is equivalent to Inflate(-a,-b). Please refer to
+`Inflate` for a full description.", "");
DocDeclStrName(
void, Offset(wxCoord dx, wxCoord dy),
- "Moves the rectangle by the specified offset. If dx is positive, the rectangle\n"
- "is moved to the right, if dy is positive, it is moved to the bottom, otherwise\n"
- "it is moved to the left or top respectively.",
+ "Moves the rectangle by the specified offset. If dx is positive, the
+rectangle is moved to the right, if dy is positive, it is moved to the
+bottom, otherwise it is moved to the left or top respectively.", "",
OffsetXY);
DocDeclStr(
void, Offset(const wxPoint& pt),
- "Same as OffsetXY but uses dx,dy from Point");
+ "Same as OffsetXY but uses dx,dy from Point", "");
DocDeclStr(
- wxRect&, Intersect(const wxRect& rect),
- "Return the intersectsion of this rectangle and rect.");
+ wxRect, Intersect(const wxRect& rect),
+ "Returns the intersectsion of this rectangle and rect.", "");
+ DocDeclStr(
+ wxRect , Union(const wxRect& rect),
+ "Returns the union of this rectangle and rect.", "");
+
+
DocDeclStr(
wxRect, operator+(const wxRect& rect) const,
- "Add the properties of rect to this rectangle and return the result.");
+ "Add the properties of rect to this rectangle and return the result.", "");
DocDeclStr(
wxRect&, operator+=(const wxRect& rect),
- "Add the properties of rect to this rectangle, updating this rectangle.");
+ "Add the properties of rect to this rectangle, updating this rectangle.", "");
DocDeclStr(
bool, operator==(const wxRect& rect) const,
- "Test for equality.");
+ "Test for equality.", "");
DocDeclStr(
bool, operator!=(const wxRect& rect) const,
- "Test for inequality.");
+ "Test for inequality.", "");
- DocStr( Inside, "Return True if the point is (not strcitly) inside the rect.");
- %name(InsideXY)bool Inside(int x, int y) const;
+ DocStr( Inside, "Return True if the point is (not strcitly) inside the rect.", "");
+ %Rename(InsideXY, bool, Inside(int x, int y) const);
bool Inside(const wxPoint& pt) const;
DocDeclStr(
bool, Intersects(const wxRect& rect) const,
- "Returns True if the rectangles have a non empty intersection.");
+ "Returns True if the rectangles have a non empty intersection.", "");
int x, y, width, height;
%extend {
- DocStr(Set, "Set all rectangle properties.");
+ DocStr(Set, "Set all rectangle properties.", "");
void Set(int x=0, int y=0, int width=0, int height=0) {
self->x = x;
self->y = y;
DocAStr(Get,
"Get() -> (x,y,width,height)",
- "Return the rectangle properties as a tuple.");
+ "Return the rectangle properties as a tuple.", "");
PyObject* Get() {
- wxPyBeginBlockThreads();
+ wxPyBlock_t blocked = wxPyBeginBlockThreads();
PyObject* tup = PyTuple_New(4);
PyTuple_SET_ITEM(tup, 0, PyInt_FromLong(self->x));
PyTuple_SET_ITEM(tup, 1, PyInt_FromLong(self->y));
PyTuple_SET_ITEM(tup, 2, PyInt_FromLong(self->width));
PyTuple_SET_ITEM(tup, 3, PyInt_FromLong(self->height));
- wxPyEndBlockThreads();
+ wxPyEndBlockThreads(blocked);
return tup;
}
}
%pythoncode {
- asTuple = Get
+ asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
def __str__(self): return str(self.Get())
def __repr__(self): return 'wx.Rect'+str(self.Get())
def __len__(self): return len(self.Get())
};
+MustHaveApp(wxIntersectRect);
+
DocAStr(wxIntersectRect,
"IntersectRect(Rect r1, Rect r2) -> Rect",
- "Calculate and return the intersection of r1 and r2.");
+ "Calculate and return the intersection of r1 and r2.", "");
%inline %{
PyObject* wxIntersectRect(wxRect* r1, wxRect* r2) {
wxRegion reg1(*r1);
dest = reg1.GetBox();
if (dest != wxRect(0,0,0,0)) {
- wxPyBeginBlockThreads();
+ wxPyBlock_t blocked = wxPyBeginBlockThreads();
wxRect* newRect = new wxRect(dest);
- obj = wxPyConstructObject((void*)newRect, wxT("wxRect"), True);
- wxPyEndBlockThreads();
+ obj = wxPyConstructObject((void*)newRect, wxT("wxRect"), true);
+ wxPyEndBlockThreads(blocked);
return obj;
}
Py_INCREF(Py_None);
DocStr(wxPoint2D,
- "wx.Point2Ds represent a point or a vector in a 2d coordinate system with floating point values.");
+ "wx.Point2Ds represent a point or a vector in a 2d coordinate system
+with floating point values.", "");
class wxPoint2D
{
public:
- DocStr(wxPoint2D, "Create a w.Point2D object.");
+ DocStr(wxPoint2D, "Create a w.Point2D object.", "");
wxPoint2D( double x=0.0 , double y=0.0 );
- %name(Point2DCopy) wxPoint2D( const wxPoint2D &pt );
- %name(Point2DFromPoint) wxPoint2D( const wxPoint &pt );
+ %RenameCtor(Point2DCopy, wxPoint2D( const wxPoint2D &pt ));
+ %RenameCtor(Point2DFromPoint, wxPoint2D( const wxPoint &pt ));
DocDeclAStr(
void, GetFloor( int *OUTPUT , int *OUTPUT ) const,
"GetFloor() -> (x,y)",
- "Convert to integer");
+ "Convert to integer", "");
DocDeclAStr(
void, GetRounded( int *OUTPUT , int *OUTPUT ) const,
"GetRounded() -> (x,y)",
- "Convert to integer");
+ "Convert to integer", "");
double GetVectorLength() const;
double GetVectorAngle() const ;
DocDeclStr(
wxPoint2D, operator-(),
- "the reflection of this point");
+ "the reflection of this point", "");
wxPoint2D& operator+=(const wxPoint2D& pt);
wxPoint2D& operator-=(const wxPoint2D& pt);
DocDeclStr(
bool, operator==(const wxPoint2D& pt) const,
- "Test for equality");
+ "Test for equality", "");
DocDeclStr(
bool, operator!=(const wxPoint2D& pt) const,
- "Test for inequality");
+ "Test for inequality", "");
- %name(x)double m_x;
- %name(y)double m_y;
+ %Rename(x, double, m_x);
+ %Rename(y, double, m_y);
%extend {
void Set( double x=0 , double y=0 ) {
DocAStr(Get,
"Get() -> (x,y)",
- "Return x and y properties as a tuple.");
+ "Return x and y properties as a tuple.", "");
PyObject* Get() {
- wxPyBeginBlockThreads();
+ wxPyBlock_t blocked = wxPyBeginBlockThreads();
PyObject* tup = PyTuple_New(2);
PyTuple_SET_ITEM(tup, 0, PyFloat_FromDouble(self->m_x));
PyTuple_SET_ITEM(tup, 1, PyFloat_FromDouble(self->m_y));
- wxPyEndBlockThreads();
+ wxPyEndBlockThreads(blocked);
return tup;
}
}
%pythoncode {
- asTuple = Get
+ asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
def __str__(self): return str(self.Get())
def __repr__(self): return 'wx.Point2D'+str(self.Get())
def __len__(self): return len(self.Get())
projects / wxWidgets.git / blobdiff