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