help::topic_text Class Reference

The text displayed in a topic. More...

#include <help_impl.hpp>

Public Member Functions
	topic_text ()=default
	~topic_text ()=default
	topic_text (const std::string &t)
	topic_text (std::shared_ptr< topic_generator > g)
	topic_text (const topic_text &t)=default
	topic_text (topic_text &&t)=default
topic_text &	operator= (topic_text &&t)=default
topic_text &	operator= (const topic_text &t)=default
topic_text &	operator= (std::shared_ptr< topic_generator > g)
const config &	parsed_text () const

Private Attributes
config	parsed_text_
std::shared_ptr< topic_generator >	generator_

Detailed Description

The text displayed in a topic.

It is generated on the fly with the information contained in generator_

Definition at line 84 of file help_impl.hpp.

Constructor & Destructor Documentation

topic_text() [1/5]

help::topic_text::topic_text ( )

default

~topic_text()

help::topic_text::~topic_text ( )

default

topic_text() [2/5]

help::topic_text::topic_text ( const std::string &  t )

inline

Definition at line 92 of file help_impl.hpp.

topic_text() [3/5]

help::topic_text::topic_text ( std::shared_ptr< topic_generator >  g )

inlineexplicit

Definition at line 98 of file help_impl.hpp.

topic_text() [4/5]

help::topic_text::topic_text ( const topic_text &  t )

default

topic_text() [5/5]

help::topic_text::topic_text ( topic_text &&  t )

default

Member Function Documentation

operator=() [1/3]

topic_text& help::topic_text::operator= ( const topic_text &  t )

default

operator=() [2/3]

topic_text & help::topic_text::operator=

(

std::shared_ptr< topic_generator >

g

)

Definition at line 374 of file help_impl.cpp.

References g, and generator_.

operator=() [3/3]

topic_text& help::topic_text::operator= ( topic_text &&  t )

default

parsed_text()

const config & help::topic_text::parsed_text

(

)

const

Definition at line 380 of file help_impl.cpp.

References generator_, markup::parse_text(), and parsed_text_.

Referenced by gui2::dialogs::help_browser::show_topic().

Member Data Documentation

generator_

std::shared_ptr<topic_generator> help::topic_text::generator_

mutableprivate

Definition at line 87 of file help_impl.hpp.

Referenced by operator=(), and parsed_text().

parsed_text_

config help::topic_text::parsed_text_

mutableprivate

Definition at line 86 of file help_impl.hpp.

Referenced by parsed_text().

---

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

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