QuasarAppLib
helpdata.h File Reference
#include <QMap>
#include "quasarapp_global.h"
Include dependency graph for helpdata.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces

namespace  QuasarAppUtils
 The QuasaraAppUtils class This lib include base functions for the all applications of QuasarApp group. All methods of the Quasar AppUtils is static.
 
namespace  QuasarAppUtils::Help
 Help namespace contains functions for printing help in to console. All Print fucntions automaticly calc width of the console and aligns the text to fit the window.
 

Typedefs

typedef QMultiMap< QString, QStringQuasarAppUtils::Help::Options
 Options this is list of key-descriptions pairs of help. The key is name of the available argument and description is description of the available argument.
 
typedef QMultiMap< QString, OptionsQuasarAppUtils::Help::Section
 Section This is list of the help Sections. The one section it is Title of the section and Help::Options list.
 
typedef Section QuasarAppUtils::Help::Charters
 Charters is wraper of the Section type.
 

Functions

int QuasarAppUtils::Help::width ()
 width This method return current width of the cosole window.
 
void QuasarAppUtils::Help::print (const Options &oprionsList)
 print This method print a one options list.
 
void QuasarAppUtils::Help::print (const Section &help)
 print This method print all sections of the help.
 
void QuasarAppUtils::Help::setLineLength (int newLength)
 setLineLength sets new length of the help line (width of the console window). If you set this into -1 then the window width will be selected automatically.