QCommandLineOption¶

The QCommandLineOption class defines a possible command-line option. More…

New in version 5.2.

Synopsis¶

Functions¶

def defaultValues ()
def description ()
def flags ()
def names ()
def setDefaultValue (defaultValue)
def setDefaultValues (defaultValues)
def setDescription (description)
def setFlags (aflags)
def setValueName (name)
def swap (other)
def valueName ()

Detailed Description¶

This class is used to describe an option on the command line. It allows different ways of defining the same option with multiple aliases possible. It is also used to describe how the option is used - it may be a flag (e.g. -v) or take a value (e.g. -o file).

Examples:

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

See also

QCommandLineParser

class PySide6.QtCore.QCommandLineOption(other)¶

PySide6.QtCore.QCommandLineOption(name)

PySide6.QtCore.QCommandLineOption(name, description[, valueName=””[, defaultValue=””]])

PySide6.QtCore.QCommandLineOption(names)

PySide6.QtCore.QCommandLineOption(names, description[, valueName=””[, defaultValue=””]])

Parameters

other – PySide6.QtCore.QCommandLineOption
valueName – str
defaultValue – str
names – list of strings
name – str
description – str

Constructs a QCommandLineOption object that is a copy of the QCommandLineOption object other.

See also

operator=()

Constructs a command line option object with the name name.

The name can be either short or long. If the name is one character in length, it is considered a short name. Option names must not be empty, must not start with a dash or a slash character, must not contain a = and cannot be repeated.

See also

setDescription() setValueName() setDefaultValues()

Constructs a command line option object with the given arguments.

The name of the option is set to name. The name can be either short or long. If the name is one character in length, it is considered a short name. Option names must not be empty, must not start with a dash or a slash character, must not contain a = and cannot be repeated.

The description is set to description. It is customary to add a “.” at the end of the description.

In addition, the valueName needs to be set if the option expects a value. The default value for the option is set to defaultValue.

In Qt versions before 5.4, this constructor was explicit. In Qt 5.4 and later, it no longer is and can be used for C++11-style uniform initialization:

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

setDescription() setValueName() setDefaultValues()

Constructs a command line option object with the names names.

This overload allows to set multiple names for the option, for instance o and output.

The names can be either short or long. Any name in the list that is one character in length is a short name. Option names must not be empty, must not start with a dash or a slash character, must not contain a = and cannot be repeated.

See also

setDescription() setValueName() setDefaultValues()

Constructs a command line option object with the given arguments.

This overload allows to set multiple names for the option, for instance o and output.

The names of the option are set to names. The names can be either short or long. Any name in the list that is one character in length is a short name. Option names must not be empty, must not start with a dash or a slash character, must not contain a = and cannot be repeated.

The description is set to description. It is customary to add a “.” at the end of the description.

In addition, the valueName needs to be set if the option expects a value. The default value for the option is set to defaultValue.

In Qt versions before 5.4, this constructor was explicit. In Qt 5.4 and later, it no longer is and can be used for C++11-style uniform initialization:

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

setDescription() setValueName() setDefaultValues()

PySide6.QtCore.QCommandLineOption.Flag¶

Constant	Description
QCommandLineOption.HiddenFromHelp	Hide this option in the user-visible help output. All options are visible by default. Setting this flag for a particular option makes it internal, i.e. not listed in the help output.
QCommandLineOption.ShortOptionStyle	The option will always be understood as a short option, regardless of what was set by `setSingleDashWordOptionMode` . This allows flags such as `-DDEFINE=VALUE` or `-I/include/path` to be interpreted as short flags even when the parser is in `ParseAsLongOptions` mode.

Table of Contents

Previous topic

Next topic