PlasCom2  1.0
XPACC Multi-physics simluation application
Public Member Functions | Private Attributes | List of all members
MenuObject< ConfigType, ParamType > Class Template Reference

Detailed Description

template<typename ConfigType = util::ConfigurationObject, typename ParamType = util::ConfigParameters>
class ix::util::MenuObject< ConfigType, ParamType >

Definition at line 19 of file Menu.H.

#include <Menu.H>

Public Member Functions

 MenuObject ()
 
std::string LastSection () const
 
std::string hRule ()
 
std::string centerString (const std::string &message)
 
virtual std::string menuString (ConfigType &config, const std::string &section)
 
std::string navigationString (ConfigType &config, const std::string &section)
 
void SetExternalBorder (const std::string &eb)
 
std::string Border () const
 
void SetHeader (const std::string &hdr)
 
std::string Header () const
 
void SetHRule (const std::string &hrule)
 
void SetVRule (const std::string &vrule)
 
void SetFieldSeparator (const std::string &sep)
 
void SetMenuWidth (unsigned int wid)
 
void SetColumnLength (unsigned int colen)
 

Private Attributes

std::string _header
 
std::string _external_border
 
std::string _vertical_rule
 
std::string _horizontal_rule
 
std::string _field_separator
 
strsize _menu_width
 
int _column_length
 
std::string _last_section
 
std::string _next_section
 
std::string _up_section
 
Collaboration diagram for MenuObject< ConfigType, ParamType >:
[legend]

Constructor & Destructor Documentation

◆ MenuObject()

MenuObject ( )
inline

Definition at line 22 of file Menu.H.

Member Function Documentation

◆ Border()

std::string Border ( ) const
inline

Definition at line 219 of file Menu.H.

References MenuObject< ConfigType, ParamType >::_external_border.

◆ centerString()

std::string centerString ( const std::string &  message)
inline

Definition at line 37 of file Menu.H.

References MenuObject< ConfigType, ParamType >::_external_border, and MenuObject< ConfigType, ParamType >::_menu_width.

Referenced by MenuObject< ConfigType, ParamType >::menuString(), and MenuObject< ConfigType, ParamType >::navigationString().

Here is the caller graph for this function:

◆ Header()

std::string Header ( ) const
inline

Definition at line 225 of file Menu.H.

References MenuObject< ConfigType, ParamType >::_header.

◆ hRule()

std::string hRule ( )
inline

Definition at line 25 of file Menu.H.

References MenuObject< ConfigType, ParamType >::_external_border, MenuObject< ConfigType, ParamType >::_horizontal_rule, and MenuObject< ConfigType, ParamType >::_menu_width.

Referenced by MenuObject< ConfigType, ParamType >::menuString(), and MenuObject< ConfigType, ParamType >::navigationString().

Here is the caller graph for this function:

◆ LastSection()

std::string LastSection ( ) const
inline

Definition at line 24 of file Menu.H.

References MenuObject< ConfigType, ParamType >::_last_section.

◆ menuString()

virtual std::string menuString ( ConfigType &  config,
const std::string &  section 
)
inlinevirtual

Definition at line 57 of file Menu.H.

References MenuObject< ConfigType, ParamType >::_column_length, MenuObject< ConfigType, ParamType >::_external_border, MenuObject< ConfigType, ParamType >::_field_separator, MenuObject< ConfigType, ParamType >::_header, MenuObject< ConfigType, ParamType >::_last_section, MenuObject< ConfigType, ParamType >::_menu_width, MenuObject< ConfigType, ParamType >::_vertical_rule, MenuObject< ConfigType, ParamType >::centerString(), and MenuObject< ConfigType, ParamType >::hRule().

Here is the call graph for this function:

◆ navigationString()

std::string navigationString ( ConfigType &  config,
const std::string &  section 
)
inline

Definition at line 143 of file Menu.H.

References MenuObject< ConfigType, ParamType >::_column_length, MenuObject< ConfigType, ParamType >::_external_border, MenuObject< ConfigType, ParamType >::_field_separator, MenuObject< ConfigType, ParamType >::_menu_width, MenuObject< ConfigType, ParamType >::_vertical_rule, MenuObject< ConfigType, ParamType >::centerString(), and MenuObject< ConfigType, ParamType >::hRule().

