Класс QCommandLineOption

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

Этот класс был представлен в Qt 5.2.

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

Открытые типы

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

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

Этот класс используется для описания параметра в командной строке. Он позволяет различными способами определять один и тот же параметр с несколькими возможными псевдонимами. Он также используется для описания того, как используется параметр — это может быть флаг (например, -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().

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

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

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