PythonQt.QtCore.QCommandLineOption · declarations 001
Back to PythonQt.QtCore.QCommandLineOption
defaultValues
defaultValues() -> tuple
X.defaultValues() -> tuple
Supplemental documentation: Qt 5 reference:
QStringList QCommandLineOption::defaultValues() const
Returns the default values set for this option.
See also setDefaultValues().
Upstream PySide2 reference signatures (binding differences may apply):
defaultValues(self) -> typing.List[str]
Source: https://doc.qt.io/archives/qt-5.15/qcommandlineoption.html#defaultValues
description
description() -> str
X.description() -> str
Supplemental documentation: Qt 5 reference:
QString QCommandLineOption::description() const
Returns the description set for this option.
See also setDescription().
Upstream PySide2 reference signatures (binding differences may apply):
description(self) -> str
Source: https://doc.qt.io/archives/qt-5.15/qcommandlineoption.html#description
isHidden
isHidden() -> bool
X.isHidden() -> bool
Upstream PySide2 reference signatures (binding differences may apply):
isHidden(self) -> bool
Source: https://doc.qt.io/archives/qt-5.15/qcommandlineoption.html#isHidden
names
names() -> tuple
X.names() -> tuple
Supplemental documentation: Qt 5 reference:
QStringList QCommandLineOption::names() const
Returns the names set for this option.
Upstream PySide2 reference signatures (binding differences may apply):
names(self) -> typing.List[str]
Source: https://doc.qt.io/archives/qt-5.15/qcommandlineoption.html#names
operator_assign
operator_assign(other: Any) -> Any
X.operator_assign(other) -> PythonQt.QtCore.QCommandLineOption
setDefaultValue
setDefaultValue(defaultValue: str) -> None
X.setDefaultValue(defaultValue)
Supplemental documentation: Qt 5 reference:
void QCommandLineOption::setDefaultValue(const QString \&defaultValue)
Sets the default value used for this option to defaultValue.
The default value is used if the user of the application does not specify the option on the command line.
If defaultValue is empty, the option has no default values.
See also defaultValues() and setDefaultValues().
Upstream PySide2 reference signatures (binding differences may apply):
setDefaultValue(self, defaultValue: str) -> None
Source: https://doc.qt.io/archives/qt-5.15/qcommandlineoption.html#setDefaultValue
setDefaultValues
setDefaultValues(defaultValues: Any) -> None
X.setDefaultValues(defaultValues)
Supplemental documentation: Qt 5 reference:
void QCommandLineOption::setDefaultValues(const QStringList \&defaultValues)
Sets the list of default values used for this option to defaultValues.
The default values are used if the user of the application does not specify the option on the command line.
See also defaultValues() and setDefaultValue().
Upstream PySide2 reference signatures (binding differences may apply):
setDefaultValues(self, defaultValues: typing.Sequence[str]) -> None
Source: https://doc.qt.io/archives/qt-5.15/qcommandlineoption.html#setDefaultValues
setDescription
setDescription(description: str) -> None
X.setDescription(description)
Supplemental documentation: Qt 5 reference:
void QCommandLineOption::setDescription(const QString \&description)
Sets the description used for this option to description.
It is customary to add a "." at the end of the description.
The description is used by QCommandLineParser::showHelp().
See also description().
Upstream PySide2 reference signatures (binding differences may apply):
setDescription(self, description: str) -> None
Source: https://doc.qt.io/archives/qt-5.15/qcommandlineoption.html#setDescription
setHidden
setHidden(hidden: bool) -> None
X.setHidden(hidden)
Upstream PySide2 reference signatures (binding differences may apply):
setHidden(self, hidden: bool) -> None
Source: https://doc.qt.io/archives/qt-5.15/qcommandlineoption.html#setHidden
setValueName
setValueName(name: str) -> None
X.setValueName(name)
Supplemental documentation: Qt 5 reference:
void QCommandLineOption::setValueName(const QString \&valueName)
Sets the name of the expected value, for the documentation, to valueName.
Options without a value assigned have a boolean-like behavior: either the user specifies --option or they don't.
Options with a value assigned need to set a name for the expected value, for the
documentation of the option in the help output. An option with names o and output,
and a value name of file will appear as -o, --output <file>.
Call QCommandLineParser::value() if you expect the option to be present only once, and QCommandLineParser::values() if you expect that option to be present multiple times.
See also valueName().
Upstream PySide2 reference signatures (binding differences may apply):
setValueName(self, name: str) -> None
Source: https://doc.qt.io/archives/qt-5.15/qcommandlineoption.html#setValueName
swap
swap(other: Any) -> None
X.swap(other)
Supplemental documentation: Qt 5 reference:
void QCommandLineOption::swap(QCommandLineOption \&other)
Swaps option other with this option. This operation is very fast and never fails.
Upstream PySide2 reference signatures (binding differences may apply):
swap(self, other: PySide2.QtCore.QCommandLineOption) -> None
Source: https://doc.qt.io/archives/qt-5.15/qcommandlineoption.html#swap
valueName
valueName() -> str
X.valueName() -> str
Supplemental documentation: Qt 5 reference:
QString QCommandLineOption::valueName() const
Returns the name of the expected value.
If empty, the option doesn't take a value.
See also setValueName().
Upstream PySide2 reference signatures (binding differences may apply):
valueName(self) -> str
Source: https://doc.qt.io/archives/qt-5.15/qcommandlineoption.html#valueName