QInputDialog Class

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

Header:	#include <QInputDialog>
qmake:	QT += widgets
Inherits:	QDialog

• List of all members, including inherited members
• Obsolete members

Public Types

enum	InputDialogOption { NoButtons, UseListViewForComboBoxItems, UsePlainTextEditForTextInput }
flags	InputDialogOptions
enum	InputMode { TextInput, IntInput, DoubleInput }

Properties

cancelButtonText : QString comboBoxEditable : bool comboBoxItems : QStringList doubleDecimals : int doubleMaximum : double doubleMinimum : double doubleStep : double doubleValue : int inputMode : InputMode

intMaximum : int intMinimum : int intStep : int intValue : int labelText : QString okButtonText : QString options : InputDialogOptions textEchoMode : QLineEdit::EchoMode textValue : QString

• 2 properties inherited from QDialog
• 59 properties inherited from QWidget
• 1 property inherited from QObject

Public Functions

	QInputDialog(QWidget *parent = nullptr, Qt::WindowFlags flags = ...)
virtual	~QInputDialog()
QString	cancelButtonText() const
QStringList	comboBoxItems() const
int	doubleDecimals() const
double	doubleMaximum() const
double	doubleMinimum() const
double	doubleStep() const
double	doubleValue() const
QInputDialog::InputMode	inputMode() const
int	intMaximum() const
int	intMinimum() const
int	intStep() const
int	intValue() const
bool	isComboBoxEditable() const
QString	labelText() const
QString	okButtonText() const
void	open(QObject *receiver, const char *member)
QInputDialog::InputDialogOptions	options() const
void	setCancelButtonText(const QString &text)
void	setComboBoxEditable(bool editable)
void	setComboBoxItems(const QStringList &items)
void	setDoubleDecimals(int decimals)
void	setDoubleMaximum(double max)
void	setDoubleMinimum(double min)
void	setDoubleRange(double min, double max)
void	setDoubleStep(double step)
void	setDoubleValue(double value)
void	setInputMode(QInputDialog::InputMode mode)
void	setIntMaximum(int max)
void	setIntMinimum(int min)
void	setIntRange(int min, int max)
void	setIntStep(int step)
void	setIntValue(int value)
void	setLabelText(const QString &text)
void	setOkButtonText(const QString &text)
void	setOption(QInputDialog::InputDialogOption option, bool on = true)
void	setOptions(QInputDialog::InputDialogOptions options)
void	setTextEchoMode(QLineEdit::EchoMode mode)
void	setTextValue(const QString &text)
bool	testOption(QInputDialog::InputDialogOption option) const
QLineEdit::EchoMode	textEchoMode() const
QString	textValue() const

Reimplemented Public Functions

virtual void	done(int result) override
virtual QSize	minimumSizeHint() const override
virtual void	setVisible(bool visible) override
virtual QSize	sizeHint() const override

• 8 public functions inherited from QDialog
• 214 public functions inherited from QWidget
• 31 public functions inherited from QObject
• 14 public functions inherited from QPaintDevice

Signals

void	doubleValueChanged(double value)
void	doubleValueSelected(double value)
void	intValueChanged(int value)
void	intValueSelected(int value)
void	textValueChanged(const QString &text)
void	textValueSelected(const QString &text)

• 3 signals inherited from QDialog
• 3 signals inherited from QWidget
• 2 signals inherited from QObject

Static Public Members

double	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 = ...)
double	getDouble(QWidget *parent, const QString &title, const QString &label, double value, double min, double max, int decimals, bool *ok, Qt::WindowFlags flags, double step)
int	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 = ...)
QString	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::InputMethodHints inputMethodHints = Qt::ImhNone)
QString	getMultiLineText(QWidget *parent, const QString &title, const QString &label, const QString &text = QString(), bool *ok = nullptr, Qt::WindowFlags flags = ..., Qt::InputMethodHints inputMethodHints = Qt::ImhNone)
QString	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::InputMethodHints inputMethodHints = Qt::ImhNone)
const QMetaObject	staticMetaObject

• 5 static public members inherited from QWidget
• 9 static public members inherited from QObject

Additional Inherited Members

• 5 public slots inherited from QDialog
• 19 public slots inherited from QWidget
• 1 public slot inherited from QObject
• 6 protected functions inherited from QDialog
• 35 protected functions inherited from QWidget
• 9 protected functions inherited from QObject
• 1 protected function inherited from QPaintDevice
• 1 protected slot inherited from QWidget

Detailed Description

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

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(), and getItem(). All the functions can be used in a similar way, for example:

    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);

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 and Standard Dialogs Example.

Member Type Documentation

enum QInputDialog::InputDialogOptionflags QInputDialog::InputDialogOptions

This enum specifies various options that affect the look and feel of an input dialog.

Constant	Value	Description
QInputDialog::NoButtons	0x00000001	Don't display OK and Cancel buttons (useful for "live dialogs").
QInputDialog::UseListViewForComboBoxItems	0x00000002	Use a QListView rather than a non-editable QComboBox for displaying the items set with setComboBoxItems().
QInputDialog::UsePlainTextEditForTextInput	0x00000004	Use a QPlainTextEdit for multiline text input. This value was introduced in 5.2.

This enum was introduced or modified in Qt 4.5.

The InputDialogOptions type is a typedef for QFlags<InputDialogOption>. It stores an OR combination of InputDialogOption values.

See also options, setOption(), and testOption().

enum QInputDialog::InputMode

This enum describes the different modes of input that can be selected for the dialog.

Constant	Value	Description
QInputDialog::TextInput	0	Used to input text strings.
QInputDialog::IntInput	1	Used to input integers.
QInputDialog::DoubleInput	2	Used to input floating point numbers with double precision accuracy.

This enum was introduced or modified in Qt 4.5.

See also inputMode.

Member Function Documentation

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

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

This function was introduced in Qt 4.5.

[virtual] QInputDialog::~QInputDialog()

Destroys the input dialog.

This function was introduced in Qt 4.5.

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

Reimplemented from QDialog::done().

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

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

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

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.

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);
    if (ok)
        doubleLabel->setText(QString("$%1").arg(d));

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

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

This is an overloaded function.

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);
    if (ok)
        doubleLabel->setText(QString("$%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 = ...)

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::getInteger()"),
                                 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::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().

[static] QString QInputDialog::getMultiLineText(QWidget *parent, const QString &title, const QString &label, const QString &text = QString(), bool *ok = nullptr, Qt::WindowFlags flags = ..., 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().

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

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

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

Reimplemented from QDialog::minimumSizeHint().

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)

Reimplemented from QDialog::setVisible().

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

Reimplemented from QDialog::sizeHint().

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

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

See also options and setOption().

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