wxregioniterator

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

wxobject

include files

<wx/region.h>

see also

wxpaintevent

members

wxregioniterator::wxregioniterator
wxregioniterator::getx
wxregioniterator::gety
wxregioniterator::getw
wxregioniterator::getheight
wxregioniterator::geth
wxregioniterator::getrect
wxregioniterator::getwidth
wxregioniterator::haverects
wxregioniterator::reset
wxregioniterator::operator ++
wxregioniterator::operator bool

wxregioniterator::wxregioniterator

wxregioniterator()

default constructor.

wxregioniterator(const wxregion& region)

creates an iterator object given a region.

wxregioniterator::getx

wxcoord getx() const

returns the x value for the current region.

wxregioniterator::gety

wxcoord gety() const

returns the y value for the current region.

wxregioniterator::getw

wxcoord getw() const

an alias for getwidth.

wxregioniterator::getheight

wxcoord getheight() const

returns the height value for the current region.

wxregioniterator::geth

wxcoord geth() const

an alias for getheight.

wxregioniterator::getrect

wxrect getrect() const

returns the current rectangle.

wxregioniterator::getwidth

wxcoord getwidth() const

returns the width value for the current region.

wxregioniterator::haverects

bool haverects() const

returns true if there are still some rectangles; otherwise returns false.

wxregioniterator::reset

void reset()

resets the iterator to the beginning of the rectangles.

void reset(const wxregion& region)

resets the iterator to the given region.

wxregioniterator::operator ++

void operator ++()

increment operator. increments the iterator to the next region.

wxpython note: a wxpython alias for this operator is called next.

wxregioniterator::operator bool

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.