QInputDialog Class | Qt Widgets 5.15.18 (original) (raw)

The QInputDialog class provides a simple convenience dialog to get a single value from the user. More...

Property Documentation

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:

comboBoxEditable : bool

This property holds whether or not the combo box used in the input dialog is editable

This property was introduced in Qt 4.5.

Access functions:

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:

doubleDecimals : int

sets the precision of the double spinbox in decimals

This property was introduced in Qt 4.5.

Access functions:

See also QDoubleSpinBox::setDecimals().

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:

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:

doubleStep : double

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

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

This property was introduced in Qt 5.10.

Access functions:

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:

Notifier signal:

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:

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:

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:

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:

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:

Notifier signal:

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:

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:

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:

See also setOption() and testOption().

textEchoMode : QLineEdit::EchoMode

This property holds the echo mode for the text value

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

This property was introduced in Qt 4.5.

Access functions:

textValue : QString

This property holds the text value for the input dialog

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

This property was introduced in Qt 4.5.

Access functions:

Notifier signal:

Member Function Documentation

QInputDialog::QInputDialog(QWidget *parent = nullptr, Qt::WindowFlags flags = Qt::WindowFlags())

Constructs a new input dialog with the given parent and window flags.

This function was introduced in Qt 4.5.

[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.

[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.

[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.

[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.

[signal] void QInputDialog::textValueChanged(const QString &text)

This signal is emitted whenever the text string changes in the dialog. The current string is specified by text.

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

Note: Notifier signal for property textValue.

[signal] void QInputDialog::textValueSelected(const QString &text)

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

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

[virtual] QInputDialog::~QInputDialog()

Destroys the input dialog.

This function was introduced in Qt 4.5.

[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().

[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](qinputdialog.html#QInputDialog)::getDouble(this, tr("QInputDialog::getDouble()"),
                                   tr("Amount:"), 37.56, -10000, 10000, 2, &ok,
                                   Qt::WindowFlags(), 1);
if (ok)
    doubleLabel->setText([QString](qstring.html)("$%1").arg(d));

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

[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](qinputdialog.html#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().

[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](qstringlist.html) items;
items << tr("Spring") << tr("Summer") << tr("Fall") << tr("Winter");

bool ok;
[QString](qstring.html) item = [QInputDialog](qinputdialog.html#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().

[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](qstring.html) text = [QInputDialog](qinputdialog.html#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().

[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](qstring.html) text = [QInputDialog](qinputdialog.html#QInputDialog)::getText(this, tr("QInputDialog::getText()"),
                                     tr("User name:"), [QLineEdit](qlineedit.html)::Normal,
                                     [QDir](qdir.html)::home().dirName(), &ok);
if (ok && !text.isEmpty())
    textLabel->setText(text);

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

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

Reimplements: QDialog::minimumSizeHint() const.

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:

• textValueSelected() if member has a QString for its first argument.
• intValueSelected() if member has an int for its first argument.
• doubleValueSelected() if member has a double for its first argument.
• accepted() if member has NO arguments.

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

This function was introduced in Qt 4.5.

void QInputDialog::setDoubleRange(double min, double max)

Sets the range of double precision floating point values accepted by the dialog when used in DoubleInput mode, with minimum and maximum values specified by min and max respectively.

void QInputDialog::setIntRange(int min, int max)

Sets the range of integer values accepted by the dialog when used in IntInput mode, with minimum and maximum values specified by min and max respectively.

void QInputDialog::setOption(QInputDialog::InputDialogOption option, bool on = true)

Sets the given option to be enabled if on is true; otherwise, clears the given option.

See also options and testOption().

[override virtual] void QInputDialog::setVisible(bool visible)

Reimplements: QDialog::setVisible(bool visible).

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

Reimplements: QDialog::sizeHint() const.

bool QInputDialog::testOption(QInputDialog::InputDialogOption option) const

Returns true if the given option is enabled; otherwise, returns false.

See also options and setOption().