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

#include <qinputdialog.h>

Inheritance diagram for QInputDialog:

Collaboration diagram for QInputDialog:

Public Types
enum	InputDialogOption { NoButtons = 0x00000001 , UseListViewForComboBoxItems = 0x00000002 , UsePlainTextEditForTextInput = 0x00000004 }

enum	InputMode { TextInput , IntInput , DoubleInput }

Public Types inherited from QDialog
enum	DialogCode { Rejected , Accepted }
	The value returned by a modal dialog. More...

Public Types inherited from QWidget
enum	RenderFlag { DrawWindowBackground = 0x1 , DrawChildren = 0x2 , IgnoreMask = 0x4 }
	This enum describes how to render the widget when calling QWidget::render(). More...

Public Types inherited from QPaintDevice
enum	PaintDeviceMetric { PdmWidth = 1 , PdmHeight , PdmWidthMM , PdmHeightMM , PdmNumColors , PdmDepth , PdmDpiX , PdmDpiY , PdmPhysicalDpiX , PdmPhysicalDpiY , PdmDevicePixelRatio , PdmDevicePixelRatioScaled }

Public Slots
virtual void	open ()

Public Slots inherited from QDialog
virtual void	open ()

virtual int	exec ()
	Shows the dialog as a \l{QDialog::Modal Dialogs}{modal dialog}, blocking until the user closes it.

virtual void	accept ()
	Hides the modal dialog and sets the result code to `Accepted`.

virtual void	reject ()
	Hides the modal dialog and sets the result code to `Rejected`.

Public Slots inherited from QWidget
void	setEnabled (bool)

void	setDisabled (bool)
	Disables widget input events if disable is true; otherwise enables input events.

void	setWindowModified (bool)

void	setWindowTitle (const QString &)

void	setStyleSheet (const QString &styleSheet)

void	setFocus ()
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the \l{isActiveWindow()}{active window}.

void	update ()
	Updates the widget unless updates are disabled or the widget is hidden.

void	repaint ()
	Repaints the widget directly by calling paintEvent() immediately, unless updates are disabled or the widget is hidden.

void	setHidden (bool hidden)
	Convenience function, equivalent to setVisible(!hidden).

void	show ()
	Shows the widget and its child widgets.

void	hide ()
	Hides the widget.

void	showMinimized ()
	Shows the widget minimized, as an icon.

void	showMaximized ()
	Shows the widget maximized.

void	showFullScreen ()
	Shows the widget in full-screen mode.

void	showNormal ()
	Restores the widget after it has been maximized or minimized.

bool	close ()
	Closes this widget.

void	raise ()
	Raises this widget to the top of the parent widget's stack.

void	lower ()
	Lowers the widget to the bottom of the parent widget's stack.

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	textValueChanged (const QString &text)
	This signal is emitted whenever the text string changes in the dialog.

void	textValueSelected (const QString &text)
	This signal is emitted whenever the user selects a text string by accepting the dialog; for example, by clicking the \uicontrol{OK} button.

void	intValueChanged (int value)
	This signal is emitted whenever the integer value changes in the dialog.

void	intValueSelected (int value)
	This signal is emitted whenever the user selects a integer value by accepting the dialog; for example, by clicking the \uicontrol{OK} button.

void	doubleValueChanged (double value)
	This signal is emitted whenever the double value changes in the dialog.

void	doubleValueSelected (double value)
	This signal is emitted whenever the user selects a double value by accepting the dialog; for example, by clicking the \uicontrol{OK} button.

Signals inherited from QDialog
void	finished (int result)

void	accepted ()

void	rejected ()

Signals inherited from QWidget
void	windowTitleChanged (const QString &title)
	This signal is emitted when the window's title has changed, with the new title as an argument.

void	windowIconChanged (const QIcon &icon)
	This signal is emitted when the window's icon has changed, with the new icon as an argument.

void	windowIconTextChanged (const QString &iconText)
	This signal is emitted when the window's icon text has changed, with the new iconText as an argument.

void	customContextMenuRequested (const QPoint &pos)
	This signal is emitted when the widget's \l contextMenuPolicy is Qt::CustomContextMenu, and the user has requested a context menu on the widget.

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

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

	~QInputDialog ()

void	setInputMode (InputMode mode)

InputMode	inputMode () const
	the mode used for input

void	setLabelText (const QString &text)

QString	labelText () const
	the label's text which describes what needs to be input

void	setOption (InputDialogOption option, bool on=true)
	Sets the given option to be enabled if on is true; otherwise, clears the given option.

bool	testOption (InputDialogOption option) const
	Returns `true` if the given option is enabled; otherwise, returns false.

void	setOptions (InputDialogOptions options)

InputDialogOptions	options () const
	the various options that affect the look and feel of the dialog

void	setTextValue (const QString &text)

QString	textValue () const
	the text value for the input dialog

void	setTextEchoMode (QLineEdit::EchoMode mode)

QLineEdit::EchoMode	textEchoMode () const
	the echo mode for the text value

void	setComboBoxEditable (bool editable)

bool	isComboBoxEditable () const

void	setComboBoxItems (const QStringList &items)

QStringList	comboBoxItems () const
	the items used in the combo box for the input dialog

void	setIntValue (int value)

int	intValue () const
	the current integer value accepted as input

void	setIntMinimum (int min)

int	intMinimum () const
	the minimum integer value accepted as input

void	setIntMaximum (int max)

int	intMaximum () const
	the maximum integer value accepted as input

void	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	setIntStep (int step)

int	intStep () const
	the step by which the integer value is increased and decreased

void	setDoubleValue (double value)

double	doubleValue () const
	the current double precision floating point value accepted as input

void	setDoubleMinimum (double min)

double	doubleMinimum () const
	the minimum double precision floating point value accepted as input

void	setDoubleMaximum (double max)

double	doubleMaximum () const
	the maximum double precision floating point value accepted as input

void	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	setDoubleDecimals (int decimals)

int	doubleDecimals () const
	sets the precision of the double spinbox in decimals

void	setOkButtonText (const QString &text)

QString	okButtonText () const
	the text for the button used to accept the entry in the dialog

void	setCancelButtonText (const QString &text)

