The iterator class. More...
#include <iterator.hpp>
Public Member Functions | |
| titerator (twidget &root) | |
| Contstructor. | |
| bool | at_end () const |
| Has the iterator reached the end? | |
| bool | next () |
| Visit the next widget. | |
| titerator< order > & | operator++ () |
| See next. | |
| twidget & | operator* () |
| Returns the current widget. | |
| twidget * | operator-> () |
| See operator*. | |
Detailed Description
template<class order>
class gui2::iterator::titerator< order >
The iterator class.
- See also:
- Iterator for more information.
Definition at line 38 of file iterator.hpp.
Constructor & Destructor Documentation
template<class order>
| gui2::iterator::titerator< order >::titerator | ( | twidget & | root | ) | [inline] |
Contstructor.
- Parameters:
-
root The widget where to start the iteration.
Definition at line 49 of file iterator.hpp.
Member Function Documentation
template<class order>
| bool gui2::iterator::titerator< order >::at_end | ( | ) | const [inline] |
Has the iterator reached the end?
- Returns:
- The status.
- Return values:
-
[true] At the end. [false] Not at the end.
Definition at line 61 of file iterator.hpp.
template<class order>
| bool gui2::iterator::titerator< order >::next | ( | ) | [inline] |
Visit the next widget.
- Precondition:
- at_end() == false
- Exceptions:
-
@ref trange_error upon pre condition violation.
- Returns:
- Whether the next widget can be safely deferred.
Definition at line 73 of file iterator.hpp.
Referenced by gui2::iterator::titerator< order >::operator++().
Here is the caller graph for this function:
template<class order>
| twidget& gui2::iterator::titerator< order >::operator* | ( | ) | [inline] |
Returns the current widget.
- Returns:
- The current widget.
Definition at line 87 of file iterator.hpp.
Referenced by gui2::iterator::titerator< order >::operator->().
Here is the caller graph for this function:
template<class order>
| titerator<order>& gui2::iterator::titerator< order >::operator++ | ( | ) | [inline] |
See next.
Definition at line 76 of file iterator.hpp.
References gui2::iterator::titerator< order >::next().
Here is the call graph for this function:
template<class order>
| twidget* gui2::iterator::titerator< order >::operator-> | ( | ) | [inline] |
See operator*.
Definition at line 90 of file iterator.hpp.
References gui2::iterator::titerator< order >::operator*().
Here is the call graph for this function:
The documentation for this class was generated from the following file:
- gui/auxiliary/iterator/iterator.hpp