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

#include <help_impl.hpp>

Public Member Functions
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	add_section (section &&s)

void	clear ()

Public Attributes
std::string	title

std::string	id

topic_list	topics

section_list	sections

Detailed Description

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

Definition at line 110 of file help_impl.hpp.

Member Function Documentation

◆ add_section() [1/2]

void help::section::add_section ( const section & s )

Allocate memory for and add the section.

Definition at line 1168 of file help_impl.cpp.

References s, 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().

◆ add_section() [2/2]

void help::section::add_section ( section && s )

Definition at line 1173 of file help_impl.cpp.

References s, and sections.

◆ clear()

void help::section::clear ( )

Definition at line 1178 of file help_impl.cpp.

References sections, and topics.

◆ operator<()

bool help::section::operator< ( const section & sec ) const

Comparison on the ID.

Definition at line 1163 of file help_impl.cpp.

References id.

◆ operator==()

bool help::section::operator== ( const section & sec ) const

Two sections are equal if their IDs are equal.

Definition at line 1158 of file help_impl.cpp.

References id.

Member Data Documentation

◆ id

std::string help::section::id

Definition at line 121 of file help_impl.hpp.

Referenced by gui2::dialogs::help_browser::add_topics_for_section(), help::generate_terrain_sections(), help::generate_unit_sections(), operator<(), operator==(), and help::parse_config_internal().

◆ sections

section_list help::section::sections

Definition at line 123 of file help_impl.hpp.

Referenced by add_section(), gui2::dialogs::help_browser::add_topics_for_section(), clear(), help::find_section(), help::find_topic(), help::generate_contents_links(), and help::parse_config_internal().

◆ title

std::string help::section::title

Definition at line 121 of file help_impl.hpp.

Referenced by gui2::dialogs::help_browser::add_topics_for_section(), help::generate_terrain_sections(), help::generate_unit_sections(), help::section_less::operator()(), and help::parse_config_internal().

◆ topics

topic_list help::section::topics

Definition at line 122 of file help_impl.hpp.

Referenced by gui2::dialogs::help_browser::add_topics_for_section(), clear(), help::find_topic(), help::generate_contents_links(), help::generate_terrain_sections(), help::generate_unit_sections(), and help::parse_config_internal().

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

help/help_impl.hpp
help/help_impl.cpp

Public Member Functions

Public Attributes