]> git.saurik.com Git - wxWidgets.git/blobdiff - contrib/docs/latex/fl/bariterator.tex
corrected version number extraction
[wxWidgets.git] / contrib / docs / latex / fl / bariterator.tex
index 2b919c5138281d8e48ab8892381c9214e9f6a8f0..e8ed66afc69fe57de2ebe44b2f6629d7c3ca19af 100644 (file)
@@ -1,18 +1,22 @@
 %
 % automatically generated by HelpGen $Revision$ from
 %
 % automatically generated by HelpGen $Revision$ from
-% controlbar.h at 05/Jan/02 22:50:59
+% controlbar.h at 21/Jan/02 21:14:14
 %
 
 
 \section{\class{wxBarIterator}}\label{wxbariterator}
 
 
 %
 
 
 \section{\class{wxBarIterator}}\label{wxbariterator}
 
 
-used for traversing through all bars of all rows in the pane
+Used for traversing through all bars of all rows in the pane.
 
 \wxheading{Derived from}
 
 No base class
 
 
 \wxheading{Derived from}
 
 No base class
 
+\wxheading{Include files}
+
+<wx/fl/controlbar.h>
+
 \wxheading{Data structures}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 \wxheading{Data structures}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
@@ -22,27 +26,33 @@ No base class
 
 \func{}{wxBarIterator}{\param{RowArrayT\& }{rows}}
 
 
 \func{}{wxBarIterator}{\param{RowArrayT\& }{rows}}
 
+Constructor, taking row array.
+
 
 \membersection{wxBarIterator::BarInfo}\label{wxbariteratorbarinfo}
 
 \func{cbBarInfo\&}{BarInfo}{\void}
 
 
 \membersection{wxBarIterator::BarInfo}\label{wxbariteratorbarinfo}
 
 \func{cbBarInfo\&}{BarInfo}{\void}
 
+Gets the current bar information.
+
 
 \membersection{wxBarIterator::Next}\label{wxbariteratornext}
 
 \func{bool}{Next}{\void}
 
 
 \membersection{wxBarIterator::Next}\label{wxbariteratornext}
 
 \func{bool}{Next}{\void}
 
-TRUE, if next bar is available
+Advances the iterator and returns TRUE if a bar is available.
 
 
 \membersection{wxBarIterator::Reset}\label{wxbariteratorreset}
 
 \func{void}{Reset}{\void}
 
 
 
 \membersection{wxBarIterator::Reset}\label{wxbariteratorreset}
 
 \func{void}{Reset}{\void}
 
+Resets the iterator to the start of the first row.
+
 
 \membersection{wxBarIterator::RowInfo}\label{wxbariteratorrowinfo}
 
 \func{cbRowInfo\&}{RowInfo}{\void}
 
 
 \membersection{wxBarIterator::RowInfo}\label{wxbariteratorrowinfo}
 
 \func{cbRowInfo\&}{RowInfo}{\void}
 
-returns reference to currently traversed row
+Returns a reference to the currently traversed row.