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