*****************
wx.RegionIterator
*****************

Inheritance diagram for `wx.RegionIterator`:

|

.. inheritance-diagram:: 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 <../Events/wx.PaintEvent.html>`_ for an example of use.


.. seealso:: `wx.PaintEvent <../Events/wx.PaintEvent.html>`_


Derived From
^^^^^^^^^^^^^

* `wx.Object <wx.Object.html>`_ 


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `GetH <#GetH>`_ 
* `GetHeight <#GetHeight>`_ 
* `GetRect <#GetRect>`_ 
* `GetW <#GetW>`_ 
* `GetWidth <#GetWidth>`_ 
* `GetX <#GetX>`_ 
* `GetY <#GetY>`_ 
* `HaveRects <#HaveRects>`_ 
* `Next <#Next>`_ 
* `Reset <#Reset>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `H <#H>`_ 
* `Height <#Height>`_ 
* `Rect <#Rect>`_ 
* `W <#W>`_ 
* `Width <#Width>`_ 
* `X <#X>`_ 
* `Y <#Y>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(region)

   Creates an iterator object given a region.

   **Parameters:**

   * `region` (`wx.Region <wx.Region.html>`_)

   |

   **Returns:**

   `wx.RegionIterator <wx.RegionIterator.html>`_
 

--------

.. method:: GetH()

   An alias for GetHeight.

   |  

   **Returns:**

   `int` 

--------

.. method:: GetHeight()

   Returns the height value for the current region.

   |  

   **Returns:**

   `int` 

--------

.. method:: GetRect()

   Returns the current rectangle.

   |  

   **Returns:**

   `wx.Rect <wx.Rect.html>`_
 

--------

.. method:: GetW()

   An alias for GetWidth.

   |  

   **Returns:**

   `int` 

--------

.. method:: GetWidth()

   Returns the width value for the current region.

   |  

   **Returns:**

   `int` 

--------

.. method:: GetX()

   Returns the x value for the current region.

   |  

   **Returns:**

   `int` 

--------

.. method:: GetY()

   Returns the y value for the current region.

   |  

   **Returns:**

   `int` 

--------

.. method:: HaveRects()

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

   |  

   **Returns:**

   `bool` 

--------

.. method:: Next()

   `No docstrings available for this method.` 

--------


.. method:: Reset()

   Resets the iterator to the given region.


--------

Properties
^^^^^^^^^^


.. attribute:: H

   See `GetH <#GetH>`_

.. attribute:: Height

   See `GetHeight <#GetHeight>`_

.. attribute:: Rect

   See `GetRect <#GetRect>`_

.. attribute:: W

   See `GetW <#GetW>`_

.. attribute:: Width

   See `GetWidth <#GetWidth>`_

.. attribute:: X

   See `GetX <#GetX>`_

.. attribute:: Y

   See `GetY <#GetY>`_