From 76c5df2420c0a6e430ea0194ce0f7d93b316f119 Mon Sep 17 00:00:00 2001
From: Julian Smart <julian@anthemion.co.uk>
Date: Wed, 4 Nov 1998 22:16:10 +0000
Subject: [PATCH] Removed wxUpdateIterator documentation, added
 wxRegionIterator documentation.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@961 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
---
 docs/latex/wx/classes.tex  |   1 -
 docs/latex/wx/manual.tex   |   2 +-
 docs/latex/wx/referenc.tex |   2 +-
 docs/latex/wx/region.tex   | 105 +++++++++++++++++++++++++++++++++++++
 docs/latex/wx/upditer.tex  |  56 --------------------
 docs/latex/wx/window.tex   |  15 +++++-
 6 files changed, 120 insertions(+), 61 deletions(-)
 delete mode 100644 docs/latex/wx/upditer.tex

diff --git a/docs/latex/wx/classes.tex b/docs/latex/wx/classes.tex
index 56b7f3fadc..e58d9ec11b 100644
--- a/docs/latex/wx/classes.tex
+++ b/docs/latex/wx/classes.tex
@@ -171,7 +171,6 @@ $$\image{14cm;0cm}{wxclass.ps}$$
 \input toolbar.tex
 \input treectrl.tex
 \input treeevt.tex
-\input upditer.tex
 \input upduievt.tex
 \input url.tex
 \input validatr.tex
diff --git a/docs/latex/wx/manual.tex b/docs/latex/wx/manual.tex
index 5cceeb4106..58365be971 100644
--- a/docs/latex/wx/manual.tex
+++ b/docs/latex/wx/manual.tex
@@ -30,7 +30,7 @@
 %\winhelponly{\\$$\image{1cm;0cm}{wxwin.wmf}$$}
 }}
 \winhelpignore{\author{Julian Smart}
-\date{July 31st 1998}
+\date{November 4th 1998}
 }
 \makeindex
 \begin{document}
diff --git a/docs/latex/wx/referenc.tex b/docs/latex/wx/referenc.tex
index ea75f9f517..03981d1306 100644
--- a/docs/latex/wx/referenc.tex
+++ b/docs/latex/wx/referenc.tex
@@ -18,7 +18,7 @@
 \parindent=0pt
 \title{Reference Manual for wxWindows 2.0: a portable C++ GUI toolkit}
 \author{Julian Smart}
-\date{July 31st 1998}
+\date{November 4th 1998}
 
 \makeindex
 \begin{document}
diff --git a/docs/latex/wx/region.tex b/docs/latex/wx/region.tex
index 1d3c224ada..a2828e8e24 100644
--- a/docs/latex/wx/region.tex
+++ b/docs/latex/wx/region.tex
@@ -8,6 +8,10 @@ reference counting, so copying and assignment operations are fast.
 \helpref{wxGDIObject}{wxgdiobject}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{See also}
+
+\helpref{wxRegionIterator}{wxregioniterator}
+
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxRegion::wxRegion}\label{wxregionconstr}
@@ -179,4 +183,105 @@ for any overlapping areas. The result is stored in this region.
 
 Copies {\it region} by reference counting.
 
