GlsMenu  1.5.4
GlsMenu Class Reference

#include <gls_menu.h>

Inheritance diagram for GlsMenu:
GlsMenuDataGroup GlsMenuData GlsMenu_T< MenuItem_t, MenuItemId_t > GlsMenu_T< MenuItem_t, GlsMFD::MenuItemId_t > GlsMFDMenu_T< MenuItem_t, Submenu_t, PageId_t >

Public Member Functions

virtual void Hide ()
 
virtual void Show ()
 
const GlsMenuDictionaryAttributes () const
 
virtual std::istream & ReadValue (std::istream &instr)
 
virtual std::ostream & WriteValue (std::ostream &outstr)
 
virtual void Inc (long amount=1)
 

Protected Member Functions

 GlsMenu (const std::string &name, GlsMenuDictionary &dataDict, GlsMenuAction::HandlerCont_t &actionHandlers)
 
virtual ~GlsMenu ()
 

Protected Attributes

GlsMenuDictionary _attr
 The dictionary of attributes for the group attribute. More...
 

Private Attributes

GlsMenuActionGroup_onShowActions
 Group of actions to execute when menu is shown. More...
 
GlsMenuActionGroup_onHideActions
 Group of actions to execute when menu is hidden. More...
 

Detailed Description

The GlsMenu class provides a base menu class.

Definition at line 58 of file gls_menu.h.

Constructor & Destructor Documentation

GlsMenu::GlsMenu ( const std::string &  name,
GlsMenuDictionary dataDict,
GlsMenuAction::HandlerCont_t actionHandlers 
)
protected

Class constructor.

Parameters
namethe name of the menu.
dataDictthe menu data dictionary used to evaluate menu data variables
actionHandlersThese are handlers for menu actions passed in by the menu creator. These are considered local to the set of menus.
virtual GlsMenu::~GlsMenu ( )
protectedvirtual

Class destructor.

Member Function Documentation

const GlsMenuDictionary& GlsMenuDataGroup::Attributes ( ) const
inlineinherited

Read attribute dictionary from an input stream.

Parameters
instrinput stream to read value from.

Definition at line 78 of file gls_menu_data_group.h.

References GlsMenuDataGroup::_attr.

Referenced by GlsMFDMenu_T< MenuItem_t, Submenu_t, PageId_t >::ReadValue().

virtual void GlsMenu::Hide ( )
virtual

Hide the menu. Perform necessary logic for when a menu is newly hidden for the first time after being shown. This should not be called on a cyclical basis, but when a "hide menu" event occurs.

virtual void GlsMenuData::Inc ( long  amount = 1)
virtualinherited

Increment the data item. Derived classes must override this as the default is a no-op.

Reimplemented in GlsMenuDiscrete_T< T >.

Referenced by GlsMenuSet_T< MenuType_t, DataFactory_t >::IncData().

virtual std::istream& GlsMenuDataGroup::ReadValue ( std::istream &  instr)
virtualinherited

Read attribute dictionary from an input stream.

Parameters
instrinput stream to read value from.

Reimplemented in GlsMFDMenu_T< MenuItem_t, Submenu_t, PageId_t >, and GlsMenuDynDataGroup.

Referenced by GlsMFDMenu_T< MenuItem_t, Submenu_t, PageId_t >::ReadValue().

virtual void GlsMenu::Show ( )
virtual

Show the menu. Perform necessary logic for when a menu is newly shown for the first time or after being hidden. This should not be called on a cyclical basis, but when a "show menu" event occurs.

virtual std::ostream& GlsMenuDataGroup::WriteValue ( std::ostream &  outstr)
virtualinherited

Read attribute dictionary from an input stream.

Parameters
instrinput stream to read value from.

Field Documentation

GlsMenuActionGroup* GlsMenu::_onHideActions
private

Group of actions to execute when menu is hidden.

Definition at line 108 of file gls_menu.h.

GlsMenuActionGroup* GlsMenu::_onShowActions
private

Group of actions to execute when menu is shown.

Definition at line 105 of file gls_menu.h.


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