QuasarAppLib
helpdata.cpp File Reference
#include "helpdata.h"
#include <iostream>
#include <sys/ioctl.h>
#include <unistd.h>
Include dependency graph for helpdata.cpp:

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.
 

Macros

#define EXPANDER(COUNT, ITEM)   QString(COUNT, ITEM).toStdString()
 
#define SPACES(X)   EXPANDER(X, ' ')
 
#define SECTION_MARGIN   SPACES(SectionMargin)
 
#define WIDTH   ((MAX_LENGTH > 10)? MAX_LENGTH: width())
 

Functions

void QuasarAppUtils::Help::print (const QString &key, const QString &value, int keyLength)
 
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.
 
int QuasarAppUtils::Help::width ()
 width This method return current width of the cosole window.
 

Macro Definition Documentation

◆ EXPANDER

#define EXPANDER (   COUNT,
  ITEM 
)    QString(COUNT, ITEM).toStdString()

Definition at line 24 of file helpdata.cpp.

◆ SECTION_MARGIN

#define SECTION_MARGIN   SPACES(SectionMargin)

Definition at line 26 of file helpdata.cpp.

◆ SPACES

#define SPACES (   X)    EXPANDER(X, ' ')

Definition at line 25 of file helpdata.cpp.

◆ WIDTH

#define WIDTH   ((MAX_LENGTH > 10)? MAX_LENGTH: width())

Definition at line 27 of file helpdata.cpp.