optiondata.h

Go to the documentation of this file.

/*
 * Copyright (C) 2021-2025 QuasarApp.
 * Distributed under the lgplv3 software license, see the accompanying
 * Everyone is permitted to copy and distribute verbatim copies
 * of this license document, but changing it is not allowed.
*/
 
 
#ifndef OPTIONDATA_H
#define OPTIONDATA_H
 
#include "quasarapp_global.h"
#include "helpdata.h"
 
namespace QuasarAppUtils{
 
class QUASARAPPSHARED_EXPORT OptionData
{
public:
 
    OptionData(const QStringList& names,
               const QString& arguments = "",
               const QString& description = "",
               const QString& example = "",
               const QString& depricatedMsg = "",
               bool removed = false);
 
    const QStringList &names() const;
 
    const QString &description() const;
 
    const QString &example() const;
 
    const QString &arguments() const;
 
    const QString &depricatedMsg() const;
 
    Help::Options toHelp() const;
 
    bool isValid() const;
 
    bool isRemoved() const;
 
    bool isDepricated() const;
 
protected:
    void setNames(const QStringList &newNames);
 
    void setDescription(const QString &newDescription);
 
    void setExample(const QString &newExample);
 
    void setArguments(const QString &newArguments);
 
    void setDepricatedMsg(const QString &newDepricatedMsg);
 
private:
    QStringList _name;
    QString _description;
    QString _example;
    QString _arguments;
    QString _depricatedMsg;
    bool _removed;
};
 
typedef QMultiHash<QString, OptionData> OptionsDataList;
}
#endif // OPTIONDATA_H