help::topic_text Class Reference

The text displayed in a topic. More...

#include <help_impl.hpp>

Public Member Functions
	topic_text (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 75 of file help_impl.hpp.

Constructor & Destructor Documentation

topic_text()

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

inlineexplicit

Definition at line 80 of file help_impl.hpp.

Member Function Documentation

parsed_text()

const config & help::topic_text::parsed_text

(

)

const

Definition at line 280 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 78 of file help_impl.hpp.

Referenced by parsed_text().

parsed_text_

config help::topic_text::parsed_text_

mutableprivate

Definition at line 77 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