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 wxPaintEvent for an example of use.
Derived from
Include files
<wx/region.h>
See also
Members
wxRegionIterator::wxRegionIterator
wxRegionIterator::GetX
wxRegionIterator::GetY
wxRegionIterator::GetW
wxRegionIterator::GetWidth
wxRegionIterator::GetH
wxRegionIterator::GetHeight
wxRegionIterator::GetRect
wxRegionIterator::HaveRects
wxRegionIterator::Reset
wxRegionIterator::operator ++
wxRegionIterator::operator bool
wxRegionIterator()
Default constructor.
wxRegionIterator(const wxRegion& region)
Creates an iterator object given a region.
wxCoord GetX() const
Returns the x value for the current region.
wxCoord GetY() const
Returns the y value for the current region.
wxCoord GetW() const
An alias for GetWidth.
wxCoord GetWidth() const
Returns the width value for the current region.
wxCoord GetH() const
An alias for GetHeight.
wxCoord GetWidth() const
Returns the width value for the current region.
wxRect GetRect() const
Returns the current rectangle.
bool HaveRects() const
Returns true if there are still some rectangles; otherwise returns false.
void Reset()
Resets the iterator to the beginning of the rectangles.
void Reset(const wxRegion& region)
Resets the iterator to the given region.
void operator ++()
Increment operator. Increments the iterator to the next region.
wxPython note: A wxPython alias for this operator is called Next.
operator bool() const
Returns true if there are still some rectangles; otherwise returns false.
You can use this to test the iterator object as if it were of type bool.