En esta página

QCommandLineOption Class

La clase QCommandLineOption define una posible opción de línea de comandos. Más información...

Encabezado: #include <QCommandLineOption>
CMake: find_package(Qt6 REQUIRED COMPONENTS Core)
target_link_libraries(mytarget PRIVATE Qt6::Core)
qmake: QT += core

Tipos públicos

enum Flag { HiddenFromHelp, ShortOptionStyle, IgnoreOptionsAfter }
flags Flags

Funciones públicas

QCommandLineOption(const QString &name)
QCommandLineOption(const QStringList &names)
QCommandLineOption(const QString &name, const QString &description, const QString &valueName = QString(), const QString &defaultValue = QString())
QCommandLineOption(const QStringList &names, const QString &description, const QString &valueName = QString(), const QString &defaultValue = QString())
QCommandLineOption(const QCommandLineOption &other)
~QCommandLineOption()
QStringList defaultValues() const
QString description() const
QCommandLineOption::Flags flags() const
QStringList names() const
void setDefaultValue(const QString &defaultValue)
void setDefaultValues(const QStringList &defaultValues)
void setDescription(const QString &description)
void setFlags(QCommandLineOption::Flags flags)
void setValueName(const QString &valueName)
void swap(QCommandLineOption &other)
QString valueName() const
QCommandLineOption &operator=(QCommandLineOption &&other)
QCommandLineOption &operator=(const QCommandLineOption &other)

Descripción detallada

Esta clase se utiliza para describir una opción en la línea de comandos. Permite definir la misma opción de diferentes maneras, con múltiples alias posibles. También se utiliza para describir cómo se utiliza la opción: puede ser un indicador (por ejemplo, -v) o tomar un valor (por ejemplo, -o file).

Ejemplos:

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

Véase también QCommandLineParser.

Documentación sobre tipos de miembros

enum QCommandLineOption::Flag
flags QCommandLineOption::Flags

ConstanteValorDescripción
QCommandLineOption::HiddenFromHelp0x1Oculta esta opción en la salida de ayuda visible para el usuario. Todas las opciones están visibles por defecto. Al establecer este indicador para una opción concreta, esta pasa a ser interna, es decir, no aparece en la salida de ayuda.
QCommandLineOption::ShortOptionStyle0x2La opción siempre se interpretará como una opción corta, independientemente de lo establecido mediante ` QCommandLineParser::setSingleDashWordOptionMode`. Esto permite que indicadores como ` -DDEFINE=VALUE ` o ` -I/include/path ` se interpreten como indicadores cortos incluso cuando el analizador se encuentre en modo ` QCommandLineParser::ParseAsLongOptions `.
QCommandLineOption::IgnoreOptionsAfter0x4[desde la versión 6.9] No se analizarán más opciones a partir de esta. Resulta útil en los casos en los que sea necesario enviar argumentos de línea de comandos adicionales a una aplicación secundaria. Si se proporciona un valor para esta opción, se ignorará.

El tipo Flags es un typedef para QFlags<Flag>. Almacena una combinación OR de valores de Flag.

Véase también QCommandLineOption::setFlags() y QCommandLineOption::flags().

Documentación de las funciones miembro

[explicit] QCommandLineOption::QCommandLineOption(const QString &name)

Crea un objeto de opción de línea de comandos con el nombre « name ».

El nombre puede ser corto o largo. Si el nombre tiene un solo carácter, se considera un nombre corto. Los nombres de las opciones no deben estar vacíos, no deben comenzar con un guión o una barra, no deben contener un « = » y no pueden repetirse.

Véanse también setDescription(), setValueName() y setDefaultValues().

[explicit] QCommandLineOption::QCommandLineOption(const QStringList &names)

Crea un objeto de opción de línea de comandos con los nombres « names ».

Esta sobrecarga permite establecer varios nombres para la opción, por ejemplo, o y output.

Los nombres pueden ser cortos o largos. Cualquier nombre de la lista que tenga una longitud de un carácter es un nombre corto. Los nombres de las opciones no deben estar vacíos, no deben comenzar con un guión ni con una barra, no deben contener « = » y no pueden repetirse.

Véase también setDescription(), setValueName() y setDefaultValues().

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

Crea un objeto de opción de línea de comandos con los argumentos proporcionados.

El nombre de la opción se establece en name. El nombre puede ser corto o largo. Si el nombre tiene un solo carácter, se considera un nombre corto. Los nombres de las opciones no deben estar vacíos, no deben empezar por un guión o una barra, no deben contener un = y no pueden repetirse.

La descripción se establece en description. Es habitual añadir un «.» al final de la descripción.

Además, es necesario establecer el valueName si la opción espera un valor. El valor por defecto de la opción se establece en defaultValue.

En las versiones de Qt anteriores a la 5.4, este constructor era explicit. A partir de Qt 5.4, ya no lo es y puede utilizarse para una inicialización uniforme:

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

Véase también setDescription(), setValueName() y setDefaultValues().

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

Crea un objeto de opción de línea de comandos con los argumentos proporcionados.

Esta sobrecarga permite establecer varios nombres para la opción, por ejemplo, o y output.

Los nombres de las opciones se establecen como names. Los nombres pueden ser cortos o largos. Cualquier nombre de la lista que tenga una longitud de un carácter es un nombre corto. Los nombres de las opciones no deben estar vacíos, no deben comenzar con un guión o una barra, no deben contener un = y no pueden repetirse.

La descripción se establece en description. Es habitual añadir un «.» al final de la descripción.

Además, es necesario establecer el valueName si la opción espera un valor. El valor por defecto de la opción se establece en defaultValue.

En las versiones de Qt anteriores a la 5.4, este constructor era explicit. En Qt 5.4 y versiones posteriores, ya no lo es y puede utilizarse para una inicialización uniforme:

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

Véase también setDescription(), setValueName() y setDefaultValues().

QCommandLineOption::QCommandLineOption(const QCommandLineOption &other)

Crea un objeto `QCommandLineOption` que es una copia del objeto `QCommandLineOption` other.

Véase también operator=().

[noexcept] QCommandLineOption::~QCommandLineOption()

Elimina el objeto de opción de línea de comandos.

QStringList QCommandLineOption::defaultValues() const

Devuelve los valores predeterminados establecidos para esta opción.

Véase también setDefaultValues().

QString QCommandLineOption::description() const

Devuelve la descripción establecida para esta opción.

Véase también setDescription().

QCommandLineOption::Flags QCommandLineOption::flags() const

Devuelve un conjunto de indicadores que afectan a esta opción de la línea de comandos.

Véase también setFlags() y QCommandLineOption::Flags.

QStringList QCommandLineOption::names() const

Devuelve los nombres establecidos para esta opción.

void QCommandLineOption::setDefaultValue(const QString &defaultValue)

Establece el valor por defecto de esta opción en « defaultValue ».

El valor por defecto se utiliza si el usuario de la aplicación no especifica la opción en la línea de comandos.

Si ` defaultValue ` está vacío, la opción no tiene valores por defecto.

Véase también defaultValues() y setDefaultValues().

void QCommandLineOption::setDefaultValues(const QStringList &defaultValues)

Establece la lista de valores predeterminados que se utilizan para esta opción en defaultValues.

Los valores por defecto se utilizan si el usuario de la aplicación no especifica la opción en la línea de comandos.

Véase también defaultValues() y setDefaultValue().

void QCommandLineOption::setDescription(const QString &description)

Establece la descripción utilizada para esta opción en « description ».

Es habitual añadir un «.» al final de la descripción.

La descripción es utilizada por QCommandLineParser::showHelp().

Véase también description().

void QCommandLineOption::setFlags(QCommandLineOption::Flags flags)

Establece el conjunto de indicadores que afectan a esta opción de la línea de comandos en flags.

Véase también flags() y QCommandLineOption::Flags.

void QCommandLineOption::setValueName(const QString &valueName)

Establece el nombre del valor esperado, para la documentación, en « valueName ».

Las opciones sin un valor asignado tienen un comportamiento similar al de los valores booleanos: o bien el usuario especifica la opción, o bien no lo hace.

Las opciones a las que se les ha asignado un valor deben establecer un nombre para el valor esperado, con fines de documentación de la opción en la salida de la ayuda. Una opción con los nombres o y output, y un nombre de valor file, aparecerá como -o, --output <file>.

Llama a QCommandLineParser::value() si esperas que la opción esté presente solo una vez, y a QCommandLineParser::values() si esperas que esa opción esté presente varias veces.

Véase también valueName().

[noexcept] void QCommandLineOption::swap(QCommandLineOption &other)

Intercambia esta opción con « other ». Esta operación es muy rápida y nunca falla.

QString QCommandLineOption::valueName() const

Devuelve el nombre del valor esperado.

Si está vacío, la opción no admite ningún valor.

Véase también setValueName().

[noexcept] QCommandLineOption &QCommandLineOption::operator=(QCommandLineOption &&other)

Asigna « other » a esta instancia de « QCommandLineOption ». »

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

Crea una copia del objeto « other » y la asigna a este objeto « QCommandLineOption ».

© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.