QuasarAppLib 1.0.530.c9fba11
helpdata.h
Go to the documentation of this file.
1/*
2 * Copyright (C) 2018-2026 QuasarApp.
3 * Distributed under the lgplv3 software license, see the accompanying
4 * Everyone is permitted to copy and distribute verbatim copies
5 * of this license document, but changing it is not allowed.
6*/
7
8#ifndef HELPDATA_H
9#define HELPDATA_H
10
11#include <QMap>
12#include "quasarapp_global.h"
13
14namespace QuasarAppUtils{
15
19namespace Help {
32typedef QMultiMap<QString, QString> Options;
33
45typedef QMultiMap<QString, Options> Section;
46
51typedef Section Charters;
52
57int width();
58
63void QUASARAPPSHARED_EXPORT print(const Options& optionsList);
64
70void QUASARAPPSHARED_EXPORT print(const Section& help);
71
76void QUASARAPPSHARED_EXPORT setLineLength(int newLength);
77}
78}
79
80#endif // HELPDATA_H
QuasarAppUtils::Help
Help namespace contains functions for printing help in to console. All Print functions automatically ...
Definition helpdata.cpp:19
QuasarAppUtils::Help::Charters
Section Charters
Charters is wrapper of the Section type.
Definition helpdata.h:51
QuasarAppUtils::Help::setLineLength
void setLineLength(int newLength)
setLineLength sets new length of the help line (width of the console window). If you set this into -1...
Definition helpdata.cpp:87
QuasarAppUtils::Help::Options
QMultiMap< QString, QString > Options
Options this is list of key-descriptions pairs of help. The key is name of the available argument and...
Definition helpdata.h:32
QuasarAppUtils::Help::print
void print(const QString &key, const QString &value, int keyLength)
Definition helpdata.cpp:37
QuasarAppUtils::Help::Section
QMultiMap< QString, Options > Section
Section This is list of the help Sections. The one section it is Title of the section and Help::Optio...
Definition helpdata.h:45
QuasarAppUtils::Help::width
int width()
width This method return current width of the console window.
Definition helpdata.cpp:91
QuasarAppUtils
The QuasarAppUtils namespace contains the base functions for all applications of the QuasarApp group....
Definition crc32constexper.h:16
quasarapp_global.h
QUASARAPPSHARED_EXPORT
#define QUASARAPPSHARED_EXPORT
Definition quasarapp_global.h:11