wx.Rect¶

Inheritance diagram for wx.Rect:

Description¶

A class for manipulating rectangles.

See also

wx.Point, wx.Size

Methods Summary¶

Properties Summary¶

Bottom
BottomLeft
BottomRight
Empty
Height
Left
Position
Right
Size
Top
TopLeft
TopRight
Width
X
Y
bottom
height
left
position
right
size
top
width
x
y

Class API¶

Methods¶

__init__(x=0, y=0, width=0, height=0)¶

Create a new wx.Rect object.

Parameters:

x (int)
y (int)
width (int)
height (int)

Returns:

wx.Rect

CenterIn(r, dir=wx.BOTH)¶

Returns the rectangle having the same size as this one but centered relatively to the given rectangle r. By default, rectangle is centred in both directions but if dir includes only wx.VERTICAL or only wx.HORIZONTAL flag, then it is only centered in this direction while the other component of its position remains unchanged.

Parameters:

r (wx.Rect)
dir (int)

Returns:

wx.Rect

CentreIn(r, dir=wx.BOTH)¶

Returns the rectangle having the same size as this one but centered relatively to the given rectangle r. By default, rectangle is centred in both directions but if dir includes only wx.VERTICAL or only wx.HORIZONTAL flag, then it is only centered in this direction while the other component of its position remains unchanged.

Parameters:

r (wx.Rect)
dir (int)

Returns:

wx.Rect

Contains(x, y)¶

Returns True if the given rectangle is completely inside this rectangle (or touches its boundary) and False otherwise.

Parameters:

x (int)
y (int)

Returns:

bool

ContainsRect(rect)¶

Returns True if the given rectangle is completely inside this rectangle or touches its boundary.

Parameters:

rect (wx.Rect)

Returns:

bool

ContainsXY(x, y)¶

Return True if the point is inside the rect.

Parameters:

x (int)
y (int)

Returns:

bool

Deflate(dx, dy)¶

Decrease the rectangle size.

This method is the opposite from Inflate: Deflate(a, b) is equivalent to Inflate(-a, -b). Please refer to Inflate for full description.

Parameters:

dx (int)
dy (int)

See also

Inflate

Get()¶

Return the rectangle properties as a tuple.

Returns:

(x, y, width, height)

GetBottom()¶

Gets the bottom point of the rectangle.

Returns:

int

GetBottomLeft()¶

Gets the position of the bottom left corner.

Returns:

wx.Point

GetBottomRight()¶

Gets the position of the bottom right corner.

Returns:

wx.Point

GetHeight()¶

Gets the height member.

Returns:

int

GetLeft()¶

Gets the left point of the rectangle (the same as GetX).

Returns:

int

GetPosition()¶

Gets the position.

Returns:

wx.Point

GetRight()¶

Gets the right point of the rectangle.

Returns:

int

GetSize()¶

Gets the size.

Returns:

wx.Size

See also

SetSize

GetTop()¶

Gets the top point of the rectangle (the same as GetY).

Returns:

int

GetTopLeft()¶

Gets the position of the top left corner of the rectangle, same as GetPosition.

Returns:

wx.Point

GetTopRight()¶

Gets the position of the top right corner.

Returns:

wx.Point

GetWidth()¶

Gets the width member.

Returns:

int

GetX()¶

Gets the x member.

Returns:

int

GetY()¶

Gets the y member.

Returns:

int

Inflate(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)

Parameters:

dx (int)
dy (int)

See also

Deflate

Intersect(rect)¶

Modifies the rectangle to contain the overlapping box of this rectangle and the one passed in as parameter. The version returns the new rectangle, the other one modifies this rectangle in place.

Parameters:

rect (wx.Rect)

Returns:

wx.Rect

Intersects(rect)¶

Returns True if this rectangle has a non-empty intersection with the rectangle rect and False otherwise.

Parameters:

rect (wx.Rect)

Returns:

bool

IsEmpty()¶

Returns True if this rectangle has a width or height less than or equal to 0 and False otherwise.

Returns:

bool

Offset(pt)¶

Same as OffsetXY but uses dx, dy from pt.

Parameters:

pt (wx.Point)

OffsetXY(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: