Класс QCommandLineOption

Класс QCommandLineOption определяет возможный параметр командной строки. Подробнее...

• Список всех членов, включая унаследованные

Открытые функции

Подробное описание

Класс QCommandLineOption определяет возможный параметр командной строки.

Этот класс используется для описания параметра в командной строке. Он позволяет различными способами определять один и тот же параметр с несколькими возможными псевдонимами. Он также используется для описания того, как используется параметр - это может быть флаг (например, -v) или принимать значение (например, -o file).

Примеры:

QCommandLineOption verboseOption("verbose", "Verbose mode. Prints out more information.");
QCommandLineOption outputOption(QStringList() << "o" << "output", "Write generated data into <file>.", "file");

См. также QCommandLineParser.

Документация по функциям-членам

QCommandLineOption::QCommandLineOption(const QString &name)

Создаёт объект параметра командной строки с именем name.

Имя может быть коротким или длинным. Если длина имени равна одному символу, оно рассматривается как короткое имя. Имена параметров не должны быть пустыми, не должны начинаться с тире или косой черты, не должны содержать = и не могут повторяться.

См. также setDescription(), setValueName() и setDefaultValues().

QCommandLineOption::QCommandLineOption(const QStringList &names)

Создаёт объект параметра командной строки с именами names.

Этот перегруз позволяет задать несколько имён для параметра, например, o и output.

Имена могут быть короткими или длинными. Любое имя в списке, имеющее длину в один символ, является коротким именем. Имена параметров не должны быть пустыми, не должны начинаться с тире или косой черты, не должны содержать = и не могут повторяться.

См. также setDescription(), setValueName() и setDefaultValues().

QCommandLineOption::QCommandLineOption(const QString &name, const QString &description, const QString &valueName = QString(), const QString &defaultValue = QString())

Создаёт объект параметра командной строки с указанными аргументами.

Имя параметра устанавливается в name. Имя может быть коротким или длинным. Если длина имени равна одному символу, оно рассматривается как короткое имя. Имена параметров не должны быть пустыми, не должны начинаться с тире или косой черты, не должны содержать = и не могут повторяться.

Описание устанавливается в description. Принято добавлять "." в конце описания.

Кроме того, необходимо установить valueName, если параметр ожидает значение. Значение по умолчанию для параметра устанавливается в defaultValue.

В версиях Qt до 5.4 этот конструктор был explicit. В Qt 5.4 и более поздних версиях этого больше нет, и он может использоваться для унифицированной инициализации в стиле C++11:

QCommandLineParser parser;
parser.addOption({"verbose", "Verbose mode. Prints out more information."});

См. также setDescription(), setValueName() и setDefaultValues().

QCommandLineOption::QCommandLineOption(const QStringList &names, const QString &description, const QString &valueName = QString(), const QString &defaultValue = QString())

Создаёт объект параметра командной строки с указанными аргументами.

Этот перегруз позволяет задать несколько имён для параметра, например, o и output.

Имена параметра устанавливаются в names. Имена могут быть короткими или длинными. Любое имя в списке, имеющее длину в один символ, является коротким именем. Имена параметров не должны быть пустыми, не должны начинаться с тире или косой черты, не должны содержать = и не могут повторяться.

Описание устанавливается в description. Принято добавлять "." в конце описания.

Кроме того, необходимо установить valueName, если параметр ожидает значение. Значение по умолчанию для параметра устанавливается в defaultValue.

В версиях Qt до 5.4 этот конструктор был explicit. В Qt 5.4 и более поздних версиях этого больше нет, и он может использоваться для унифицированной инициализации в стиле C++11:

QCommandLineParser parser;
parser.addOption({{"o", "output"}, "Write generated data into <file>.", "file"});

См. также setDescription(), setValueName() и setDefaultValues().

QCommandLineOption::QCommandLineOption(const QCommandLineOption &other)

Создаёт объект QCommandLineOption, являющийся копией объекта QCommandLineOption other.

См. также operator=().

QCommandLineOption::~QCommandLineOption()

Удаляет объект параметра командной строки.

QStringList QCommandLineOption::defaultValues() const

Возвращает значения по умолчанию, заданные для данного параметра.

См. также setDefaultValues().

QString QCommandLineOption::description() const

Возвращает описание, заданное для данного параметра.

См. также setDescription().

bool QCommandLineOption::isHidden() const

Возвращает true, если этот параметр опушен из вывода справки, и false, если параметр отображается.

Эта функция была введена в Qt 5.6.

См. также setHidden().

QStringList QCommandLineOption::names() const

Возвращает имена, заданные для этого параметра.

void QCommandLineOption::setDefaultValue(const QString &defaultValue)

Устанавливает значение по умолчанию для этого параметра на defaultValue.

Значение по умолчанию используется, если пользователь приложения не указывает параметр в командной строке.

Если defaultValue пустое, параметр не имеет значения по умолчанию.

См. также defaultValues() и setDefaultValues().

void QCommandLineOption::setDefaultValues(const QStringList &defaultValues)

Устанавливает список значений по умолчанию для этого параметра на defaultValues.

Значения по умолчанию используются, если пользователь приложения не указывает параметр в командной строке.

См. также defaultValues() и setDefaultValue().

void QCommandLineOption::setDescription(const QString &description)

Устанавливает описание для этого параметра на description.

Обычно в конце описания добавляется точка «.».

Описание используется методом QCommandLineParser::showHelp().

См. также description().

void QCommandLineOption::setHidden(bool hide)

Устанавливает, скрывать ли этот параметр в выводе справки для пользователя.

Все параметры видимы по умолчанию. Установка hide в true для определенного параметра делает его внутренним, т.е. он не отображается в выводе справки.

Эта функция была введена в Qt 5.6.

См. также isHidden.

void QCommandLineOption::setValueName(const QString &valueName)

Устанавливает имя ожидаемого значения для документации на valueName.

Параметры без присвоенного значения ведут себя как булевы: пользователь указывает --option или нет.

Параметрам с присвоенным значением необходимо установить имя для ожидаемого значения в документации параметра в выводе справки. Параметр с именами o и output, и именем значения file будет отображаться как -o, --output <file>.

Вызовите QCommandLineParser::value(), если ожидается, что параметр будет присутствовать только один раз, и QCommandLineParser::values(), если ожидается, что этот параметр будет присутствовать несколько раз.

См. также valueName().

void QCommandLineOption::swap(QCommandLineOption &other)

Меняет местами параметр other с этим параметром. Эта операция очень быстрая и никогда не терпит неудачу.

QString QCommandLineOption::valueName() const

Возвращает имя ожидаемого значения.

Если пустое, параметр не принимает значения.

См. также setValueName().

QCommandLineOption &QCommandLineOption::operator=(const QCommandLineOption &other)

Создаёт копию объекта other и присваивает её этому объекту QCommandLineOption.

QCommandLineOption &QCommandLineOption::operator=(QCommandLineOption &&other)

Перемещает присваивание other этому экземпляру QCommandLineOption.

Эта функция была введена в Qt 5.2.