The Battle for Wesnoth  1.15.2+dev
Public Member Functions | Private Attributes | List of all members
gui2::iteration::grid Class Reference

A walker for a gui2::grid. More...

#include <walker_grid.hpp>

Inheritance diagram for gui2::iteration::grid:
Inheritance graph

Public Member Functions

 grid (gui2::grid &grid)
 Constructor. More...
 
virtual state_t next (const level level)
 Inherited from gui2::iteration::walker_base. More...
 
virtual bool at_end (const level level) const
 Inherited from gui2::iteration::walker_base. More...
 
virtual gui2::widgetget (const level level)
 Inherited from gui2::iteration::walker_base. More...
 
- Public Member Functions inherited from gui2::iteration::walker_base
virtual ~walker_base ()
 

Private Attributes

gui2::gridgrid_
 The grid which the walker is attached to. More...
 
gui2::widgetwidget_
 The grid which the walker is attached to. More...
 
gui2::grid::iterator itor_
 The iterator to the children of grid_. More...
 

Additional Inherited Members

- Public Types inherited from gui2::iteration::walker_base
enum  level { self, internal, child }
 The level to walk at. More...
 
enum  state_t { valid, invalid, fail }
 The state of the walker. More...
 

Detailed Description

A walker for a gui2::grid.

Definition at line 28 of file walker_grid.hpp.

Constructor & Destructor Documentation

◆ grid()

gui2::iteration::grid::grid ( gui2::grid grid)
explicit

Constructor.

Parameters
gridThe grid which the walker is attached to.

Definition at line 29 of file walker_grid.cpp.

Member Function Documentation

◆ at_end()

bool gui2::iteration::grid::at_end ( const level  level) const
virtual

Inherited from gui2::iteration::walker_base.

Implements gui2::iteration::walker_base.

Definition at line 61 of file walker_grid.cpp.

References gui2::iteration::walker_base::child, gui2::grid::end(), grid_, itor_, and widget_.

Referenced by next().

◆ get()

gui2::widget * gui2::iteration::grid::get ( const level  level)
virtual

◆ next()

walker_base::state_t gui2::iteration::grid::next ( const level  level)
virtual

Member Data Documentation

◆ grid_

gui2::grid& gui2::iteration::grid::grid_
private

The grid which the walker is attached to.

Definition at line 49 of file walker_grid.hpp.

Referenced by at_end(), get(), and next().

◆ itor_

gui2::grid::iterator gui2::iteration::grid::itor_
private

The iterator to the children of grid_.

This variable is used to track where the gui2::iteration::walker_base::child level visiting is.

Definition at line 65 of file walker_grid.hpp.

Referenced by at_end(), get(), and next().

◆ widget_

gui2::widget* gui2::iteration::grid::widget_
private

The grid which the walker is attached to.

This variable is used to track whether the gui2::iteration::walker_base::widget level has been visited.

Definition at line 57 of file walker_grid.hpp.

Referenced by at_end(), get(), and next().


The documentation for this class was generated from the following files: