contrib/docs/latex/fl/bariterator.tex

   1 %
   2 % automatically generated by HelpGen $Revision$ from
   3 % controlbar.h at 21/Jan/02 21:14:14
   4 %
   5
   6
   7 \section{\class{wxBarIterator}}\label{wxbariterator}
   8
   9
  10 Used for traversing through all bars of all rows in the pane.
  11
  12 \wxheading{Derived from}
  13
  14 No base class
  15
  16 \wxheading{Include files}
  17
  18 <wx/fl/controlbar.h>
  19
  20 \wxheading{Data structures}
  21
  22 \latexignore{\rtfignore{\wxheading{Members}}}
  23
  24
  25 \membersection{wxBarIterator::wxBarIterator}\label{wxbariteratorwxbariterator}
  26
  27 \func{}{wxBarIterator}{\param{RowArrayT\& }{rows}}
  28
  29 Constructor, taking row array.
  30
  31
  32 \membersection{wxBarIterator::BarInfo}\label{wxbariteratorbarinfo}
  33
  34 \func{cbBarInfo\&}{BarInfo}{\void}
  35
  36 Gets the current bar information.
  37
  38
  39 \membersection{wxBarIterator::Next}\label{wxbariteratornext}
  40
  41 \func{bool}{Next}{\void}
  42
  43 Advances the iterator and returns TRUE if a bar is available.
  44
  45
  46 \membersection{wxBarIterator::Reset}\label{wxbariteratorreset}
  47
  48 \func{void}{Reset}{\void}
  49
  50 Resets the iterator to the start of the first row.
  51
  52
  53 \membersection{wxBarIterator::RowInfo}\label{wxbariteratorrowinfo}
  54
  55 \func{cbRowInfo\&}{RowInfo}{\void}
  56
  57 Returns a reference to the currently traversed row.
  58