QInputDialog¶
The
QInputDialog
class provides a simple convenience dialog to get a single value from the user. More…
Synopsis¶
Functions¶
def
cancelButtonText
()def
comboBoxItems
()def
doubleDecimals
()def
doubleMaximum
()def
doubleMinimum
()def
doubleStep
()def
doubleValue
()def
inputMode
()def
intMaximum
()def
intMinimum
()def
intStep
()def
intValue
()def
isComboBoxEditable
()def
labelText
()def
okButtonText
()def
open
(receiver, member)def
setCancelButtonText
(text)def
setComboBoxEditable
(editable)def
setComboBoxItems
(items)def
setDoubleDecimals
(decimals)def
setDoubleMaximum
(max)def
setDoubleMinimum
(min)def
setDoubleRange
(min, max)def
setDoubleStep
(step)def
setDoubleValue
(value)def
setInputMode
(mode)def
setIntMaximum
(max)def
setIntMinimum
(min)def
setIntRange
(min, max)def
setIntStep
(step)def
setIntValue
(value)def
setLabelText
(text)def
setOkButtonText
(text)def
setOption
(option[, on=true])def
setTextEchoMode
(mode)def
setTextValue
(text)def
testOption
(option)def
textEchoMode
()def
textValue
()
Signals¶
def
doubleValueChanged
(value)def
doubleValueSelected
(value)def
intValueChanged
(value)def
intValueSelected
(value)def
textValueChanged
(text)def
textValueSelected
(text)
Static functions¶
def
getDouble
(parent, title, label, value, minValue, maxValue, decimals, flags, step)def
getDouble
(parent, title, label[, value=0[, minValue=-2147483647[, maxValue=2147483647[, decimals=1[, flags=Qt.WindowFlags()]]]]])def
getInt
(parent, title, label[, value=0[, minValue=-2147483647[, maxValue=2147483647[, step=1[, flags=Qt.WindowFlags()]]]]])def
getItem
(parent, title, label, items[, current=0[, editable=true[, flags=Qt.WindowFlags()[, inputMethodHints=Qt.ImhNone]]]])def
getMultiLineText
(parent, title, label[, text=””[, flags=Qt.WindowFlags()[, inputMethodHints=Qt.ImhNone]]])def
getText
(parent, title, label[, echo=QLineEdit.Normal[, text=””[, flags=Qt.WindowFlags()[, inputMethodHints=Qt.ImhNone]]]])
Detailed Description¶
The input value can be a string, a number or an item from a list. A label must be set to tell the user what they should enter.
Five static convenience functions are provided:
getText()
,getMultiLineText()
,getInt()
,getDouble()
, andgetItem()
. All the functions can be used in a similar way, for example:text, ok = QInputDialog().getText(self, "QInputDialog().getText()", "User name:", QLineEdit.Normal, QDir().home().dirName()) if ok and text: textLabel.setText(text)The
ok
variable is set to true if the user clicks OK; otherwise, it is set to false.The Standard Dialogs example shows how to use
QInputDialog
as well as other built-in Qt dialogs.See also
QMessageBox
Standard Dialogs Example
- class PySide2.QtWidgets.QInputDialog([parent=None[, flags=Qt.WindowFlags()]])¶
- param parent:
- param flags:
WindowFlags
Constructs a new input dialog with the given
parent
and windowflags
.
- PySide2.QtWidgets.QInputDialog.InputDialogOption¶
This enum specifies various options that affect the look and feel of an input dialog.
Constant
Description
QInputDialog.NoButtons
Don’t display OK and Cancel buttons (useful for “live dialogs”).
QInputDialog.UseListViewForComboBoxItems
Use a
QListView
rather than a non-editableQComboBox
for displaying the items set withsetComboBoxItems()
.QInputDialog.UsePlainTextEditForTextInput
Use a
QPlainTextEdit
for multiline text input. This value was introduced in 5.2.See also
options
setOption()
testOption()
- PySide2.QtWidgets.QInputDialog.InputMode¶
This enum describes the different modes of input that can be selected for the dialog.
Constant
Description
QInputDialog.TextInput
Used to input text strings.
QInputDialog.IntInput
Used to input integers.
QInputDialog.DoubleInput
Used to input floating point numbers with double precision accuracy.
See also
- PySide2.QtWidgets.QInputDialog.cancelButtonText()¶
- Return type:
str
See also
- PySide2.QtWidgets.QInputDialog.comboBoxItems()¶
- Return type:
list of strings
See also
- PySide2.QtWidgets.QInputDialog.doubleDecimals()¶
- Return type:
int
See also
- PySide2.QtWidgets.QInputDialog.doubleMaximum()¶
- Return type:
double
See also
- PySide2.QtWidgets.QInputDialog.doubleMinimum()¶
- Return type:
double
See also
- PySide2.QtWidgets.QInputDialog.doubleStep()¶
- Return type:
double
See also
- PySide2.QtWidgets.QInputDialog.doubleValue()¶
- Return type:
double
See also
- PySide2.QtWidgets.QInputDialog.doubleValueChanged(value)¶
- Parameters:
value –
double
- PySide2.QtWidgets.QInputDialog.doubleValueSelected(value)¶
- Parameters:
value –
double
- static PySide2.QtWidgets.QInputDialog.getDouble(parent, title, label[, value=0[, minValue=-2147483647[, maxValue=2147483647[, decimals=1[, flags=Qt.WindowFlags()]]]]])¶
- Parameters:
parent –
PySide2.QtWidgets.QWidget
title – str
label – str
value –
double
minValue –
double
maxValue –
double
decimals – int
flags –
WindowFlags
- Return type:
double
- static PySide2.QtWidgets.QInputDialog.getDouble(parent, title, label, value, minValue, maxValue, decimals, flags, step)
- Parameters:
parent –
PySide2.QtWidgets.QWidget
title – str
label – str
value –
double
minValue –
double
maxValue –
double
decimals – int
flags –
WindowFlags
step –
double
- Return type:
double
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
andmax
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 isparent
. The dialog will be modal and uses the widgetflags
.This function returns the floating point number which has been entered by the user.
Use this static function like this:
d, ok = QInputDialog().getDouble(self, "QInputDialog().getDouble()", "Amount:", 37.56, -10000, 10000, 2) if ok: doubleLabel.setText("${}".format())
See also
- static PySide2.QtWidgets.QInputDialog.getInt(parent, title, label[, value=0[, minValue=-2147483647[, maxValue=2147483647[, step=1[, flags=Qt.WindowFlags()]]]]])¶
- Parameters:
parent –
PySide2.QtWidgets.QWidget
title – str
label – str
value – int
minValue – int
maxValue – int
step – int
flags –
WindowFlags
- Return type:
int
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
andmax
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 isparent
. The dialog will be modal and uses the widgetflags
.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:
i, ok = QInputDialog().getInteger(self, "QInputDialog().getInteger()", "Percentage:", 25, 0, 100, 1) if ok: self.integerLabel.setText("{}%".format(i))
See also
- static PySide2.QtWidgets.QInputDialog.getItem(parent, title, label, items[, current=0[, editable=true[, flags=Qt.WindowFlags()[, inputMethodHints=Qt.ImhNone]]]])¶
- Parameters:
parent –
PySide2.QtWidgets.QWidget
title – str
label – str
items – list of strings
current – int
editable – bool
flags –
WindowFlags
inputMethodHints –
InputMethodHints
- Return type:
str
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 isparent
. The dialog will be modal and uses the widgetflags
.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:
items = ["Spring", "Summer", "Fall", "Winter"] item, ok = QInputDialog().getItem(self, "QInputDialog().getItem()", "Season:", items, 0, False) if ok and not item.isEmpty(): itemLabel.setText(item)
See also
- static PySide2.QtWidgets.QInputDialog.getMultiLineText(parent, title, label[, text=""[, flags=Qt.WindowFlags()[, inputMethodHints=Qt.ImhNone]]])¶
- Parameters:
parent –
PySide2.QtWidgets.QWidget
title – str
label – str
text – str
flags –
WindowFlags
inputMethodHints –
InputMethodHints
- Return type:
str
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 isparent
. The dialog will be modal and uses the specified widgetflags
.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);
See also
- static PySide2.QtWidgets.QInputDialog.getText(parent, title, label[, echo=QLineEdit.Normal[, text=""[, flags=Qt.WindowFlags()[, inputMethodHints=Qt.ImhNone]]]])¶
- Parameters:
parent –
PySide2.QtWidgets.QWidget
title – str
label – str
echo –
EchoMode
text – str
flags –
WindowFlags
inputMethodHints –
InputMethodHints
- Return type:
str
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 isparent
. The dialog will be modal and uses the specified widgetflags
.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:
text, ok = QInputDialog().getText(self, "QInputDialog().getText()", "User name:", QLineEdit.Normal, QDir().home().dirName()) if ok and text: textLabel.setText(text)
See also
- PySide2.QtWidgets.QInputDialog.inputMode()¶
- Return type:
See also
- PySide2.QtWidgets.QInputDialog.intMaximum()¶
- Return type:
int
See also
- PySide2.QtWidgets.QInputDialog.intMinimum()¶
- Return type:
int
See also
- PySide2.QtWidgets.QInputDialog.intStep()¶
- Return type:
int
See also
- PySide2.QtWidgets.QInputDialog.intValue()¶
- Return type:
int
See also
- PySide2.QtWidgets.QInputDialog.intValueChanged(value)¶
- Parameters:
value – int
- PySide2.QtWidgets.QInputDialog.intValueSelected(value)¶
- Parameters:
value – int
- PySide2.QtWidgets.QInputDialog.isComboBoxEditable()¶
- Return type:
bool
- PySide2.QtWidgets.QInputDialog.labelText()¶
- Return type:
str
See also
- PySide2.QtWidgets.QInputDialog.okButtonText()¶
- Return type:
str
See also
- PySide2.QtWidgets.QInputDialog.open(receiver, member)¶
- Parameters:
receiver –
PySide2.QtCore.QObject
member – str
This function connects one of its signals to the slot specified by
receiver
andmember
. The specific signal depends on the arguments that are specified inmember
. These are:textValueSelected()
ifmember
has aQString
for its first argument.intValueSelected()
ifmember
has an int for its first argument.doubleValueSelected()
ifmember
has a double for its first argument.accepted()
ifmember
has NO arguments.
The signal will be disconnected from the slot when the dialog is closed.
- PySide2.QtWidgets.QInputDialog.setCancelButtonText(text)¶
- Parameters:
text – str
See also
- PySide2.QtWidgets.QInputDialog.setComboBoxEditable(editable)¶
- Parameters:
editable – bool
See also
- PySide2.QtWidgets.QInputDialog.setComboBoxItems(items)¶
- Parameters:
items – list of strings
See also
- PySide2.QtWidgets.QInputDialog.setDoubleDecimals(decimals)¶
- Parameters:
decimals – int
See also
- PySide2.QtWidgets.QInputDialog.setDoubleMaximum(max)¶
- Parameters:
max –
double
See also
- PySide2.QtWidgets.QInputDialog.setDoubleMinimum(min)¶
- Parameters:
min –
double
See also
- PySide2.QtWidgets.QInputDialog.setDoubleRange(min, max)¶
- Parameters:
min –
double
max –
double
Sets the range of double precision floating point values accepted by the dialog when used in
DoubleInput
mode, with minimum and maximum values specified bymin
andmax
respectively.
- PySide2.QtWidgets.QInputDialog.setDoubleStep(step)¶
- Parameters:
step –
double
See also
- PySide2.QtWidgets.QInputDialog.setDoubleValue(value)¶
- Parameters:
value –
double
See also
- PySide2.QtWidgets.QInputDialog.setIntMaximum(max)¶
- Parameters:
max – int
See also
- PySide2.QtWidgets.QInputDialog.setIntMinimum(min)¶
- Parameters:
min – int
See also
- PySide2.QtWidgets.QInputDialog.setIntRange(min, max)¶
- Parameters:
min – int
max – int
Sets the range of integer values accepted by the dialog when used in
IntInput
mode, with minimum and maximum values specified bymin
andmax
respectively.
- PySide2.QtWidgets.QInputDialog.setIntValue(value)¶
- Parameters:
value – int
See also
- PySide2.QtWidgets.QInputDialog.setLabelText(text)¶
- Parameters:
text – str
See also
- PySide2.QtWidgets.QInputDialog.setOkButtonText(text)¶
- Parameters:
text – str
See also
- PySide2.QtWidgets.QInputDialog.setOption(option[, on=true])¶
- Parameters:
option –
InputDialogOption
on – bool
Sets the given
option
to be enabled ifon
is true; otherwise, clears the givenoption
.See also
options
testOption()
- PySide2.QtWidgets.QInputDialog.setTextValue(text)¶
- Parameters:
text – str
See also
- PySide2.QtWidgets.QInputDialog.testOption(option)¶
- Parameters:
option –
InputDialogOption
- Return type:
bool
Returns
true
if the givenoption
is enabled; otherwise, returns false.See also
options
setOption()
- PySide2.QtWidgets.QInputDialog.textEchoMode()¶
- Return type:
See also
- PySide2.QtWidgets.QInputDialog.textValue()¶
- Return type:
str
See also
- PySide2.QtWidgets.QInputDialog.textValueChanged(text)¶
- Parameters:
text – str
- PySide2.QtWidgets.QInputDialog.textValueSelected(text)¶
- Parameters:
text – str
© 2022 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.