help::topic Struct Reference

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

Collaboration diagram for help::topic:

Collaboration graph
[legend]

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 143 of file help.cpp.


Constructor & Destructor Documentation

help::topic::topic (  )  [inline]

Definition at line 145 of file help.cpp.

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

Definition at line 146 of file help.cpp.

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

Definition at line 148 of file help.cpp.

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

Definition at line 150 of file help.cpp.


Member Function Documentation

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

Two topics are equal if their IDs are equal.

Definition at line 1703 of file help.cpp.

References id.

bool help::topic::operator!= ( const topic t  )  const [inline]

Definition at line 154 of file help.cpp.

References operator==().

bool help::topic::operator< ( const topic t  )  const

Comparison on the ID.

Definition at line 1708 of file help.cpp.

References id.


Member Data Documentation

std::string help::topic::title

std::string help::topic::id

Definition at line 158 of file help.cpp.

Referenced by help::help_text_area::set_items(), and help::help_browser::show_topic().


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