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, std::shared_ptr< 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 114 of file help_impl.hpp.

Constructor & Destructor Documentation

topic() [1/4]

help::topic::topic ( )

inline

Definition at line 116 of file help_impl.hpp.

topic() [2/4]

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

inline

Definition at line 123 of file help_impl.hpp.

topic() [3/4]

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

inline

Definition at line 130 of file help_impl.hpp.

topic() [4/4]

help::topic::topic ( const std::string &  _title, const std::string &  _id, std::shared_ptr< topic_generator >  g  )

inline

Definition at line 132 of file help_impl.hpp.

Member Function Documentation

operator!=()

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

inline

Definition at line 136 of file help_impl.hpp.

References operator==(), and t.

operator<()

bool help::topic::operator<

(

const topic &

t

)

const

Comparison on the ID.

Definition at line 1269 of file help_impl.cpp.

References t.

operator==()

bool help::topic::operator==

(

const topic &

t

)

const

Two topics are equal if their IDs are equal.

Definition at line 1264 of file help_impl.cpp.

References id, and t.

Referenced by operator!=().

Member Data Documentation

id

std::string help::topic::id

Definition at line 139 of file help_impl.hpp.

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

text

topic_text help::topic::text

mutable

Definition at line 140 of file help_impl.hpp.

Referenced by help::generate_terrain_sections(), help::generate_unit_sections(), help::generate_unit_topics(), and gui2::rich_label::set_topic().

title

std::string help::topic::title

Definition at line 139 of file help_impl.hpp.

Referenced by gui2::dialogs::help_browser::add_topics_for_section(), help::generate_terrain_sections(), help::title_less::operator()(), and gui2::dialogs::help_browser::show_topic().

---

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

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