QCommandLineOption Class

Documentación de las funciones miembro

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

Construye 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 carácter de longitud, 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 = y no pueden repetirse.

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

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

Construye un objeto de opción de línea de comandos con los nombres names.

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

Los nombres pueden ser cortos o largos. Cualquier nombre de la lista que tenga un carácter de longitud es un nombre corto. Los nombres de las opciones no deben estar vacíos, no deben empezar por un guión o una barra oblicua, 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())

Construye un objeto de opción de línea de comandos con los argumentos dados.

El nombre de la opción se establece en name. El nombre puede ser corto o largo. Si el nombre tiene un carácter de longitud, 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 oblicua, no deben contener = 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 valueName si la opción espera un valor. El valor por defecto de la opción es defaultValue.

En las versiones de Qt anteriores a la 5.4, este constructor era explicit. En Qt 5.4 y posteriores, 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())

Construye un objeto de opción de línea de comandos con los argumentos dados.

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

Los nombres de la opción se establecen en names. Los nombres pueden ser cortos o largos. Cualquier nombre de la lista que tenga un carácter de longitud es un nombre corto. Los nombres de las opciones no deben estar vacíos, no deben empezar por un guión o una barra oblicua, no deben contener = 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 valueName si la opción espera un valor. El valor por defecto de la opción es defaultValue.

En las versiones de Qt anteriores a la 5.4, este constructor era explicit. En Qt 5.4 y 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)

Construye un objeto QCommandLineOption que es una copia del objeto QCommandLineOption other.

Véase también operator=().

[noexcept] QCommandLineOption::~QCommandLineOption()

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

QStringList QCommandLineOption::defaultValues() const

Devuelve los valores por defecto 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 banderas que afectan a esta opción de 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 utilizado para 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 por defecto utilizados 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)

Establezca el conjunto de banderas que afectan a esta opción de 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 valor asignado tienen un comportamiento booleano: o el usuario especifica -option o no lo hace.

Las opciones con un valor asignado necesitan establecer un nombre para el valor esperado, para la documentación de la opción en la salida de ayuda. Una opción con nombres o y output, y un nombre de valor file aparecerá como -o, --output <file>.

Llame a QCommandLineParser::value() si espera que la opción esté presente sólo una vez, y a QCommandLineParser::values() si espera que esa opción esté presente varias veces.

Véase también valueName().

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

Cambia esta opción por other. Esta operación es muy rápida y nunca falla.

QString QCommandLineOption::valueName() const

Devuelve el nombre del valor esperado.

Si está vacía, la opción no toma ningún valor.

Véase también setValueName().

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

Mover-asigna other a esta instancia QCommandLineOption.

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

Hace una copia del objeto other y lo asigna a este objeto QCommandLineOption.