AppHelpTextFormatter Class Reference

Formats help text for display on the screen. More...

#include <App.h>

Public Member Functions
	AppHelpTextFormatter (int displayWidth=75)
	Constructs an AppHelpTextFormatter object. More...
virtual	~AppHelpTextFormatter ()
	Destroys an AppHelpTextFormatter object.
virtual void	addPreOptionText (const std::string &text)
	Adds text that gets displayed before the list of options. More...
virtual void	addOptionText (const std::string &option, const std::string &text)
	Adds an option and its help text to the list of options. More...
virtual void	addPostOptionText (const std::string &text)
	Adds text that gets displayed after the list of options. More...
virtual std::string	getFormattedText ()
	Gets the formatted help text. More...

Detailed Description

Formats help text for display on the screen.

Definition at line 162 of file App.h.

Constructor & Destructor Documentation

AppHelpTextFormatter()

AppHelpTextFormatter

(

int

displayWidth = 75

)

Constructs an AppHelpTextFormatter object.

Parameters

displayWidth

The width of the area in which to format the text, in characters.

Definition at line 94 of file App.cpp.

Member Function Documentation

addOptionText()

void addOptionText ( const std::string &  option, const std::string &  text  )

virtual

Adds an option and its help text to the list of options.

If addOptionText() is called multiple times, the formatter will add the option and its help text to the list, and display the text in the order in which it is added.

Parameters

option	The option. This text should describe any supported forms (short and/or long), as well as any arguments required by the option.
text	The help text for the option. This text may be divided into separate lines via newline ( ) characters.

Definition at line 110 of file App.cpp.

addPostOptionText()

void addPostOptionText ( const std::string &  text )

virtual

Adds text that gets displayed after the list of options.

If addPreOptionText() is called multiple times, the formatter will add the text to an internal store, and display the text in the order in which it is added.

Parameters

text	The text to add. This text may be divided into separate lines via newline ( ) characters.

Definition at line 122 of file App.cpp.

addPreOptionText()

void addPreOptionText ( const std::string &  text )

virtual

Adds text that gets displayed before the list of options.

If addPreOptionText() is called multiple times, the formatter will add the text to an internal store, and display the text in the order in which it is added.

Parameters

text	The text to add. This text may be divided into separate lines via newline ( ) characters.

Definition at line 104 of file App.cpp.

getFormattedText()

std::string getFormattedText ( )

virtual

Gets the formatted help text.

Returns

A string containing the formatted help text.

Definition at line 128 of file App.cpp.

---

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

• /home/abuild/rpmbuild/BUILD/libcyberradio-24.10.14/libcyberradio/include/LibCyberRadio/Common/App.h
• /home/abuild/rpmbuild/BUILD/libcyberradio-24.10.14/libcyberradio/libcyberradio/Common/App.cpp