Package wx :: Class Rect
[frames | no frames]

Type Rect

object --+
         |
        Rect


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.


Method Summary
Rect __init__(self, x, y, width, height)
Create a new Rect object.
Rect __add__(self, rect)
Add the properties of rect to this rectangle and return the result.
  __del__(self)
bool __eq__(self, other)
Test for equality of wx.Rect objects.
  __getitem__(self, index)
Rect __iadd__(self, rect)
Add the properties of rect to this rectangle, updating this rectangle.
  __len__(self)
bool __ne__(self, other)
Test for inequality of wx.Rect objects.
  __nonzero__(self)
  __reduce__(self)
  __repr__(self)
  __setitem__(self, index, val)
  __str__(self)
  asTuple(*args, **kwargs)
asTuple is deprecated, use Get instead
Rect Deflate(self, dx, dy)
Decrease the rectangle size.
(x,y,width,height) Get()
Return the rectangle properties as a tuple.
int GetBottom(self)
Point GetBottomRight(self)
int GetHeight(self)
int GetLeft(self)
Point GetPosition(self)
int GetRight(self)
Size GetSize(self)
int GetTop(self)
Point GetTopLeft(self)
int GetWidth(self)
int GetX(self)
int GetY(self)
Rect Inflate(self, dx, dy)
Increases the size of the rectangle.
bool Inside(self, pt)
Return True if the point is (not strcitly) inside the rect.
bool InsideXY(self, x, y)
Return True if the point is (not strcitly) inside the rect.
Rect Intersect(self, rect)
Returns the intersectsion of this rectangle and rect.
bool Intersects(self, rect)
Returns True if the rectangles have a non empty intersection.
bool IsEmpty(self)
  Offset(self, pt)
Same as OffsetXY but uses dx,dy from Point
  OffsetXY(self, dx, dy)
Moves the rectangle by the specified offset.
  Set(self, x, y, width, height)
Set all rectangle properties.
  SetBottom(self, bottom)
  SetBottomRight(self, p)
  SetHeight(self, h)
  SetLeft(self, left)
  SetPosition(self, p)
  SetRight(self, right)
  SetSize(self, s)
  SetTop(self, top)
  SetTopLeft(self, p)
  SetWidth(self, w)
  SetX(self, x)
  SetY(self, y)
Rect Union(self, rect)
Returns the union of this rectangle and rect.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
Return hash(x)...
  __new__(T, S, ...)
Return a new object with type S, a subtype of T...
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value

Property Summary
  bottom
  height
  left
  position
  right
  size
  top
  width
  x
  y

Class Variable Summary
bool __safe_for_unpickling__ = True

Method Details

__init__(self, x=0, y=0, width=0, height=0)
(Constructor)

Create a new Rect object.

Parameters:
x
           (type=int)

y
           (type=int)

width
           (type=int)

height
           (type=int)

Returns:
Rect
Overrides:
__builtin__.object.__init__

__add__(self, rect)
(Addition operator)

Add the properties of rect to this rectangle and return the result.

Parameters:
rect
           (type=Rect)

Returns:
Rect

__eq__(self, other)
(Equality operator)

Test for equality of wx.Rect objects.

Parameters:
other
           (type=PyObject)

Returns:
bool

__iadd__(self, rect)

Add the properties of rect to this rectangle, updating this rectangle.

Parameters:
rect
           (type=Rect)

Returns:
Rect

__ne__(self, other)

Test for inequality of wx.Rect objects.

Parameters:
other
           (type=PyObject)

Returns:
bool

asTuple(*args, **kwargs)

asTuple is deprecated, use Get instead

Deflate(self, dx, dy)

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.

Parameters:
dx
           (type=int)

dy
           (type=int)

Returns:
Rect

Get()

Return the rectangle properties as a tuple.

Returns:
(x,y,width,height)

Inflate(self, dx, dy)

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).
Parameters:
dx
           (type=int)

dy
           (type=int)

Returns:
Rect

See Also:

Deflate

Inside(self, pt)

Return True if the point is (not strcitly) inside the rect.

Parameters:
pt
           (type=Point)

Returns:
bool

InsideXY(self, x, y)

Return True if the point is (not strcitly) inside the rect.

Parameters:
x
           (type=int)

y
           (type=int)

Returns:
bool

Intersect(self, rect)

Returns the intersectsion of this rectangle and rect.

Parameters:
rect
           (type=Rect)

Returns:
Rect

Intersects(self, rect)

Returns True if the rectangles have a non empty intersection.

Parameters:
rect
           (type=Rect)

Returns:
bool

Offset(self, pt)

Same as OffsetXY but uses dx,dy from Point

Parameters:
pt
           (type=Point)

OffsetXY(self, dx, dy)

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.

Parameters:
dx
           (type=int)

dy
           (type=int)

Set(self, x=0, y=0, width=0, height=0)

Set all rectangle properties.

Parameters:
x
           (type=int)

y
           (type=int)

width
           (type=int)

height
           (type=int)

Union(self, rect)

Returns the union of this rectangle and rect.

Parameters:
rect
           (type=Rect)

Returns:
Rect

Property Details

bottom

Get Method:
GetBottom(self)
Set Method:
SetBottom(self, bottom)

left

Get Method:
GetLeft(self)
Set Method:
SetLeft(self, left)

position

Get Method:
GetPosition(self)
Set Method:
SetPosition(self, p)

right

Get Method:
GetRight(self)
Set Method:
SetRight(self, right)

size

Get Method:
GetSize(self)
Set Method:
SetSize(self, s)

top

Get Method:
GetTop(self)
Set Method:
SetTop(self, top)

Class Variable Details

__safe_for_unpickling__

Type:
bool
Value:
True                                                                   

Generated by Epydoc 2.1.20050511.rpd on Sat Jun 16 16:50:16 2007 http://epydoc.sf.net