help::topic Struct Reference

A topic contains a title, an id and some text. More...

#include <help_impl.hpp>

Public Member Functions
	topic ()
	topic (const std::string &_title, const std::string &_id)
	topic (const std::string &_title, const std::string &_id, const std::string &_text)
	topic (const std::string &_title, const std::string &_id, topic_generator *g)
bool	operator== (const topic &) const
	Two topics are equal if their IDs are equal. More...
bool	operator!= (const topic &t) const
bool	operator< (const topic &) const
	Comparison on the ID. More...

Public Attributes
std::string	title
std::string	id
topic_text	text

Detailed Description

A topic contains a title, an id and some text.

Definition at line 111 of file help_impl.hpp.

Constructor & Destructor Documentation

help::topic::topic ( )

inline

Definition at line 113 of file help_impl.hpp.

help::topic::topic ( const std::string &  _title, const std::string &  _id  )

inline

Definition at line 120 of file help_impl.hpp.

help::topic::topic ( const std::string &  _title, const std::string &  _id, const std::string &  _text  )

inline

Definition at line 127 of file help_impl.hpp.

help::topic::topic ( const std::string &  _title, const std::string &  _id, topic_generator *  g  )

inline

Definition at line 129 of file help_impl.hpp.

Member Function Documentation

bool help::topic::operator!= ( const topic &  t ) const

inline

Definition at line 133 of file help_impl.hpp.

References operator==().

bool help::topic::operator<

(

const topic &

t

)

const

Comparison on the ID.

Definition at line 992 of file help_impl.cpp.

References id.

bool help::topic::operator==

(

const topic &

t

)

const

Two topics are equal if their IDs are equal.

Definition at line 987 of file help_impl.cpp.

References id.

Referenced by operator!=().

Member Data Documentation

std::string help::topic::id

Definition at line 136 of file help_impl.hpp.

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

topic_text help::topic::text

mutable

Definition at line 137 of file help_impl.hpp.

Referenced by help::generate_terrain_sections(), help::generate_unit_sections(), help::generate_unit_topics(), and help::help_text_area::set_items().

std::string help::topic::title

Definition at line 136 of file help_impl.hpp.

Referenced by help::generate_terrain_sections(), help::help_menu::get_string_to_show(), help::title_less::operator()(), and help::help_text_area::set_items().

---

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

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