Phoenix Logo

phoenix_title wx.RegionIterator

This class is used to iterate through the rectangles in a region, typically when examining the damaged regions of a window within an OnPaint call.

To use it, construct an iterator object on the stack and loop through the regions, testing the object and incrementing the iterator at the end of the loop.

See wx.PaintEvent for an example of use.

See also

wx.PaintEvent


class_hierarchy Class Hierarchy

Inheritance diagram for class RegionIterator:


method_summary Methods Summary

__init__ Default constructor.
GetH An alias for GetHeight .
GetHeight Returns the height value for the current region.
GetRect Returns the current rectangle.
GetW An alias for GetWidth .
GetWidth Returns the width value for the current region.
GetX Returns the x value for the current region.
GetY Returns the y value for the current region.
HaveRects Returns True if there are still some rectangles; otherwise returns False.
Next Move the iterator to the next rectangle in the region.
Reset Resets the iterator to the beginning of the rectangles.
__nonzero__ Returns True while there are still rectangles available in the iteration.

property_summary Properties Summary

H See GetH
Height See GetHeight
Rect See GetRect
W See GetW
Width See GetWidth
X See GetX
Y See GetY

api Class API



class wx.RegionIterator(Object)

Possible constructors:

RegionIterator()

RegionIterator(region)

This class is used to iterate through the rectangles in a region, typically when examining the damaged regions of a window within an OnPaint call.


Methods



__init__(self, *args, **kw)

overload Overloaded Implementations:



__init__ (self)

Default constructor.



__init__ (self, region)

Creates an iterator object given a region.

Parameters:region (wx.Region) –





GetH(self)

An alias for GetHeight .

Return type:wx.Coord


GetHeight(self)

Returns the height value for the current region.

Return type:wx.Coord


GetRect(self)

Returns the current rectangle.

Return type: wx.Rect


GetW(self)

An alias for GetWidth .

Return type:wx.Coord


GetWidth(self)

Returns the width value for the current region.

Return type:wx.Coord


GetX(self)

Returns the x value for the current region.

Return type:wx.Coord


GetY(self)

Returns the y value for the current region.

Return type:wx.Coord


HaveRects(self)

Returns True if there are still some rectangles; otherwise returns False.

Return type:bool


Next(self)

Move the iterator to the next rectangle in the region.



Reset(self, *args, **kw)

overload Overloaded Implementations:



Reset (self)

Resets the iterator to the beginning of the rectangles.



Reset (self, region)

Resets the iterator to the given region.

Parameters:region (wx.Region) –





__nonzero__(self)

Returns True while there are still rectangles available in the iteration.

Return type:int

Properties



H

See GetH



Height

See GetHeight



Rect

See GetRect



W

See GetW



Width

See GetWidth



X

See GetX



Y

See GetY