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

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

#include <help_impl.hpp>

Public Member Functions

 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
 

Detailed Description

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

Definition at line 146 of file help_impl.hpp.

Constructor & Destructor Documentation

◆ section()

help::section::section ( )
inline

Definition at line 147 of file help_impl.hpp.

Member Function Documentation

◆ add_section()

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

Allocate memory for and add the section.

Definition at line 1279 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().

◆ clear()

void help::section::clear ( )

Definition at line 1284 of file help_impl.cpp.

References sections, and topics.

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

◆ operator<()

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

Comparison on the ID.

Definition at line 1274 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 1269 of file help_impl.cpp.

References id.

Member Data Documentation

◆ id

std::string help::section::id

◆ sections

section_list help::section::sections

◆ title

std::string help::section::title

◆ topics

topic_list help::section::topics

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