Skip to content

PythonQt.QtGui.QInputDialog · declarations 001

Back to PythonQt.QtGui.QInputDialog

DoubleInput instance-attribute

DoubleInput: Any

InputDialogOption instance-attribute

InputDialogOption: type

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

InputDialogOptions instance-attribute

InputDialogOptions: type

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

InputMode instance-attribute

InputMode: type

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

IntInput instance-attribute

IntInput: Any

TextInput instance-attribute

TextInput: Any

UseListViewForComboBoxItems instance-attribute

UseListViewForComboBoxItems: Any

UsePlainTextEditForTextInput instance-attribute

UsePlainTextEditForTextInput: Any

accepted

accepted(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QInputDialog.accepted; argument details are not documented.

cancelButtonText

cancelButtonText() -> str

X.cancelButtonText() -> str

Supplemental documentation: Qt 5 reference:

cancelButtonText : QString

This property holds the text for the button used to cancel the dialog

This property was introduced in Qt 4.5.

Access functions:

QString cancelButtonText() const
void setCancelButtonText(const QString \&text)

Upstream PySide2 reference signatures (binding differences may apply):

cancelButtonText(self) -> str

Source: https://doc.qt.io/archives/qt-5.15/qinputdialog.html#cancelButtonText

comboBoxItems

comboBoxItems() -> tuple

X.comboBoxItems() -> tuple

Supplemental documentation: Qt 5 reference:

comboBoxItems : QStringList

This property holds the items used in the combo box for the input dialog

This property was introduced in Qt 4.5.

Access functions:

QStringList comboBoxItems() const
void setComboBoxItems(const QStringList \&items)

Upstream PySide2 reference signatures (binding differences may apply):

comboBoxItems(self) -> typing.List[str]

Source: https://doc.qt.io/archives/qt-5.15/qinputdialog.html#comboBoxItems

customContextMenuRequested

customContextMenuRequested(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QInputDialog.customContextMenuRequested; argument details are not documented.

destroyed

destroyed(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QInputDialog.destroyed; argument details are not documented.

done

done(result: int) -> None

X.done(result)

Supplemental documentation: Qt 5 reference:

[override virtual] void QInputDialog::done(int result)

Reimplements: QDialog::done(int r).

Closes the dialog and sets its result code to result. If this dialog is shown with exec(), done() causes the local event loop to finish, and exec() to return result.

See also QDialog::done().

Upstream PySide2 reference signatures (binding differences may apply):

done(self, result: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qinputdialog.html#done

doubleDecimals

doubleDecimals() -> int

X.doubleDecimals() -> int

Supplemental documentation: Qt 5 reference:

doubleDecimals : int

sets the precision of the double spinbox in decimals

This property was introduced in Qt 4.5.

Access functions:

int doubleDecimals() const
void setDoubleDecimals(int decimals)

See also QDoubleSpinBox::setDecimals().

Upstream PySide2 reference signatures (binding differences may apply):

doubleDecimals(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qinputdialog.html#doubleDecimals

doubleMaximum

doubleMaximum() -> float

X.doubleMaximum() -> float

Supplemental documentation: Qt 5 reference:

doubleMaximum : double

This property holds the maximum double precision floating point value accepted as input

This property is only relevant when the input dialog is used in DoubleInput mode.

This property was introduced in Qt 4.5.

Access functions:

double doubleMaximum() const
void setDoubleMaximum(double max)

Upstream PySide2 reference signatures (binding differences may apply):

doubleMaximum(self) -> float

Source: https://doc.qt.io/archives/qt-5.15/qinputdialog.html#doubleMaximum

doubleMinimum

doubleMinimum() -> float

X.doubleMinimum() -> float

Supplemental documentation: Qt 5 reference:

doubleMinimum : double

This property holds the minimum double precision floating point value accepted as input

This property is only relevant when the input dialog is used in DoubleInput mode.

This property was introduced in Qt 4.5.

Access functions:

double doubleMinimum() const
void setDoubleMinimum(double min)

Upstream PySide2 reference signatures (binding differences may apply):

doubleMinimum(self) -> float

Source: https://doc.qt.io/archives/qt-5.15/qinputdialog.html#doubleMinimum

doubleValue

doubleValue() -> float

X.doubleValue() -> float

Supplemental documentation: Qt 5 reference:

doubleValue : int

This property holds the current double precision floating point value accepted as input

This property is only relevant when the input dialog is used in DoubleInput mode.

This property was introduced in Qt 4.5.

Access functions:

double doubleValue() const
void setDoubleValue(double value)

Notifier signal:

void doubleValueChanged(double value)

Upstream PySide2 reference signatures (binding differences may apply):

doubleValue(self) -> float

Source: https://doc.qt.io/archives/qt-5.15/qinputdialog.html#doubleValue

doubleValueChanged

doubleValueChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QInputDialog.doubleValueChanged; argument details are not documented.

Supplemental documentation: Qt 5 reference:

[signal] void QInputDialog::doubleValueChanged(double value)

This signal is emitted whenever the double value changes in the dialog. The current value is specified by value.

This signal is only relevant when the input dialog is used in DoubleInput mode.

Note: Notifier signal for property doubleValue.

Source: https://doc.qt.io/archives/qt-5.15/qinputdialog.html#doubleValueChanged

doubleValueSelected

doubleValueSelected(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QInputDialog.doubleValueSelected; argument details are not documented.

Supplemental documentation: Qt 5 reference:

[signal] void QInputDialog::doubleValueSelected(double value)

This signal is emitted whenever the user selects a double value by accepting the dialog; for example, by clicking the OK button. The selected value is specified by value.

This signal is only relevant when the input dialog is used in DoubleInput mode.

Source: https://doc.qt.io/archives/qt-5.15/qinputdialog.html#doubleValueSelected

finished

finished(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QInputDialog.finished; argument details are not documented.

getDouble

getDouble(parent: Any, title: str, label: str, value: float, minValue: float, maxValue: float, decimals: int, ok: Any, arg8: flags) -> float

X.getDouble(parent, title, label, value, minValue, maxValue, decimals, ok, flags) -> float

Supplemental documentation: Qt 5 reference:

[static] double QInputDialog::getDouble(QWidget *parent, const QString \&title, const QString \&label, double value \= 0, double min \= -2147483647, double max \= 2147483647, int decimals \= 1, bool *ok \= nullptr, Qt::WindowFlags flags \= Qt::WindowFlags(), double step \= 1)

Static convenience function to get a floating point number from the user.

title is the text which is displayed in the title bar of the dialog. label is the text which is shown to the user (it should say what should be entered). value is the default floating point number that the line edit will be set to. min and max are the minimum and maximum values the user may choose. decimals is the maximum number of decimal places the number may have. step is the amount by which the values change as the user presses the arrow buttons to increment or decrement the value.

If ok is nonnull, *ok will be set to true if the user pressed OK and to false if the user pressed Cancel. The dialog's parent is parent. The dialog will be modal and uses the widget flags.

This function returns the floating point number which has been entered by the user.

Use this static function like this:

    bool ok;
    double d = QInputDialog::getDouble(this, tr("QInputDialog::getDouble()"),
                                       tr("Amount:"), 37.56, -10000, 10000, 2, &ok,
                                       Qt::WindowFlags(), 1);
    if (ok)
        doubleLabel->setText(QString("$%1").arg(d));

See also getText(), getInt(), getItem(), and getMultiLineText().

Upstream PySide2 reference signatures (binding differences may apply):

getDouble(parent: PySide2.QtWidgets.QWidget, title: str, label: str, value: float, minValue: float, maxValue: float, decimals: int, flags: PySide2.QtCore.Qt.WindowFlags, step: float) -> typing.Tuple[float, bool]
getDouble(parent: PySide2.QtWidgets.QWidget, title: str, label: str, value: float, minValue: float=..., maxValue: float=..., decimals: int=..., flags: PySide2.QtCore.Qt.WindowFlags=...) -> typing.Tuple[float, bool]

Source: https://doc.qt.io/archives/qt-5.15/qinputdialog.html#getDouble

getInt

getInt(parent: Any, title: str, label: str, value: int, minValue: int, maxValue: int, step: int, ok: Any, arg8: flags) -> int

X.getInt(parent, title, label, value, minValue, maxValue, step, ok, flags) -> int

Supplemental documentation: Qt 5 reference:

[static] int QInputDialog::getInt(QWidget *parent, const QString \&title, const QString \&label, int value \= 0, int min \= -2147483647, int max \= 2147483647, int step \= 1, bool *ok \= nullptr, Qt::WindowFlags flags \= Qt::WindowFlags())

Static convenience function to get an integer input from the user.

title is the text which is displayed in the title bar of the dialog. label is the text which is shown to the user (it should say what should be entered). value is the default integer which the spinbox will be set to. min and max are the minimum and maximum values the user may choose. step is the amount by which the values change as the user presses the arrow buttons to increment or decrement the value.

If ok is nonnull *ok will be set to true if the user pressed OK and to false if the user pressed Cancel. The dialog's parent is parent. The dialog will be modal and uses the widget flags.

On success, this function returns the integer which has been entered by the user; on failure, it returns the initial value.

Use this static function like this:

    bool ok;
    int i = QInputDialog::getInt(this, tr("QInputDialog::getInt()"),
                                 tr("Percentage:"), 25, 0, 100, 1, &ok);
    if (ok)
        integerLabel->setText(tr("%1%").arg(i));

This function was introduced in Qt 4.5.

See also getText(), getDouble(), getItem(), and getMultiLineText().

Upstream PySide2 reference signatures (binding differences may apply):

getInt(parent: PySide2.QtWidgets.QWidget, title: str, label: str, value: int, minValue: int=..., maxValue: int=..., step: int=..., flags: PySide2.QtCore.Qt.WindowFlags=...) -> typing.Tuple[int, bool]

Source: https://doc.qt.io/archives/qt-5.15/qinputdialog.html#getInt

getItem

getItem(parent: Any, title: str, label: str, items: Any, current: int, editable: bool, ok: Any, arg7: flags, inputMethodHints: Any) -> str

X.getItem(parent, title, label, items, current, editable, ok, flags, inputMethodHints) -> str

Supplemental documentation: Qt 5 reference:

[static] QString QInputDialog::getItem(QWidget *parent, const QString \&title, const QString \&label, const QStringList \&items, int current \= 0, bool editable \= true, bool *ok \= nullptr, Qt::WindowFlags flags \= Qt::WindowFlags(), Qt::InputMethodHints inputMethodHints \= Qt::ImhNone)

Static convenience function to let the user select an item from a string list.

title is the text which is displayed in the title bar of the dialog. label is the text which is shown to the user (it should say what should be entered). items is the string list which is inserted into the combo box. current is the number of the item which should be the current item. inputMethodHints is the input method hints that will be used if the combo box is editable and an input method is active.

If editable is true the user can enter their own text; otherwise, the user may only select one of the existing items.

If ok is nonnull *ok will be set to true if the user pressed OK and to false if the user pressed Cancel. The dialog's parent is parent. The dialog will be modal and uses the widget flags.

This function returns the text of the current item, or if editable is true, the current text of the combo box.

Use this static function like this:

    QStringList items;
    items << tr("Spring") << tr("Summer") << tr("Fall") << tr("Winter");

    bool ok;
    QString item = QInputDialog::getItem(this, tr("QInputDialog::getItem()"),
                                         tr("Season:"), items, 0, false, &ok);
    if (ok && !item.isEmpty())
        itemLabel->setText(item);

See also getText(), getInt(), getDouble(), and getMultiLineText().

Upstream PySide2 reference signatures (binding differences may apply):

getItem(parent: PySide2.QtWidgets.QWidget, title: str, label: str, items: typing.Sequence[str], current: int, editable: bool=..., flags: PySide2.QtCore.Qt.WindowFlags=..., inputMethodHints: PySide2.QtCore.Qt.InputMethodHints=...) -> typing.Tuple[str, bool]

Source: https://doc.qt.io/archives/qt-5.15/qinputdialog.html#getItem

getMultiLineText

getMultiLineText(parent: Any, title: str, label: str, text: str, ok: Any, arg5: flags, inputMethodHints: Any) -> str

X.getMultiLineText(parent, title, label, text, ok, flags, inputMethodHints) -> str

Supplemental documentation: Qt 5 reference:

[static] QString QInputDialog::getMultiLineText(QWidget *parent, const QString \&title, const QString \&label, const QString \&text \= QString(), bool *ok \= nullptr, Qt::WindowFlags flags \= Qt::WindowFlags(), Qt::InputMethodHints inputMethodHints \= Qt::ImhNone)

Static convenience function to get a multiline string from the user.

title is the text which is displayed in the title bar of the dialog. label is the text which is shown to the user (it should say what should be entered). text is the default text which is placed in the plain text edit. inputMethodHints is the input method hints that will be used in the edit widget if an input method is active.

If ok is nonnull *ok will be set to true if the user pressed OK and to false if the user pressed Cancel. The dialog's parent is parent. The dialog will be modal and uses the specified widget flags.

If the dialog is accepted, this function returns the text in the dialog's plain text edit. If the dialog is rejected, a null QString is returned.

Use this static function like this:

    bool ok;
    QString text = QInputDialog::getMultiLineText(this, tr("QInputDialog::getMultiLineText()"),
                                                  tr("Address:"), "John Doe\nFreedom Street", &ok);
    if (ok && !text.isEmpty())
        multiLineTextLabel->setText(text);

This function was introduced in Qt 5.2.

See also getInt(), getDouble(), getItem(), and getText().

Upstream PySide2 reference signatures (binding differences may apply):

getMultiLineText(parent: PySide2.QtWidgets.QWidget, title: str, label: str, text: str, flags: PySide2.QtCore.Qt.WindowFlags=..., inputMethodHints: PySide2.QtCore.Qt.InputMethodHints=...) -> typing.Tuple[str, bool]

Source: https://doc.qt.io/archives/qt-5.15/qinputdialog.html#getMultiLineText

getText

getText(parent: Any, title: str, label: str, echo: Any, text: str, ok: Any, arg6: flags, inputMethodHints: Any) -> str

X.getText(parent, title, label, echo, text, ok, flags, inputMethodHints) -> str

Supplemental documentation: Qt 5 reference:

[static] QString QInputDialog::getText(QWidget *parent, const QString \&title, const QString \&label, QLineEdit::EchoMode mode \= QLineEdit::Normal, const QString \&text \= QString(), bool *ok \= nullptr, Qt::WindowFlags flags \= Qt::WindowFlags(), Qt::InputMethodHints inputMethodHints \= Qt::ImhNone)

Static convenience function to get a string from the user.

title is the text which is displayed in the title bar of the dialog. label is the text which is shown to the user (it should say what should be entered). text is the default text which is placed in the line edit. mode is the echo mode the line edit will use. inputMethodHints is the input method hints that will be used in the edit widget if an input method is active.

If ok is nonnull *ok will be set to true if the user pressed OK and to false if the user pressed Cancel. The dialog's parent is parent. The dialog will be modal and uses the specified widget flags.

If the dialog is accepted, this function returns the text in the dialog's line edit. If the dialog is rejected, a null QString is returned.

Use this static function like this:

    bool ok;
    QString text = QInputDialog::getText(this, tr("QInputDialog::getText()"),
                                         tr("User name:"), QLineEdit::Normal,
                                         QDir::home().dirName(), &ok);
    if (ok && !text.isEmpty())
        textLabel->setText(text);

See also getInt(), getDouble(), getItem(), and getMultiLineText().

Upstream PySide2 reference signatures (binding differences may apply):

getText(parent: PySide2.QtWidgets.QWidget, title: str, label: str, echo: PySide2.QtWidgets.QLineEdit.EchoMode, text: str=..., flags: PySide2.QtCore.Qt.WindowFlags=..., inputMethodHints: PySide2.QtCore.Qt.InputMethodHints=...) -> typing.Tuple[str, bool]

Source: https://doc.qt.io/archives/qt-5.15/qinputdialog.html#getText

inputMode

inputMode() -> Any

X.inputMode()

Supplemental documentation: Qt 5 reference:

inputMode : InputMode

This property holds the mode used for input

This property helps determine which widget is used for entering input into the dialog.

This property was introduced in Qt 4.5.

Access functions:

QInputDialog::InputMode inputMode() const
void setInputMode(QInputDialog::InputMode mode)

Upstream PySide2 reference signatures (binding differences may apply):

inputMode(self) -> PySide2.QtWidgets.QInputDialog.InputMode

Source: https://doc.qt.io/archives/qt-5.15/qinputdialog.html#inputMode

intMaximum

intMaximum() -> int

X.intMaximum() -> int

Supplemental documentation: Qt 5 reference:

intMaximum : int

This property holds the maximum integer value accepted as input

This property is only relevant when the input dialog is used in IntInput mode.

This property was introduced in Qt 4.5.

Access functions:

int intMaximum() const
void setIntMaximum(int max)

Upstream PySide2 reference signatures (binding differences may apply):

intMaximum(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qinputdialog.html#intMaximum

intMinimum

intMinimum() -> int

X.intMinimum() -> int

Supplemental documentation: Qt 5 reference:

intMinimum : int

This property holds the minimum integer value accepted as input

This property is only relevant when the input dialog is used in IntInput mode.

This property was introduced in Qt 4.5.

Access functions:

int intMinimum() const
void setIntMinimum(int min)

Upstream PySide2 reference signatures (binding differences may apply):

intMinimum(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qinputdialog.html#intMinimum

intStep

intStep() -> int

X.intStep() -> int

Supplemental documentation: Qt 5 reference:

intStep : int

This property holds the step by which the integer value is increased and decreased

This property is only relevant when the input dialog is used in IntInput mode.

This property was introduced in Qt 4.5.

Access functions:

int intStep() const
void setIntStep(int step)

Upstream PySide2 reference signatures (binding differences may apply):

intStep(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qinputdialog.html#intStep

intValue

intValue() -> int

X.intValue() -> int

Supplemental documentation: Qt 5 reference:

intValue : int

This property holds the current integer value accepted as input

This property is only relevant when the input dialog is used in IntInput mode.

This property was introduced in Qt 4.5.

Access functions:

int intValue() const
void setIntValue(int value)

Notifier signal:

void intValueChanged(int value)

Upstream PySide2 reference signatures (binding differences may apply):

intValue(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qinputdialog.html#intValue

intValueChanged

intValueChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QInputDialog.intValueChanged; argument details are not documented.

Supplemental documentation: Qt 5 reference:

[signal] void QInputDialog::intValueChanged(int value)

This signal is emitted whenever the integer value changes in the dialog. The current value is specified by value.

This signal is only relevant when the input dialog is used in IntInput mode.

Note: Notifier signal for property intValue.

Source: https://doc.qt.io/archives/qt-5.15/qinputdialog.html#intValueChanged

intValueSelected

intValueSelected(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QInputDialog.intValueSelected; argument details are not documented.

Supplemental documentation: Qt 5 reference:

[signal] void QInputDialog::intValueSelected(int value)

This signal is emitted whenever the user selects a integer value by accepting the dialog; for example, by clicking the OK button. The selected value is specified by value.

This signal is only relevant when the input dialog is used in IntInput mode.

Source: https://doc.qt.io/archives/qt-5.15/qinputdialog.html#intValueSelected

isComboBoxEditable

isComboBoxEditable() -> bool

X.isComboBoxEditable() -> bool

Upstream PySide2 reference signatures (binding differences may apply):

isComboBoxEditable(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qinputdialog.html#isComboBoxEditable

labelText

labelText() -> str

X.labelText() -> str

Supplemental documentation: Qt 5 reference:

labelText : QString

This property holds the label's text which describes what needs to be input

This property was introduced in Qt 4.5.

Access functions:

QString labelText() const
void setLabelText(const QString \&text)

Upstream PySide2 reference signatures (binding differences may apply):

labelText(self) -> str

Source: https://doc.qt.io/archives/qt-5.15/qinputdialog.html#labelText

minimumSizeHint instance-attribute

minimumSizeHint: QSize

Qt 5 reference:

[override virtual] QSize QInputDialog::minimumSizeHint() const

Reimplements: QDialog::minimumSizeHint() const.

Source: https://doc.qt.io/archives/qt-5.15/qinputdialog.html#minimumSizeHint

objectNameChanged

objectNameChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QInputDialog.objectNameChanged; argument details are not documented.

okButtonText

okButtonText() -> str

X.okButtonText() -> str

Supplemental documentation: Qt 5 reference:

okButtonText : QString

This property holds the text for the button used to accept the entry in the dialog

This property was introduced in Qt 4.5.

Access functions:

QString okButtonText() const
void setOkButtonText(const QString \&text)

Upstream PySide2 reference signatures (binding differences may apply):

okButtonText(self) -> str

Source: https://doc.qt.io/archives/qt-5.15/qinputdialog.html#okButtonText

open

open() -> None

X.open()

Supplemental documentation: Qt 5 reference:

void QInputDialog::open(QObject *receiver, const char *member)

This function connects one of its signals to the slot specified by receiver and member. The specific signal depends on the arguments that are specified in member. These are:

The signal will be disconnected from the slot when the dialog is closed.

This function was introduced in Qt 4.5.

Upstream PySide2 reference signatures (binding differences may apply):

open(self) -> None
open(self, receiver: PySide2.QtCore.QObject, member: str) -> None

Source: https://doc.qt.io/archives/qt-5.15/qinputdialog.html#open

options

options() -> Any

X.options()

Supplemental documentation: Qt 5 reference:

options : InputDialogOptions

This property holds the various options that affect the look and feel of the dialog

By default, all options are disabled.

This property was introduced in Qt 4.5.

Access functions:

QInputDialog::InputDialogOptions options() const
void setOptions(QInputDialog::InputDialogOptions options)

See also setOption() and testOption().

Source: https://doc.qt.io/archives/qt-5.15/qinputdialog.html#options