+\section{\class{wxRegionIterator}}\label{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 \helpref{wxWindow::OnPaint}{wxwindowonpaint} for an example of use.
+
+\wxheading{Derived from}
+
+\helpref{wxObject}{wxobject}
+
+\wxheading{See also}
+
+\helpref{wxWindow::OnPaint}{wxwindowonpaint}
+
+\latexignore{\rtfignore{\wxheading{Members}}}
+
+\membersection{wxRegionIterator::wxRegionIterator}
+
+\func{}{wxRegionIterator}{\void}
+
+Default constructor.
+
+\func{}{wxRegionIterator}{\param{const wxRegion\&}{ region}}
+
+Creates an iterator object given a region.
+
+\membersection{wxRegionIterator::GetX}
+
+\constfunc{long}{GetX}{\void}
+
+Returns the x value for the current region.
+
+\membersection{wxRegionIterator::GetY}
+
+\constfunc{long}{GetY}{\void}
+
+Returns the y value for the current region.
+
+\membersection{wxRegionIterator::GetW}
+
+\constfunc{long}{GetW}{\void}
+
+An alias for GetWidth.
+
+\membersection{wxRegionIterator::GetWidth}
+
+\constfunc{long}{GetWidth}{\void}
+
+Returns the width value for the current region.
+
+\membersection{wxRegionIterator::GetH}
+
+\constfunc{long}{GetH}{\void}
+
+An alias for GetHeight.
+
+\membersection{wxRegionIterator::GetHeight}
+
+\constfunc{long}{GetWidth}{\void}
+
+Returns the width value for the current region.
+
+\membersection{wxRegionIterator::GetRect}
+
+\constfunc{wxRect}{GetRect}{\void}
+
+Returns the current rectangle.
+
+\membersection{wxRegionIterator::HaveRects}
+
+\constfunc{bool}{HaveRects}{\void}
+
+Returns TRUE if there are still some rectangles; otherwise returns FALSE.
+
+\membersection{wxRegionIterator::Reset}
+
+\func{void}{Reset}{\void}
+
+Resets the iterator to the beginning of the rectangles.
+
+\func{void}{Reset}{\param{const wxRegion\&}{ region}}
+
+Resets the iterator to the given region.
+
+\membersection{wxRegionIterator::operator $++$}
+
+\func{void}{operator $++$}{\void}
+
+Increment operator. Increments the iterator to the next region.
+
+\membersection{wxRegionIterator::operator bool}
+
+\constfunc{}{operator bool}{\void}
+
+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.
 
diff --git a/docs/latex/wx/upditer.tex b/docs/latex/wx/upditer.tex
deleted file mode 100644
index 148d4960da..0000000000
--- a/docs/latex/wx/upditer.tex
+++ /dev/null
@@ -1,56 +0,0 @@
-\section{\class{wxUpdateIterator}}\label{wxupdateiterator}
-
-This class is used to iterate through all 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 \helpref{wxScrolledWindow::OnPaint}{wxscrolledwindowonpaint} for an example of use.
-
-\wxheading{Derived from}
-
-\helpref{wxObject}{wxobject}
-
-\wxheading{See also}
-
-\helpref{wxScrolledWindow::OnPaint}{wxscrolledwindowonpaint}
-
-\latexignore{\rtfignore{\wxheading{Members}}}
-
-\membersection{wxUpdateIterator::wxUpdateIterator}
-
-\func{}{wxUpdateIterator}{\param{wxWindow* }{window}}
-
-Creates an iterator object.
-
-\membersection{wxUpdateIterator::GetX}
-
-\func{int}{GetX}{\void}
-
-Returns the x value for the current region.
-
-\membersection{wxUpdateIterator::GetY}
-
-\func{int}{GetY}{\void}
-
-Returns the y value for the current region.
-
-\membersection{wxUpdateIterator::GetWidth}
-
-\func{int}{GetWidth}{\void}
-
-Returns the width value for the current region.
-
-\membersection{wxUpdateIterator::GetHeight}
-
-\func{int}{GetWidth}{\void}
-
-Returns the width value for the current region.
-
-\membersection{wxUpdateIterator::operator $++$}
-
-\func{void}{operator $++$}{\void}
-
-Increments the iterator to the next region.
-
-
diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex
index 6576b10ada..7ed5e858dc 100644
--- a/docs/latex/wx/window.tex
+++ b/docs/latex/wx/window.tex
@@ -620,6 +620,17 @@ Gets the window's title. Applicable only to frames and dialogs.
 
 \helpref{wxWindow::SetTitle}{wxwindowsettitle}
 
+\membersection{wxWindow::GetUpdateRegion}\label{wxwindowgetupdateregion}
+
+\constfunc{virtual wxRegion}{GetUpdateRegion}{\void}
+
+Returns the region specifying which parts of the window have been damaged. Should
+only be called within an \helpref{OnPaint}{wxwindowonpaint} event handler.
+
+\wxheading{See also}
+
+\helpref{wxRegion}{wxregion}, \helpref{wxRegionIterator}{wxregioniterator}, \helpref{wxWindow::OnPaint}{wxwindowonpaint}
+
 \membersection{wxWindow::GetWindowStyleFlag}
 
 \constfunc{long}{GetWindowStyleFlag}{\void}
@@ -1146,7 +1157,7 @@ terms of the client area, and are unscrolled, so you will need to do
 some calculations using the current view position to obtain logical,
 scrolled units.
 
-Here is an example of using the \helpref{wxUpdateIterator}{wxupdateiterator} class:
+Here is an example of using the \helpref{wxRegionIterator}{wxregioniterator} class:
 
 {\small%
 \begin{verbatim}
@@ -1160,7 +1171,7 @@ void MyWindow::OnPaint(wxPaintEvent& event)
   ViewStart(&vbX,&vbY);
 
   int vX,vY,vW,vH;                 // Dimensions of client area in pixels
-  wxUpdateIterator upd(this); // get the update rect list
+  wxRegionIterator upd(GetUpdateRegion()); // get the update rect list
 
   while (upd)
   {
-- 
2.50.0

