help::section Struct Reference

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

List of all members.

Public Member Functions

 section ()
 section (const section &)
sectionoperator= (const section &)
 ~section ()
bool operator== (const section &) const
 Two sections are equal if their IDs are equal.
bool operator< (const section &) const
 Comparison on the ID.
void add_section (const section &s)
 Allocate memory for and add the section.
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 164 of file help.cpp.


Constructor & Destructor Documentation

help::section::section (  )  [inline]

Definition at line 165 of file help.cpp.

Referenced by add_section().

help::section::section ( const section sec  ) 

Definition at line 1718 of file help.cpp.

References sections.

help::section::~section (  ) 

Definition at line 1713 of file help.cpp.

References sections.


Member Function Documentation

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

Definition at line 1725 of file help.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 1737 of file help.cpp.

References id.

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

Comparison on the ID.

Definition at line 1742 of file help.cpp.

References id.

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

Allocate memory for and add the section.

Definition at line 1747 of file help.cpp.

References section(), and sections.

Referenced by help::generate_races_sections(), and help::parse_config_internal().

void help::section::clear ( void   ) 

Definition at line 1752 of file help.cpp.

References sections, and topics.

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


Member Data Documentation

std::string help::section::title

std::string help::section::id

Definition at line 181 of file help.cpp.

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


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

Generated by doxygen 1.5.5 on 23 May 2008 for The Battle for Wesnoth
Gna! | Forum | Wiki | CIA | devdocs