Класс 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::FlagФлаги QCommandLineOption::Flags

Тип Flags является псевдонимом для QFlags<Flag>. Он хранит логическое ИЛИ комбинацию значений Flag.

См. также QCommandLineOption::setFlags() и QCommandLineOption::flags().

Документация по документации функций

QCommandLineOption::QCommandLineOption(const QCommandLineOption &other)

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

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

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 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)

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

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

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

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

QCommandLineOption::QCommandLineOption(const QString &name)

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

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

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

[since 5.2] QCommandLineOption &QCommandLineOption::operator=(QCommandLineOption &&other)

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

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

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

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

QCommandLineOption::~QCommandLineOption()

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

QStringList QCommandLineOption::defaultValues() const

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

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

QString QCommandLineOption::description() const

Возвращает описание, установленное для этой опции.

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

[since 5.8] QCommandLineOption::Flags QCommandLineOption::flags() const

Возвращает набор флагов, которые влияют на эту опцию командной строки.

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

См. также setFlags() и QCommandLineOption::Flags.

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().

[since 5.8] void QCommandLineOption::setFlags(QCommandLineOption::Flags flags)

Устанавливает набор флагов, которые влияют на эту опцию командной строки, на flags.

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

См. также flags() и QCommandLineOption::Flags.

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().