The Battle for Wesnoth  1.15.2+dev
Public Member Functions | Public Attributes | List of all members
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 107 of file help_impl.hpp.

Constructor & Destructor Documentation

◆ topic() [1/4]

help::topic::topic ( )
inline

Definition at line 109 of file help_impl.hpp.

◆ topic() [2/4]

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

Definition at line 116 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 123 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 125 of file help_impl.hpp.

References operator==().

Member Function Documentation

◆ operator!=()

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

Definition at line 129 of file help_impl.hpp.

References operator<(), and operator==().

◆ operator<()

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

Comparison on the ID.

Definition at line 1087 of file help_impl.cpp.

References id.

◆ operator==()

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

Two topics are equal if their IDs are equal.

Definition at line 1082 of file help_impl.cpp.

References id.

Member Data Documentation

◆ id

std::string help::topic::id

◆ text

topic_text help::topic::text
mutable

◆ title

std::string help::topic::title

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