QString	cancelButtonText () const
	the text for the button used to cancel the dialog

void	open (QObject receiver, const char member)

QSize	minimumSizeHint () const override
	\reimp

QSize	sizeHint () const override
	\reimp

void	setVisible (bool visible) override
	\reimp

void	setDoubleStep (double step)

double	doubleStep () const
	the step by which the double value is increased and decreased

void	done (int result) override
	Closes the dialog and sets its result code to result.

Public Member Functions inherited from QDialog
	QDialog (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())
	Constructs a dialog with parent parent.

	~QDialog ()
	Destroys the QDialog, deleting all its children.

int	result () const
	In general returns the modal dialog's result code, `Accepted` or `Rejected`.

void	setSizeGripEnabled (bool)

bool	isSizeGripEnabled () const

void	setModal (bool modal)

void	setResult (int r)
	Sets the modal dialog's result code to i.

Public Member Functions inherited from QWidget
	QWidget (QWidget *parent=nullptr, Qt::WindowFlags f=Qt::WindowFlags())
	Constructs a widget which is a child of parent, with widget flags set to f.

	~QWidget ()
	Destroys the widget.

int	devType () const override

WId	winId () const
	Returns the window system identifier of the widget.

void	createWinId ()

WId	internalWinId () const

WId	effectiveWinId () const

QStyle *	style () const

void	setStyle (QStyle *)
	Sets the widget's GUI style to style.

bool	isWindow () const
	Returns `true` if the widget is an independent window, otherwise returns `false`.

bool	isModal () const

Qt::WindowModality	windowModality () const

void	setWindowModality (Qt::WindowModality windowModality)

bool	isEnabled () const

bool	isEnabledTo (const QWidget *) const
	Returns `true` if this widget would become enabled if ancestor is enabled; otherwise returns `false`.

QRect	frameGeometry () const

const QRect &	geometry () const

QRect	normalGeometry () const

int	x () const

int	y () const

QPoint	pos () const

QSize	frameSize () const

QSize	size () const

int	width () const

int	height () const

QRect	rect () const

QRect	childrenRect () const

QRegion	childrenRegion () const

QSize	minimumSize () const

QSize	maximumSize () const

int	minimumWidth () const

int	minimumHeight () const

int	maximumWidth () const

int	maximumHeight () const

void	setMinimumSize (const QSize &)

void	setMinimumSize (int minw, int minh)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function corresponds to setMinimumSize(QSize(minw, minh)).

void	setMaximumSize (const QSize &)

void	setMaximumSize (int maxw, int maxh)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function corresponds to setMaximumSize(QSize(maxw, maxh)).

void	setMinimumWidth (int minw)

void	setMinimumHeight (int minh)

void	setMaximumWidth (int maxw)

void	setMaximumHeight (int maxh)

QSize	sizeIncrement () const

void	setSizeIncrement (const QSize &)

