wxRegionIterator Class Reference
[Graphics Device Interface (GDI)]
#include <wx/region.h>
Detailed 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 wxPaintEvent for an example of use.
Predefined objects/pointers: wxNullRegion
- See also:
- wxPaintEvent
Public Member Functions | |
| wxRegionIterator () | |
| wxRegionIterator (const wxRegion ®ion) | |
| wxCoord | GetH () const |
| wxCoord | GetHeight () const |
| wxRect | GetRect () const |
| wxCoord | GetW () const |
| wxCoord | GetWidth () const |
| wxCoord | GetX () const |
| wxCoord | GetY () const |
| bool | HaveRects () const |
| void | Reset () |
| void | Reset (const wxRegion ®ion) |
| wxRegionIterator & | operator++ () |
| operator bool () const | |
Constructor & Destructor Documentation
| wxRegionIterator::wxRegionIterator | ( | ) |
Default constructor.
| wxRegionIterator::wxRegionIterator | ( | const wxRegion & | region | ) |
Creates an iterator object given a region.
Member Function Documentation
| wxCoord wxRegionIterator::GetH | ( | ) | const |
An alias for GetHeight().
| wxCoord wxRegionIterator::GetHeight | ( | ) | const |
Returns the height value for the current region.
| wxRect wxRegionIterator::GetRect | ( | ) | const |
Returns the current rectangle.
| wxCoord wxRegionIterator::GetW | ( | ) | const |
An alias for GetWidth().
| wxCoord wxRegionIterator::GetWidth | ( | ) | const |
Returns the width value for the current region.
| wxCoord wxRegionIterator::GetX | ( | ) | const |
Returns the x value for the current region.
| wxCoord wxRegionIterator::GetY | ( | ) | const |
Returns the y value for the current region.
| bool wxRegionIterator::HaveRects | ( | ) | const |
Returns true if there are still some rectangles; otherwise returns false.
| void wxRegionIterator::Reset | ( | ) |
Resets the iterator to the beginning of the rectangles.
| void wxRegionIterator::Reset | ( | const wxRegion & | region | ) |
Resets the iterator to the given region.
| wxRegionIterator& wxRegionIterator::operator++ | ( | ) |
Increment operator. Increments the iterator to the next region.
wxPython Note: A wxPython alias for this operator is called Next.
| wxRegionIterator::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.
