docs/latex/wx/upditer.tex

   1 \section{\class{wxUpdateIterator}}\label{wxupdateiterator}
   2
   3 This class is used to iterate through all damaged regions of a canvas, panel
   4 or dialog box, within an OnPaint call.
   5
   6 To use it, construct an iterator object on the stack and loop through the
   7 regions, testing the object and incrementing the iterator at the end of the loop.
   8
   9 See \helpref{wxScrolledWindow::OnPaint}{wxscrolledwindowonpaint} for an example of use.
  10
  11 \wxheading{Derived from}
  12
  13 \helpref{wxObject}{wxobject}
  14
  15 \wxheading{See also}
  16
  17 \helpref{wxScrolledWindow::OnPaint}{wxscrolledwindowonpaint}
  18
  19 \latexignore{\rtfignore{\wxheading{Members}}}
  20
  21 \membersection{wxUpdateIterator::wxUpdateIterator}
  22
  23 \func{}{wxUpdateIterator}{\param{wxWindow* }{window}}
  24
  25 Creates an iterator object.
  26
  27 \membersection{wxUpdateIterator::GetX}
  28
  29 \func{int}{GetX}{\void}
  30
  31 Returns the x value for the current region.
  32
  33 \membersection{wxUpdateIterator::GetY}
  34
  35 \func{int}{GetY}{\void}
  36
  37 Returns the y value for the current region.
  38
  39 \membersection{wxUpdateIterator::GetWidth}
  40
  41 \func{int}{GetWidth}{\void}
  42
  43 Returns the width value for the current region.
  44
  45 \membersection{wxUpdateIterator::GetHeight}
  46
  47 \func{int}{GetWidth}{\void}
  48
  49 Returns the width value for the current region.
  50
  51 \membersection{wxUpdateIterator::operator $++$}
  52
  53 \func{void}{operator $++$}{\void}
  54
  55 Increments the iterator to the next region.
  56
  57