The Battle for Wesnoth  1.19.0-dev
Public Member Functions | Public Attributes | List of all members
help::help_menu::visible_item Struct Reference

Information about an item that is visible in the menu. More...

Public Member Functions

 visible_item (const section *_sec, int level)
 
 visible_item (const topic *_t, int level)
 
gui::indented_menu_item get_menu_item (const help_menu &parent) const
 
bool operator== (const visible_item &sec) const
 
bool operator== (const section &sec) const
 
bool operator== (const topic &t) const
 

Public Attributes

const topict
 
const sectionsec
 
int level
 Indentation level, always one more than the parent section. More...
 

Detailed Description

Information about an item that is visible in the menu.

Definition at line 53 of file help_menu.hpp.

Constructor & Destructor Documentation

◆ visible_item() [1/2]

help::help_menu::visible_item::visible_item ( const section _sec,
int  level 
)

Definition at line 180 of file help_menu.cpp.

◆ visible_item() [2/2]

help::help_menu::visible_item::visible_item ( const topic _t,
int  level 
)

Definition at line 183 of file help_menu.cpp.

Member Function Documentation

◆ get_menu_item()

gui::indented_menu_item help::help_menu::visible_item::get_menu_item ( const help_menu parent) const

◆ operator==() [1/3]

bool help::help_menu::visible_item::operator== ( const section sec) const

Definition at line 197 of file help_menu.cpp.

◆ operator==() [2/3]

bool help::help_menu::visible_item::operator== ( const topic t) const

Definition at line 202 of file help_menu.cpp.

References t.

◆ operator==() [3/3]

bool help::help_menu::visible_item::operator== ( const visible_item sec) const

Definition at line 207 of file help_menu.cpp.

References sec, t, and t.

Member Data Documentation

◆ level

int help::help_menu::visible_item::level

Indentation level, always one more than the parent section.

Definition at line 62 of file help_menu.hpp.

◆ sec

const section* help::help_menu::visible_item::sec

Definition at line 59 of file help_menu.hpp.

Referenced by operator==(), and help::help_menu::process().

◆ t

const topic* help::help_menu::visible_item::t

Definition at line 58 of file help_menu.hpp.

Referenced by operator==(), and help::help_menu::process().


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