help::section Struct Reference

A section contains topics and sections along with title and ID. More...

#include <help_impl.hpp>

Public Member Functions
	section ()
	section (const section &)
section &	operator= (const section &)
	~section ()
bool	operator== (const section &) const
	Two sections are equal if their IDs are equal. More...
bool	operator< (const section &) const
	Comparison on the ID. More...
void	add_section (const section &s)
	Allocate memory for and add the section. More...
void	clear ()

Public Attributes
std::string	title
std::string	id
topic_list	topics
section_list	sections
int	level

Detailed Description

A section contains topics and sections along with title and ID.

Definition at line 143 of file help_impl.hpp.

Constructor & Destructor Documentation

help::section::section ( )

inline

Definition at line 144 of file help_impl.hpp.

Referenced by add_section().

help::section::section

(

const section &

sec

)

Definition at line 1002 of file help_impl.cpp.

References sections.

help::section::~section

(

)

Definition at line 997 of file help_impl.cpp.

References sections.

Member Function Documentation

void help::section::add_section

(

const section &

s

)

Allocate memory for and add the section.

Definition at line 1035 of file help_impl.cpp.

References section(), and sections.

Referenced by help::generate_era_sections(), help::generate_races_sections(), help::generate_terrain_sections(), help::generate_unit_sections(), and help::parse_config_internal().

void help::section::clear

(

)

Definition at line 1040 of file help_impl.cpp.

References sections, and topics.

Referenced by help::generate_contents(), and help::help_manager::~help_manager().

bool help::section::operator<

(

const section &

sec

)

const

Comparison on the ID.

Definition at line 1030 of file help_impl.cpp.

References id.

section & help::section::operator=

(

const section &

sec

)

Definition at line 1013 of file help_impl.cpp.

References id, level, sections, title, and topics.

bool help::section::operator==

(

const section &

sec

)

const

Two sections are equal if their IDs are equal.

Definition at line 1025 of file help_impl.cpp.

References id.

Member Data Documentation

std::string help::section::id

Definition at line 165 of file help_impl.hpp.

Referenced by help::help_menu::expand(), help::generate_terrain_sections(), help::generate_unit_sections(), help::has_id::operator()(), operator<(), operator=(), operator==(), help::parse_config_internal(), and help::help_menu::process().

int help::section::level

Definition at line 168 of file help_impl.hpp.

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

section_list help::section::sections

Definition at line 167 of file help_impl.hpp.

Referenced by add_section(), clear(), help::find_section(), help::find_topic(), help::generate_contents_links(), operator=(), help::parse_config_internal(), section(), help::help_menu::select_topic_internal(), help::help_menu::update_visible_items(), and ~section().

std::string help::section::title

Definition at line 165 of file help_impl.hpp.

Referenced by help::generate_terrain_sections(), help::generate_unit_sections(), help::help_menu::get_string_to_show(), help::section_less::operator()(), operator=(), and help::parse_config_internal().

topic_list help::section::topics

Definition at line 166 of file help_impl.hpp.

Referenced by clear(), help::find_topic(), help::generate_terrain_sections(), help::generate_unit_sections(), operator=(), help::parse_config_internal(), help::help_menu::select_topic_internal(), and help::help_menu::update_visible_items().

---

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

• help/help_impl.hpp
• help/help_impl.cpp