help::topic Struct Reference

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

Collaboration diagram for help::topic:

List of all members.

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.
bool	operator!= (const topic &t) const
bool	operator< (const topic &) const
	Comparison on the ID.
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 150 of file help.cpp.

---

Constructor & Destructor Documentation

help::topic::topic

(

)

[inline]

Definition at line 152 of file help.cpp.

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

Definition at line 159 of file help.cpp.

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

Definition at line 166 of file help.cpp.

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

Definition at line 168 of file help.cpp.

---

Member Function Documentation

bool help::topic::operator!=

(

const topic &

t

)

const [inline]

Definition at line 172 of file help.cpp.

References operator==().

Here is the call graph for this function:

bool help::topic::operator<

(

const topic &

t

)

const

Comparison on the ID.

Definition at line 1895 of file help.cpp.

References id.

bool help::topic::operator==

(

const topic &

t

)

const

Two topics are equal if their IDs are equal.

Definition at line 1890 of file help.cpp.

References id.

Referenced by operator!=().

Here is the caller graph for this function:

---

Member Data Documentation

std::string help::topic::id

Definition at line 175 of file help.cpp.

Referenced by 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 176 of file help.cpp.

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

std::string help::topic::title

Definition at line 175 of file help.cpp.

Referenced by 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 file:

• help.cpp