Skip to content

PythonQt.Qt.QCommandLineOption

QCommandLineOption

PythonQtInstanceWrapper object

Native bases: PythonQtInstanceWrapper

Supplemental documentation: Qt 5 reference:

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:

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

Source: https://doc.qt.io/archives/qt-5.15/qcommandlineoption.html

Complete member index

Every captured member retains its own identity. Identical captured declaration text is linked once; this does not establish native inheritance or interchangeable objects.

Member Kind Signature Summary
__init__ function (self, *args: Any, **kwargs: Any) -> None Native constructor; consult class documentation for supported overloads. (shared captured text)
className function (self, *args: Any, **kwargs: Any) -> Any Return the classname of the object (shared captured text)
defaultValues function (self) -> tuple X.defaultValues() -> tuple (shared captured text)
delete function (self, *args: Any, **kwargs: Any) -> Any Deletes the C++ object (at your own risk, my friend!) (shared captured text)
description function (self) -> str X.description() -> str (shared captured text)
help function (self, *args: Any, **kwargs: Any) -> Any Shows the help of available methods for this class (shared captured text)
inherits function (self, *args: Any, **kwargs: Any) -> Any Returns if the class inherits or is of given type name (shared captured text)
isHidden function (self) -> bool X.isHidden() -> bool (shared captured text)
names function (self) -> tuple X.names() -> tuple (shared captured text)
operator_assign function (self, other: Any) -> Any X.operator_assign(other) -> PythonQt.QtCore.QCommandLineOption (shared captured text)
setDefaultValue function (self, defaultValue: str) -> None Sets the default value used for this option to defaultValue. (shared captured text)
setDefaultValues function (self, defaultValues: Any) -> None Sets the list of default values used for this option to defaultValues. (shared captured text)
setDescription function (self, description: str) -> None Sets the description used for this option to description. (shared captured text)
setHidden function (self, hidden: bool) -> None (shared captured text)
setValueName function (self, name: str) -> None Sets the name of the expected value, for the documentation, to valueName. (shared captured text)
swap function (self, other: Any) -> None Swaps option other with this option. (shared captured text)
valueName function (self) -> str X.valueName() -> str (shared captured text)