wx.RegionIterator

Inheritance diagram for wx.RegionIterator:

Description

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

Derived From

• wx.Object

Methods Summary

• __init__
• GetH
• GetHeight
• GetRect
• GetW
• GetWidth
• GetX
• GetY
• HaveRects
• Next
• Reset

Properties Summary

• H
• Height
• Rect
• W
• Width
• X
• Y

Class API

Methods

__init__(region)

Creates an iterator object given a region.

Parameters:

• region (wx.Region)

Returns:

wx.RegionIterator

---

GetH()

An alias for GetHeight.

Returns:

int

---

GetHeight()

Returns the height value for the current region.

Returns:

int

---

GetRect()

Returns the current rectangle.

Returns:

wx.Rect

---

GetW()

An alias for GetWidth.

Returns:

int

---

GetWidth()

Returns the width value for the current region.

Returns:

int

---

GetX()

Returns the x value for the current region.

Returns:

int

---

GetY()

Returns the y value for the current region.

Returns:

int

---

HaveRects()

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

Returns:

bool

---

Next()

No docstrings available for this method.

---

Reset()

Resets the iterator to the given region.

---

Properties

H

See GetH

Height

See GetHeight

Rect

See GetRect

W

See GetW

Width

See GetWidth

X

See GetX

Y

See GetY