void	setSizeIncrement (int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the x (width) size increment to w and the y (height) size increment to h.

QSize	baseSize () const

void	setBaseSize (const QSize &)

void	setBaseSize (int basew, int baseh)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to setBaseSize(QSize(basew, baseh)).

void	setFixedSize (const QSize &)
	Sets both the minimum and maximum sizes of the widget to s, thereby preventing it from ever growing or shrinking.

void	setFixedSize (int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the width of the widget to w and the height to h.

void	setFixedWidth (int w)
	Sets both the minimum and maximum width of the widget to w without changing the heights.

void	setFixedHeight (int h)
	Sets both the minimum and maximum heights of the widget to h without changing the widths.

QPointF	mapToGlobal (const QPointF &) const
	Translates the widget coordinate pos to global screen coordinates.

QPoint	mapToGlobal (const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QPointF	mapFromGlobal (const QPointF &) const
	Translates the global screen coordinate pos to widget coordinates.

QPoint	mapFromGlobal (const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QPointF	mapToParent (const QPointF &) const
	Translates the widget coordinate pos to a coordinate in the parent widget.

QPoint	mapToParent (const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QPointF	mapFromParent (const QPointF &) const
	Translates the parent widget coordinate pos to widget coordinates.

QPoint	mapFromParent (const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QPointF	mapTo (const QWidget *, const QPointF &) const
	Translates the widget coordinate pos to the coordinate system of parent.

QPoint	mapTo (const QWidget *, const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QPointF	mapFrom (const QWidget *, const QPointF &) const
	Translates the widget coordinate pos from the coordinate system of parent to this widget's coordinate system.

QPoint	mapFrom (const QWidget *, const QPoint &) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QWidget *	window () const
	Returns the window for this widget, i.e.

QWidget *	nativeParentWidget () const

QWidget *	topLevelWidget () const

const QPalette &	palette () const

void	setPalette (const QPalette &)

void	setBackgroundRole (QPalette::ColorRole)
	Sets the background role of the widget to role.

QPalette::ColorRole	backgroundRole () const
	Returns the background role of the widget.

void	setForegroundRole (QPalette::ColorRole)
	Sets the foreground role of the widget to role.

QPalette::ColorRole	foregroundRole () const
	Returns the foreground role.

const QFont &	font () const

void	setFont (const QFont &)

QFontMetrics	fontMetrics () const
	Returns the font metrics for the widget's current font.

QFontInfo	fontInfo () const
	Returns the font info for the widget's current font.

QCursor	cursor () const

void	setCursor (const QCursor &)

void	unsetCursor ()

void	setMouseTracking (bool enable)

bool	hasMouseTracking () const

bool	underMouse () const
	Returns `true` if the widget is under the mouse cursor; otherwise returns `false`.

void	setTabletTracking (bool enable)

bool	hasTabletTracking () const

void	setMask (const QBitmap &)
	Causes only the pixels of the widget for which bitmap has a corresponding 1 bit to be visible.

void	setMask (const QRegion &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Causes only the parts of the widget which overlap region to be visible.

QRegion	mask () const
	Returns the mask currently set on a widget.

void	clearMask ()
	Removes any mask set by setMask().

void	render (QPaintDevice *target, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground\|DrawChildren))

void	render (QPainter *painter, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground\|DrawChildren))
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Renders the widget into the painter's QPainter::device().

Q_INVOKABLE QPixmap	grab (const QRect &rectangle=QRect(QPoint(0, 0), QSize(-1, -1)))

void	grabGesture (Qt::GestureType type, Qt::GestureFlags flags=Qt::GestureFlags())
	Subscribes the widget to a given gesture with specific flags.

void	ungrabGesture (Qt::GestureType type)
	Unsubscribes the widget from a given gesture type.

QString	styleSheet () const

QString	windowTitle () const

void	setWindowIcon (const QIcon &icon)

QIcon	windowIcon () const

void	setWindowIconText (const QString &)

QString	windowIconText () const

void	setWindowRole (const QString &)
	Sets the window's role to role.

QString	windowRole () const
	Returns the window's role, or an empty string.

void	setWindowFilePath (const QString &filePath)

QString	windowFilePath () const

void	setWindowOpacity (qreal level)

qreal	windowOpacity () const

bool	isWindowModified () const

void	setLayoutDirection (Qt::LayoutDirection direction)

Qt::LayoutDirection	layoutDirection () const

void	unsetLayoutDirection ()

void	setLocale (const QLocale &locale)

QLocale	locale () const

void	unsetLocale ()

bool	isRightToLeft () const

bool	isLeftToRight () const

bool	isActiveWindow () const

void	activateWindow ()
	Sets the top-level widget containing this widget to be the active window.

void	clearFocus ()
	Takes keyboard input focus from the widget.

void	setFocus (Qt::FocusReason reason)
	Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the \l{isActiveWindow()}{active window}.

Qt::FocusPolicy	focusPolicy () const

void	setFocusPolicy (Qt::FocusPolicy policy)

bool	hasFocus () const

void	setFocusProxy (QWidget *)
	Sets the widget's focus proxy to widget w.

QWidget *	focusProxy () const
	Returns the focus proxy, or \nullptr if there is no focus proxy.

Qt::ContextMenuPolicy	contextMenuPolicy () const

void	setContextMenuPolicy (Qt::ContextMenuPolicy policy)

void	grabMouse ()
	Grabs the mouse input.

void	grabMouse (const QCursor &)

void	releaseMouse ()
	Releases the mouse grab.

void	grabKeyboard ()
	Grabs the keyboard input.

void	releaseKeyboard ()
	Releases the keyboard grab.

int	grabShortcut (const QKeySequence &key, Qt::ShortcutContext context=Qt::WindowShortcut)
	Adds a shortcut to Qt's shortcut system that watches for the given key sequence in the given context.

void	releaseShortcut (int id)
	Removes the shortcut with the given id from Qt's shortcut system.

void	setShortcutEnabled (int id, bool enable=true)
	If enable is true, the shortcut with the given id is enabled; otherwise the shortcut is disabled.

void	setShortcutAutoRepeat (int id, bool enable=true)

bool	updatesEnabled () const

void	setUpdatesEnabled (bool enable)

void	update (int x, int y, int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version updates a rectangle (x, y, w, h) inside the widget.

void	update (const QRect &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version updates a rectangle rect inside the widget.

void	update (const QRegion &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a region rgn inside the widget.

void	repaint (int x, int y, int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a rectangle (x, y, w, h) inside the widget.

void	repaint (const QRect &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a rectangle rect inside the widget.

void	repaint (const QRegion &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version repaints a region rgn inside the widget.

void	stackUnder (QWidget *)
	Places the widget under w in the parent widget's stack.

void	move (int x, int y)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to move(QPoint(x, y)).

void	move (const QPoint &)

void	resize (int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to resize(QSize(w, h)).

void	resize (const QSize &)

void	setGeometry (int x, int y, int w, int h)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to setGeometry(QRect(x, y, w, h)).

void	setGeometry (const QRect &)

QByteArray	saveGeometry () const

bool	restoreGeometry (const QByteArray &geometry)

void	adjustSize ()
	Adjusts the size of the widget to fit its contents.

bool	isVisible () const

bool	isVisibleTo (const QWidget *) const
	Returns `true` if this widget would become visible if ancestor is shown; otherwise returns `false`.

bool	isHidden () const
	Returns `true` if the widget is hidden, otherwise returns `false`.

bool	isMinimized () const

bool	isMaximized () const

bool	isFullScreen () const

Qt::WindowStates	windowState () const
	Returns the current window state.

void	setWindowState (Qt::WindowStates state)
	Sets the window state to windowState.

void	overrideWindowState (Qt::WindowStates state)

QSizePolicy	sizePolicy () const

void	setSizePolicy (QSizePolicy)

void	setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Sets the size policy of the widget to horizontal and vertical, with standard stretch and no height-for-width.

virtual int	heightForWidth (int) const
	Returns the preferred height for this widget, given the width w.

virtual bool	hasHeightForWidth () const

QRegion	visibleRegion () const
	Returns the unobscured region where paint events can occur.

void	setContentsMargins (int left, int top, int right, int bottom)
	Sets the margins around the contents of the widget to have the sizes left, top, right, and bottom.

void	setContentsMargins (const QMargins &margins)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QMargins	contentsMargins () const
	The contentsMargins function returns the widget's contents margins.

QRect	contentsRect () const
	Returns the area inside the widget's margins.

QLayout *	layout () const
	Returns the layout manager that is installed on this widget, or \nullptr if no layout manager is installed.

void	setLayout (QLayout *)
	Sets the layout manager for this widget to layout.

void	updateGeometry ()
	Notifies the layout system that this widget has changed and may need to change geometry.

void	setParent (QWidget *parent)
	Sets the parent of the widget to parent, and resets the window flags.

void	setParent (QWidget *parent, Qt::WindowFlags f)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This function also takes widget flags, f as an argument.

void	scroll (int dx, int dy)
	Scrolls the widget including its children dx pixels to the right and dy downward.

void	scroll (int dx, int dy, const QRect &)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This version only scrolls r and does not move the children of the widget.

QWidget *	focusWidget () const
	Returns the last child of this widget that setFocus had been called on.

QWidget *	nextInFocusChain () const
	Returns the next widget in this widget's focus chain.

QWidget *	previousInFocusChain () const
	The previousInFocusChain function returns the previous widget in this widget's focus chain.

bool	acceptDrops () const

void	setAcceptDrops (bool on)

void	addAction (QAction *action)
	Appends the action action to this widget's list of actions.

void	addActions (const QList< QAction * > &actions)
	Appends the actions actions to this widget's list of actions.

void	insertActions (QAction before, const QList< QAction > &actions)
	Inserts the actions actions to this widget's list of actions, before the action before.

void	insertAction (QAction before, QAction action)
	Inserts the action action to this widget's list of actions, before the action before.

void	removeAction (QAction *action)
	Removes the action action from this widget's list of actions.

QList< QAction * >	actions () const
	Returns the (possibly empty) list of this widget's actions.

QAction *	addAction (const QString &text)

QAction *	addAction (const QIcon &icon, const QString &text)

QAction *	addAction (const QString &text, const QObject receiver, const char member, Qt::ConnectionType type=Qt::AutoConnection)

QAction *	addAction (const QIcon &icon, const QString &text, const QObject receiver, const char member, Qt::ConnectionType type=Qt::AutoConnection)

template<typename... Args, typename = compatible_action_slot_args<Args...>>
QAction *	addAction (const QString &text, Args &&...args)

template<typename... Args, typename = compatible_action_slot_args<Args...>>
QAction *	addAction (const QIcon &icon, const QString &text, Args &&...args)

QWidget *	parentWidget () const
	Returns the parent of this widget, or \nullptr if it does not have any parent widget.

void	setWindowFlags (Qt::WindowFlags type)

Qt::WindowFlags	windowFlags () const
	Window flags are a combination of a type (e.g.

void	setWindowFlag (Qt::WindowType, bool on=true)

void	overrideWindowFlags (Qt::WindowFlags type)
	Sets the window flags for the widget to flags, without telling the window system.

Qt::WindowType	windowType () const
	Returns the window type of this widget.

QWidget *	childAt (int x, int y) const
	Returns the visible child widget at the position ({x}, {y}) in the widget's coordinate system.

QWidget *	childAt (const QPoint &p) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Returns the visible child widget at point p in the widget's own coordinate system.

void	setAttribute (Qt::WidgetAttribute, bool on=true)
	Sets the attribute attribute on this widget if on is true; otherwise clears the attribute.

bool	testAttribute (Qt::WidgetAttribute) const
	Returns `true` if attribute attribute is set on this widget; otherwise returns `false`.

QPaintEngine *	paintEngine () const override
	Returns the widget's paint engine.

void	ensurePolished () const
	Ensures that the widget and its children have been polished by QStyle (i.e., have a proper font and palette).

bool	isAncestorOf (const QWidget *child) const
	Returns `true` if this widget is a parent, (or grandparent and so on to any level), of the given child, and both widgets are within the same window; otherwise returns `false`.

bool	autoFillBackground () const

void	setAutoFillBackground (bool enabled)

QBackingStore *	backingStore () const

QWindow *	windowHandle () const
	If this is a native widget, return the associated QWindow.

QScreen *	screen () const
	Returns the screen the widget is on.

void	setScreen (QScreen *)
	Sets the screen on which the widget should be shown to screen.

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery) const
	This method is only relevant for input widgets.

Qt::InputMethodHints	inputMethodHints () const

void	setInputMethodHints (Qt::InputMethodHints hints)

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

bool	moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
	Changes the thread affinity for this object and its children and returns `true` on success.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

void	killTimer (Qt::TimerId id)

template<typename T >
T	findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T >
QList< T >	findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T >
T	findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

bool	setProperty (const char *name, QVariant &&value)

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Public Member Functions inherited from QPaintDevice
virtual	~QPaintDevice ()

bool	paintingActive () const

int	width () const

int	height () const

int	widthMM () const

int	heightMM () const

int	logicalDpiX () const

int	logicalDpiY () const

int	physicalDpiX () const

int	physicalDpiY () const

qreal	devicePixelRatio () const

qreal	devicePixelRatioF () const

int	colorCount () const

int	depth () const

Static Public Member Functions
static QString	getText (QWidget parent, const QString &title, const QString &label, QLineEdit::EchoMode echo=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.

static QString	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 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::WindowFlags(), Qt::InputMethodHints inputMethodHints=Qt::ImhNone)
	Static convenience function to let the user select an item from a string list.

static int	getInt (QWidget parent, const QString &title, const QString &label, int value=0, int minValue=-2147483647, int maxValue=2147483647, int step=1, bool ok=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())

static double	getDouble (QWidget parent, const QString &title, const QString &label, double value=0, double minValue=-2147483647, double maxValue=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.

Static Public Member Functions inherited from QWidget
static void	setTabOrder (QWidget , QWidget )
	Puts the second widget after the first widget in the focus order.

static void	setTabOrder (std::initializer_list< QWidget * > widgets)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

static QWidget *	mouseGrabber ()
	Returns the widget that is currently grabbing the mouse input.

static QWidget *	keyboardGrabber ()
	Returns the widget that is currently grabbing the keyboard input.

static QWidget *	find (WId)
	Returns a pointer to the widget with window identifier/handle id.

static QWidget *	createWindowContainer (QWindow window, QWidget parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags())
	Creates a QWidget that makes it possible to embed window into a QWidget-based application.

Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Static Public Member Functions inherited from QPaintDevice
static qreal	devicePixelRatioFScale ()

Additional Inherited Members
Protected Slots inherited from QWidget
void	updateMicroFocus (Qt::InputMethodQuery query=Qt::ImQueryAll)
	Updates the widget's micro focus and informs input methods that the state specified by query has changed.

Protected Member Functions inherited from QDialog
	QDialog (QDialogPrivate &, QWidget *parent, Qt::WindowFlags f=Qt::WindowFlags())
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

void	keyPressEvent (QKeyEvent *) override
	\reimp

void	closeEvent (QCloseEvent *) override
	\reimp

void	showEvent (QShowEvent *) override
	\reimp

void	resizeEvent (QResizeEvent *) override
	\reimp

void	contextMenuEvent (QContextMenuEvent *) override
	\reimp

bool	eventFilter (QObject , QEvent ) override
	\reimp

void	adjustPosition (QWidget *)

Protected Member Functions inherited from QWidget
bool	event (QEvent *event) override
	This is the main event handler; it handles event event.

virtual void	mousePressEvent (QMouseEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive mouse press events for the widget.

virtual void	mouseReleaseEvent (QMouseEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive mouse release events for the widget.

virtual void	mouseDoubleClickEvent (QMouseEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive mouse double click events for the widget.

virtual void	mouseMoveEvent (QMouseEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive mouse move events for the widget.

virtual void	keyReleaseEvent (QKeyEvent *event)
	This event handler, for event event, can be reimplemented in a subclass to receive key release events for the widget.

virtual void	focusInEvent (QFocusEvent *event)
	This event handler can be reimplemented in a subclass to receive keyboard focus events (focus received) for the widget.

virtual void	focusOutEvent (QFocusEvent *event)
	This event handler can be reimplemented in a subclass to receive keyboard focus events (focus lost) for the widget.

virtual void	enterEvent (QEnterEvent *event)
	This event handler can be reimplemented in a subclass to receive widget enter events which are passed in the event parameter.

virtual void	leaveEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive widget leave events which are passed in the event parameter.

virtual void	paintEvent (QPaintEvent *event)
	This event handler can be reimplemented in a subclass to receive paint events passed in event.

virtual void	moveEvent (QMoveEvent *event)
	This event handler can be reimplemented in a subclass to receive widget move events which are passed in the event parameter.

virtual void	actionEvent (QActionEvent *event)
	This event handler is called with the given event whenever the widget's actions are changed.

virtual void	hideEvent (QHideEvent *event)
	This event handler can be reimplemented in a subclass to receive widget hide events.

virtual bool	nativeEvent (const QByteArray &eventType, void message, qintptr result)
	This special event handler can be reimplemented in a subclass to receive native platform events identified by eventType which are passed in the message parameter.

virtual void	changeEvent (QEvent *)
	This event handler can be reimplemented to handle state changes.

int	metric (PaintDeviceMetric) const override
	Internal implementation of the virtual QPaintDevice::metric() function.

void	initPainter (QPainter *painter) const override
	Initializes the painter pen, background and font to the same as the given widget's.

QPaintDevice *	redirected (QPoint *offset) const override

QPainter *	sharedPainter () const override

virtual void	inputMethodEvent (QInputMethodEvent *)
	This event handler, for event event, can be reimplemented in a subclass to receive Input Method composition events.

void	create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true)
	Creates a new widget window.

void	destroy (bool destroyWindow=true, bool destroySubWindows=true)
	Frees up window system resources.

virtual bool	focusNextPrevChild (bool next)
	Finds a new widget to give the keyboard focus to, as appropriate for Tab and Shift+Tab, and returns `true` if it can find a new widget, or false if it can't.

bool	focusNextChild ()
	Finds a new widget to give the keyboard focus to, as appropriate for \uicontrol Tab, and returns `true` if it can find a new widget, or false if it can't.

bool	focusPreviousChild ()
	Finds a new widget to give the keyboard focus to, as appropriate for \uicontrol Shift+Tab, and returns `true` if it can find a new widget, or false if it can't.

	QWidget (QWidgetPrivate &d, QWidget *parent, Qt::WindowFlags f)

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Protected Member Functions inherited from QPaintDevice
	QPaintDevice () noexcept

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Protected Attributes inherited from QPaintDevice
ushort	painters

Properties inherited from QDialog
bool	sizeGripEnabled
	whether the size grip is enabled

bool	modal
	whether show() should pop up the dialog as modal or modeless

Properties inherited from QWidget
bool	modal
	whether the widget is a modal widget

Qt::WindowModality	windowModality
	which windows are blocked by the modal widget

bool	enabled
	whether the widget is enabled

QRect	geometry
	the geometry of the widget relative to its parent and excluding the window frame

QRect	frameGeometry
	geometry of the widget relative to its parent including any window frame

QRect	normalGeometry
	the geometry of the widget as it will appear when shown as a normal (not maximized or full screen) top-level widget

int	x
	the x coordinate of the widget relative to its parent including any window frame

int	y
	the y coordinate of the widget relative to its parent and including any window frame

QPoint	pos
	the position of the widget within its parent widget

QSize	frameSize
	the size of the widget including any window frame

QSize	size
	the size of the widget excluding any window frame

int	width
	the width of the widget excluding any window frame

int	height
	the height of the widget excluding any window frame

QRect	rect
	the internal geometry of the widget excluding any window frame

QRect	childrenRect
	the bounding rectangle of the widget's children

QRegion	childrenRegion
	the combined region occupied by the widget's children

QSizePolicy	sizePolicy
	the default layout behavior of the widget

QSize	minimumSize
	the widget's minimum size

QSize	maximumSize
	the widget's maximum size in pixels

int	minimumWidth
	the widget's minimum width in pixels

int	minimumHeight
	the widget's minimum height in pixels

int	maximumWidth
	the widget's maximum width in pixels

int	maximumHeight
	the widget's maximum height in pixels

QSize	sizeIncrement
	the size increment of the widget

QSize	baseSize
	the base size of the widget

QPalette	palette
	the widget's palette

QFont	font
	the font currently set for the widget

QCursor	cursor
	the cursor shape for this widget

bool	mouseTracking
	whether mouse tracking is enabled for the widget

bool	tabletTracking
	whether tablet tracking is enabled for the widget

bool	isActiveWindow
	whether this widget's window is the active window

Qt::FocusPolicy	focusPolicy
	the way the widget accepts keyboard focus

bool	focus
	whether this widget (or its focus proxy) has the keyboard input focus

Qt::ContextMenuPolicy	contextMenuPolicy
	how the widget shows a context menu

bool	updatesEnabled
	whether updates are enabled

bool	visible
	whether the widget is visible

bool	minimized
	whether this widget is minimized (iconified)

bool	maximized
	whether this widget is maximized

bool	fullScreen
	whether the widget is shown in full screen mode

QSize	sizeHint
	the recommended size for the widget

QSize	minimumSizeHint
	the recommended minimum size for the widget

bool	acceptDrops
	whether drop events are enabled for this widget

QString	windowTitle
	the window title (caption)

QIcon	windowIcon
	the widget's icon

QString	windowIconText
	the text to be displayed on the icon of a minimized window

double	windowOpacity
	The level of opacity for the window.

bool	windowModified
	whether the document shown in the window has unsaved changes

Qt::LayoutDirection	layoutDirection
	the layout direction for this widget.

bool	autoFillBackground
	whether the widget background is filled automatically

QString	styleSheet
	the widget's style sheet

QLocale	locale
	the widget's locale

QString	windowFilePath
	the file path associated with a widget

Qt::InputMethodHints	inputMethodHints
	What input method specific hints the widget has.

Properties inherited from QObject
QString	objectName
	the name of this object

Related Symbols inherited from QWidget
	setupUi (QWidget *widget)
	\macro QWIDGETSIZE_MAX

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

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

\inmodule QtWidgets

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:

The ok variable is set to true if the user clicks \uicontrol OK; otherwise, it is set to false.

Input Dialogs

The \l{dialogs/standarddialogs}{Standard Dialogs} example shows how to use QInputDialog as well as other built-in Qt dialogs.

See also: QMessageBox, {Standard Dialogs Example}

Definition at line 19 of file qinputdialog.h.

Member Enumeration Documentation

◆ InputDialogOption

enum QInputDialog::InputDialogOption

Since: 4.5

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

\value NoButtons Don't display \uicontrol{OK} and \uicontrol{Cancel} buttons (useful for "live dialogs"). \value UseListViewForComboBoxItems Use a QListView rather than a non-editable QComboBox for displaying the items set with setComboBoxItems(). \value UsePlainTextEditForTextInput Use a QPlainTextEdit for multiline text input. This value was introduced in 5.2.

See also: options, setOption(), testOption()

Enumerator
NoButtons
UseListViewForComboBoxItems
UsePlainTextEditForTextInput

Definition at line 43 of file qinputdialog.h.

◆ InputMode

enum QInputDialog::InputMode

Since: 4.5

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

\value TextInput Used to input text strings. \value IntInput Used to input integers. \value DoubleInput Used to input floating point numbers with double precision accuracy.

See also: inputMode

Enumerator
TextInput
IntInput
DoubleInput

Definition at line 51 of file qinputdialog.h.

Constructor & Destructor Documentation

◆ QInputDialog()

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

Since: 4.5

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

Definition at line 492 of file qinputdialog.cpp.

Referenced by getDouble(), getInt(), getItem(), getMultiLineText(), and getText().

Here is the caller graph for this function:

◆ ~QInputDialog()

QInputDialog::~QInputDialog ( )

Since: 4.5

Destroys the input dialog.

Definition at line 502 of file qinputdialog.cpp.

Member Function Documentation

◆ cancelButtonText()

QString QInputDialog::cancelButtonText ( ) const

the text for the button used to cancel the dialog

Since: 4.5

Definition at line 1040 of file qinputdialog.cpp.

References QDialogButtonBox::Cancel, and d.

◆ comboBoxItems()

QStringList QInputDialog::comboBoxItems ( ) const

the items used in the combo box for the input dialog

Since: 4.5

Definition at line 768 of file qinputdialog.cpp.

References d, i, and QDialog::result().

Here is the call graph for this function:

◆ done()

void QInputDialog::done ( int result )

overridevirtual

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

Reimplemented from QDialog.

Definition at line 1121 of file qinputdialog.cpp.

References d, disconnect(), QDialog::done(), DoubleInput, doubleValue(), doubleValueSelected(), emit, inputMode(), IntInput, intValue(), intValueSelected(), Q_ASSERT, signalForMember(), TextInput, textValue(), and textValueSelected().

Here is the call graph for this function:

◆ doubleDecimals()

int QInputDialog::doubleDecimals ( ) const

sets the precision of the double spinbox in decimals

Since: 4.5

See also: QDoubleSpinBox::setDecimals()

Definition at line 996 of file qinputdialog.cpp.

References d.

◆ doubleMaximum()

double QInputDialog::doubleMaximum ( ) const

the maximum double precision floating point value accepted as input

Since: 4.5

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

Definition at line 958 of file qinputdialog.cpp.

References d.

◆ doubleMinimum()

double QInputDialog::doubleMinimum ( ) const

the minimum double precision floating point value accepted as input

Since: 4.5

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

Definition at line 933 of file qinputdialog.cpp.

References d.

◆ doubleStep()

double QInputDialog::doubleStep ( ) const

the step by which the double value is increased and decreased

Since: 5.10

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

Definition at line 1407 of file qinputdialog.cpp.

References d.

◆ doubleValue()

double QInputDialog::doubleValue ( ) const

the current double precision floating point value accepted as input

Since: 4.5

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

Definition at line 908 of file qinputdialog.cpp.

References d.

Referenced by done().

Here is the caller graph for this function:

◆ doubleValueChanged

void QInputDialog::doubleValueChanged ( double value )

signal

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.

Referenced by QInputDialogPrivate::ensureDoubleSpinBox().

Here is the caller graph for this function:

◆ doubleValueSelected

void QInputDialog::doubleValueSelected ( double value )

signal

This signal is emitted whenever the user selects a double value by accepting the dialog; for example, by clicking the \uicontrol{OK} button.

The selected value is specified by value.

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

Referenced by done().

Here is the caller graph for this function:

◆ getDouble()

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

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 \uicontrol OK and to false if the user pressed \uicontrol 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:

See also: getText(), getInt(), getItem(), getMultiLineText()

Definition at line 1316 of file qinputdialog.cpp.

References QInputDialog(), dialog, QDialog::exec(), ok, QObject::parent(), ret, QFileDialog::setLabelText(), QWidget::setWindowTitle(), and title.

Here is the call graph for this function:

◆ getInt()

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

Since: 4.5

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 \uicontrol OK and to false if the user pressed \uicontrol 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:

See also: getText(), getDouble(), getItem(), getMultiLineText()

Definition at line 1269 of file qinputdialog.cpp.

References QInputDialog(), dialog, QDialog::exec(), ok, QObject::parent(), ret, QFileDialog::setLabelText(), QWidget::setWindowTitle(), and title.

Here is the call graph for this function:

◆ getItem()

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

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 \uicontrol OK and to false if the user pressed \uicontrol 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:

See also: getText(), getInt(), getDouble(), getMultiLineText()

Definition at line 1367 of file qinputdialog.cpp.

References QInputDialog(), dialog, QDialog::exec(), QWidget::inputMethodHints, items, ok, QObject::parent(), ret, QWidget::setInputMethodHints(), QFileDialog::setLabelText(), QWidget::setWindowTitle(), text, title, and QList< T >::value().

Here is the call graph for this function:

◆ getMultiLineText()

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

Since: 5.2

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 \uicontrol OK and to false if the user pressed \uicontrol 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:

See also: getInt(), getDouble(), getItem(), getText()

Definition at line 1221 of file qinputdialog.cpp.

References QInputDialog(), dialog, QDialog::exec(), QWidget::inputMethodHints, ok, QObject::parent(), ret, QWidget::setInputMethodHints(), QFileDialog::setLabelText(), QFileDialog::setOptions(), QWidget::setWindowTitle(), text, title, and UsePlainTextEditForTextInput.

Here is the call graph for this function:

◆ getText()

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

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 \uicontrol OK and to false if the user pressed \uicontrol 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:

See also: getInt(), getDouble(), getItem(), getMultiLineText()

Definition at line 1173 of file qinputdialog.cpp.

References QInputDialog(), dialog, QDialog::exec(), QWidget::inputMethodHints, ok, QObject::parent(), ret, QWidget::setInputMethodHints(), QFileDialog::setLabelText(), QWidget::setWindowTitle(), text, and title.

Here is the call graph for this function:

◆ inputMode()

QInputDialog::InputMode QInputDialog::inputMode ( ) const

the mode used for input

Since: 4.5

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

Definition at line 546 of file qinputdialog.cpp.

References d, DoubleInput, IntInput, and TextInput.

Referenced by done(), setComboBoxEditable(), setComboBoxItems(), and setOptions().

Here is the caller graph for this function:

◆ intMaximum()

int QInputDialog::intMaximum ( ) const

the maximum integer value accepted as input

Since: 4.5

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

Definition at line 846 of file qinputdialog.cpp.

References d.

◆ intMinimum()

int QInputDialog::intMinimum ( ) const

the minimum integer value accepted as input

Since: 4.5

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

Definition at line 821 of file qinputdialog.cpp.

References d.

◆ intStep()

int QInputDialog::intStep ( ) const

the step by which the integer value is increased and decreased

Since: 4.5

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

Definition at line 883 of file qinputdialog.cpp.

References d.

◆ intValue()

int QInputDialog::intValue ( ) const

the current integer value accepted as input

Since: 4.5

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

Definition at line 796 of file qinputdialog.cpp.

References d.

Referenced by done().

Here is the caller graph for this function:

◆ intValueChanged

void QInputDialog::intValueChanged ( int value )

signal

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.

Referenced by QInputDialogPrivate::ensureIntSpinBox().

Here is the caller graph for this function:

◆ intValueSelected

void QInputDialog::intValueSelected ( int value )

signal

This signal is emitted whenever the user selects a integer value by accepting the dialog; for example, by clicking the \uicontrol{OK} button.

The selected value is specified by value.

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

Referenced by done().

Here is the caller graph for this function:

◆ isComboBoxEditable()

bool QInputDialog::isComboBoxEditable ( ) const

Definition at line 736 of file qinputdialog.cpp.

References d.

◆ labelText()

QString QInputDialog::labelText ( ) const

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

Since: 4.5

Definition at line 578 of file qinputdialog.cpp.

References d.

◆ minimumSizeHint()

QSize QInputDialog::minimumSizeHint ( ) const

overridevirtual

\reimp

Reimplemented from QDialog.

Definition at line 1075 of file qinputdialog.cpp.

References d, and QDialog::minimumSizeHint().

Here is the call graph for this function:

◆ okButtonText()

QString QInputDialog::okButtonText ( ) const

the text for the button used to accept the entry in the dialog

Since: 4.5

Definition at line 1020 of file qinputdialog.cpp.

References d, and QDialogButtonBox::Ok.

◆ open [1/2]

void QDialog::open ( )

slot

Since: 4.5

Shows the dialog as a \l{QDialog::Modal Dialogs}{window modal dialog}, returning immediately.

See also: exec(), show(), result(), setWindowModality()

Definition at line 52 of file qdialog.cpp.

◆ open() [2/2]

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

Since: 4.5

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:

\list

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. \endlist

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

Definition at line 1063 of file qinputdialog.cpp.

References QObject::connect(), d, QDialog::open(), and signalForMember().

Here is the call graph for this function:

◆ options()

QInputDialog::InputDialogOptions QInputDialog::options ( ) const

the various options that affect the look and feel of the dialog

Since: 4.5

By default, all options are disabled.

See also: setOption(), testOption()

Definition at line 655 of file qinputdialog.cpp.

References d.

Referenced by setOptions().

Here is the caller graph for this function:

◆ setCancelButtonText()

void QInputDialog::setCancelButtonText ( const QString & text )

Definition at line 1033 of file qinputdialog.cpp.

References QDialogButtonBox::Cancel, d, and text.

◆ setComboBoxEditable()

void QInputDialog::setComboBoxEditable ( bool editable )

Definition at line 727 of file qinputdialog.cpp.

References d, inputMode(), and TextInput.

Here is the call graph for this function:

◆ setComboBoxItems()

void QInputDialog::setComboBoxItems ( const QStringList & items )

Definition at line 753 of file qinputdialog.cpp.

References d, inputMode(), items, and TextInput.

Here is the call graph for this function:

◆ setDoubleDecimals()

void QInputDialog::setDoubleDecimals ( int decimals )

Definition at line 989 of file qinputdialog.cpp.

References d.

◆ setDoubleMaximum()

void QInputDialog::setDoubleMaximum ( double max )

Definition at line 951 of file qinputdialog.cpp.

References d.

◆ setDoubleMinimum()

void QInputDialog::setDoubleMinimum ( double min )

Definition at line 926 of file qinputdialog.cpp.

References d.

◆ setDoubleRange()

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.

Definition at line 973 of file qinputdialog.cpp.

References d.

◆ setDoubleStep()

void QInputDialog::setDoubleStep ( double step )

Definition at line 1400 of file qinputdialog.cpp.

References d.

◆ setDoubleValue()

void QInputDialog::setDoubleValue ( double value )

Definition at line 901 of file qinputdialog.cpp.

References d, DoubleInput, and setInputMode().

Here is the call graph for this function:

◆ setInputMode()

void QInputDialog::setInputMode ( InputMode mode )

Definition at line 516 of file qinputdialog.cpp.

References d, DoubleInput, IntInput, Q_ASSERT, TextInput, and widget.

Referenced by setDoubleValue(), setIntValue(), and setTextValue().

Here is the caller graph for this function:

◆ setIntMaximum()

void QInputDialog::setIntMaximum ( int max )

Definition at line 839 of file qinputdialog.cpp.

References d.

◆ setIntMinimum()

void QInputDialog::setIntMinimum ( int min )

Definition at line 814 of file qinputdialog.cpp.

References d.

◆ setIntRange()

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.

Definition at line 861 of file qinputdialog.cpp.

References d.

◆ setIntStep()

void QInputDialog::setIntStep ( int step )

Definition at line 876 of file qinputdialog.cpp.

References d.

◆ setIntValue()

void QInputDialog::setIntValue ( int value )

Definition at line 789 of file qinputdialog.cpp.

References d, IntInput, and setInputMode().

Here is the call graph for this function:

◆ setLabelText()

void QInputDialog::setLabelText ( const QString & text )

Definition at line 568 of file qinputdialog.cpp.

References d, and text.

◆ setOkButtonText()

void QInputDialog::setOkButtonText ( const QString & text )

Definition at line 1013 of file qinputdialog.cpp.

References d, QDialogButtonBox::Ok, and text.

◆ setOption()

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

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

See also: options, testOption()

Definition at line 608 of file qinputdialog.cpp.

References d, and setOptions().

Here is the call graph for this function:

◆ setOptions()

void QInputDialog::setOptions ( InputDialogOptions options )

Definition at line 636 of file qinputdialog.cpp.

References d, inputMode(), NoButtons, options(), TextInput, UseListViewForComboBoxItems, and UsePlainTextEditForTextInput.

Referenced by setOption().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTextEchoMode()

void QInputDialog::setTextEchoMode ( QLineEdit::EchoMode mode )

Definition at line 703 of file qinputdialog.cpp.

References d.

◆ setTextValue()

void QInputDialog::setTextValue ( const QString & text )

Definition at line 671 of file qinputdialog.cpp.

References d, setInputMode(), text, and TextInput.

Here is the call graph for this function:

◆ setVisible()

void QInputDialog::setVisible ( bool visible )

overridevirtual

\reimp

Reimplemented from QDialog.

Definition at line 1095 of file qinputdialog.cpp.

References d, QDialog::setVisible(), and QWidget::visible.

Here is the call graph for this function:

◆ sizeHint()

QSize QInputDialog::sizeHint ( ) const

overridevirtual

\reimp

Reimplemented from QDialog.

Definition at line 1085 of file qinputdialog.cpp.

References d, and QDialog::sizeHint().

Here is the call graph for this function:

◆ testOption()

bool QInputDialog::testOption ( InputDialogOption option ) const

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

See also: options, setOption()

Definition at line 621 of file qinputdialog.cpp.

References d.

◆ textEchoMode()

QLineEdit::EchoMode QInputDialog::textEchoMode ( ) const

the echo mode for the text value

Since: 4.5

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

Definition at line 710 of file qinputdialog.cpp.

References d, and QLineEdit::Normal.

◆ textValue()

QString QInputDialog::textValue ( ) const

the text value for the input dialog

Since: 4.5

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

Definition at line 687 of file qinputdialog.cpp.

References d.

Referenced by done().

Here is the caller graph for this function:

◆ textValueChanged

void QInputDialog::textValueChanged ( const QString & text )

signal

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.

◆ textValueSelected

void QInputDialog::textValueSelected ( const QString & text )

signal

This signal is emitted whenever the user selects a text string by accepting the dialog; for example, by clicking the \uicontrol{OK} button.

The selected string is specified by text.

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

Referenced by done().

Here is the caller graph for this function:

The documentation for this class was generated from the following files:

qtbase/src/widgets/dialogs/qinputdialog.h (4fdcb1212d1a67d2e4b5aed28095e22e609d530a)
qtbase/src/widgets/dialogs/qinputdialog.cpp (4fdcb1212d1a67d2e4b5aed28095e22e609d530a)

Public Types

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ InputDialogOption

◆ InputMode

Constructor & Destructor Documentation

◆ QInputDialog()

◆ ~QInputDialog()

Member Function Documentation

◆ cancelButtonText()

◆ comboBoxItems()

◆ done()

◆ doubleDecimals()

◆ doubleMaximum()

◆ doubleMinimum()

◆ doubleStep()

◆ doubleValue()

◆ doubleValueChanged

◆ doubleValueSelected

◆ getDouble()

◆ getInt()

◆ getItem()

◆ getMultiLineText()

◆ getText()

◆ inputMode()

◆ intMaximum()

◆ intMinimum()

◆ intStep()

◆ intValue()

◆ intValueChanged

◆ intValueSelected

◆ isComboBoxEditable()

◆ labelText()

◆ minimumSizeHint()

◆ okButtonText()

◆ open [1/2]

◆ open() [2/2]

◆ options()

◆ setCancelButtonText()

◆ setComboBoxEditable()

◆ setComboBoxItems()

◆ setDoubleDecimals()

◆ setDoubleMaximum()

◆ setDoubleMinimum()

◆ setDoubleRange()

◆ setDoubleStep()

◆ setDoubleValue()

◆ setInputMode()

◆ setIntMaximum()

◆ setIntMinimum()

◆ setIntRange()

◆ setIntStep()

◆ setIntValue()

◆ setLabelText()

◆ setOkButtonText()

◆ setOption()

◆ setOptions()

◆ setTextEchoMode()

◆ setTextValue()

◆ setVisible()

◆ sizeHint()

◆ testOption()

◆ textEchoMode()

◆ textValue()

◆ textValueChanged

◆ textValueSelected