Here is the call graph for this function:

◆ SetColumnLength()

void SetColumnLength ( unsigned int  colen)
inline

Definition at line 240 of file Menu.H.

References MenuObject< ConfigType, ParamType >::_column_length.

◆ SetExternalBorder()

void SetExternalBorder ( const std::string &  eb)
inline

Definition at line 216 of file Menu.H.

References MenuObject< ConfigType, ParamType >::_external_border.

◆ SetFieldSeparator()

void SetFieldSeparator ( const std::string &  sep)
inline

Definition at line 234 of file Menu.H.

References MenuObject< ConfigType, ParamType >::_field_separator.

◆ SetHeader()

void SetHeader ( const std::string &  hdr)
inline

Definition at line 222 of file Menu.H.

References MenuObject< ConfigType, ParamType >::_header.

◆ SetHRule()

void SetHRule ( const std::string &  hrule)
inline

Definition at line 228 of file Menu.H.

References MenuObject< ConfigType, ParamType >::_horizontal_rule.

◆ SetMenuWidth()

void SetMenuWidth ( unsigned int  wid)
inline

Definition at line 237 of file Menu.H.

References MenuObject< ConfigType, ParamType >::_menu_width.

◆ SetVRule()

void SetVRule ( const std::string &  vrule)
inline

Definition at line 231 of file Menu.H.

References MenuObject< ConfigType, ParamType >::_vertical_rule.

Member Data Documentation

◆ _column_length

int _column_length
private

Definition at line 250 of file Menu.H.

Referenced by MenuObject< ConfigType, ParamType >::menuString(), MenuObject< ConfigType, ParamType >::navigationString(), and MenuObject< ConfigType, ParamType >::SetColumnLength().

◆ _external_border

std::string _external_border
private

Definition at line 245 of file Menu.H.

Referenced by MenuObject< ConfigType, ParamType >::Border(), MenuObject< ConfigType, ParamType >::centerString(), MenuObject< ConfigType, ParamType >::hRule(), MenuObject< ConfigType, ParamType >::menuString(), MenuObject< ConfigType, ParamType >::navigationString(), and MenuObject< ConfigType, ParamType >::SetExternalBorder().

◆ _field_separator

std::string _field_separator
private

Definition at line 248 of file Menu.H.

Referenced by MenuObject< ConfigType, ParamType >::menuString(), MenuObject< ConfigType, ParamType >::navigationString(), and MenuObject< ConfigType, ParamType >::SetFieldSeparator().

◆ _header

std::string _header
private

Definition at line 242 of file Menu.H.

Referenced by MenuObject< ConfigType, ParamType >::Header(), MenuObject< ConfigType, ParamType >::menuString(), and MenuObject< ConfigType, ParamType >::SetHeader().

◆ _horizontal_rule

std::string _horizontal_rule
private

Definition at line 247 of file Menu.H.

Referenced by MenuObject< ConfigType, ParamType >::hRule(), and MenuObject< ConfigType, ParamType >::SetHRule().

◆ _last_section

std::string _last_section
private

Definition at line 251 of file Menu.H.

Referenced by MenuObject< ConfigType, ParamType >::LastSection(), and MenuObject< ConfigType, ParamType >::menuString().

◆ _menu_width

strsize _menu_width
private

Definition at line 249 of file Menu.H.

Referenced by MenuObject< ConfigType, ParamType >::centerString(), MenuObject< ConfigType, ParamType >::hRule(), MenuObject< ConfigType, ParamType >::menuString(), MenuObject< ConfigType, ParamType >::navigationString(), and MenuObject< ConfigType, ParamType >::SetMenuWidth().

◆ _next_section

std::string _next_section
private

Definition at line 252 of file Menu.H.

◆ _up_section

std::string _up_section
private

Definition at line 253 of file Menu.H.

◆ _vertical_rule

std::string _vertical_rule
private

Definition at line 246 of file Menu.H.

Referenced by MenuObject< ConfigType, ParamType >::menuString(), MenuObject< ConfigType, ParamType >::navigationString(), and MenuObject< ConfigType, ParamType >::SetVRule().

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