~oif-team/ubuntu/natty/qt4-x11/xi2.1

<td width="1">  </td><td class="postheader" valign="center"><a href="index.html">Home</a> · <a href="classes.html">All Classes</a> · <a href="mainclasses.html">Main Classes</a> · <a href="annotated.html">Annotated</a> · <a href="groups.html">Grouped Classes</a> · <a href="functions.html">Functions</a></td>

<td align="right" valign="top" width="230"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></td></tr></table><h1 align="center">QInputDialog Class Reference</h1>

The QInputDialog class provides a simple convenience dialog to get a single value from the user. <a href="#details">More...</a>

<pre>#include <QInputDialog></pre>Part of the <a href="qtgui.html">QtGui</a> module.

Inherits <a href="qdialog.html">QDialog</a>.

<ul>

<li><a href="qinputdialog-members.html">List of all members, including inherited members</a></li>

<li><a href="qinputdialog-qt3.html">Qt 3 support members</a></li>

</ul>

<h3>Static Public Members</h3>

<ul>

<li><div class="fn"/>double <a href="qinputdialog.html#getDouble">getDouble</a> ( QWidget * parent, const QString & title, const QString & label, double value = 0, double minValue = -2147483647, double maxValue = 2147483647, int decimals = 1, bool * ok = 0, Qt::WFlags f = 0 )</li>

<li><div class="fn"/>int <a href="qinputdialog.html#getInteger">getInteger</a> ( QWidget * parent, const QString & title, const QString & label, int value = 0, int minValue = -2147483647, int maxValue = 2147483647, int step = 1, bool * ok = 0, Qt::WFlags f = 0 )</li>

<li><div class="fn"/>QString <a href="qinputdialog.html#getItem">getItem</a> ( QWidget * parent, const QString & title, const QString & label, const QStringList & list, int current = 0, bool editable = true, bool * ok = 0, Qt::WFlags f = 0 )</li>

<li><div class="fn"/>QString <a href="qinputdialog.html#getText">getText</a> ( QWidget * parent, const QString & title, const QString & label, QLineEdit::EchoMode mode = QLineEdit::Normal, const QString & text = QString(), bool * ok = 0, Qt::WFlags f = 0 )</li>

</ul>

<ul>

<li><div class="fn"/>4 static public members inherited from <a href="qwidget.html#static-public-members">QWidget</a></li>

<li><div class="fn"/>4 static public members inherited from <a href="qobject.html#static-public-members">QObject</a></li>

</ul>

<h3>Additional Inherited Members</h3>

<ul>

<li><div class="fn"/>2 properties inherited from <a href="qdialog.html#properties">QDialog</a></li>

<li><div class="fn"/>52 properties inherited from <a href="qwidget.html#properties">QWidget</a></li>

<li><div class="fn"/>1 property inherited from <a href="qobject.html#properties">QObject</a></li>

<li><div class="fn"/>9 public functions inherited from <a href="qdialog.html#public-functions">QDialog</a></li>

<li><div class="fn"/>183 public functions inherited from <a href="qwidget.html#public-functions">QWidget</a></li>

<li><div class="fn"/>28 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>

<li><div class="fn"/>10 public functions inherited from <a href="qpaintdevice.html#public-functions">QPaintDevice</a></li>

<li><div class="fn"/>5 public slots inherited from <a href="qdialog.html#public-slots">QDialog</a></li>

<li><div class="fn"/>17 public slots inherited from <a href="qwidget.html#public-slots">QWidget</a></li>

<li><div class="fn"/>1 public slot inherited from <a href="qobject.html#public-slots">QObject</a></li>

<li><div class="fn"/>1 signal inherited from <a href="qwidget.html#signals">QWidget</a></li>

<li><div class="fn"/>1 signal inherited from <a href="qobject.html#signals">QObject</a></li>

<li><div class="fn"/>39 protected functions inherited from <a href="qwidget.html#protected-functions">QWidget</a></li>

<li><div class="fn"/>7 protected functions inherited from <a href="qobject.html#protected-functions">QObject</a></li>

</ul>

<hr />

<h2>Detailed Description</h2>

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.

Four static convenience functions are provided: <a href="qinputdialog.html#getText">getText</a>(), <a href="qinputdialog.html#getInteger">getInteger</a>(), <a href="qinputdialog.html#getDouble">getDouble</a>() and <a href="qinputdialog.html#getItem">getItem</a>(). All the functions can be used in a similar way, for example:

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

The <tt>ok</tt> variable is set to true if the user clicks OK; otherwise it is set to false.

<center><img src="images/inputdialogs.png" alt="Input Dialogs" /></center>The <a href="dialogs-standarddialogs.html">Standard Dialogs</a> example shows how to use QInputDialog as well as other built-in Qt dialogs.

See also <a href="qmessagebox.html">QMessageBox</a>.

<hr />

<h2>Member Function Documentation</h2>

<h3 class="fn"><a name="getDouble"></a>double QInputDialog::getDouble ( <a href="qwidget.html">QWidget</a> * parent, const <a href="qstring.html">QString</a> & title, const <a href="qstring.html">QString</a> & label, double value = 0, double minValue = -2147483647, double maxValue = 2147483647, int decimals = 1, bool * ok = 0, <a href="qt.html#WFlags-typedef">Qt::WFlags</a> f = 0 )  <tt> [static]</tt></h3>

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. minValue and maxValue are the minimum and maximum values the user may choose, and decimals is the maximum number of decimal places the number may have.

If ok is non-null, *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 f.

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

Use this static function like this:

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

See also <a href="qinputdialog.html#getText">getText</a>(), <a href="qinputdialog.html#getInteger">getInteger</a>(), and <a href="qinputdialog.html#getItem">getItem</a>().

<h3 class="fn"><a name="getInteger"></a>int QInputDialog::getInteger ( <a href="qwidget.html">QWidget</a> * parent, const <a href="qstring.html">QString</a> & title, const <a href="qstring.html">QString</a> & label, int value = 0, int minValue = -2147483647, int maxValue = 2147483647, int step = 1, bool * ok = 0, <a href="qt.html#WFlags-typedef">Qt::WFlags</a> f = 0 )  <tt> [static]</tt></h3>

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. minValue and maxValue are the minimum and maximum values the user may choose, and 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 non-null *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 f.

This function returns the integer which has been entered by the user.

Use this static function like this:

<pre>  bool ok;

int i = QInputDialog::getInteger(this, tr("QInputDialog::getInteger()"),

tr("Percentage:"), 25, 0, 100, 1, &ok);

if (ok)

integerLabel->setText(tr("%1%").arg(i));</pre>

See also <a href="qinputdialog.html#getText">getText</a>(), <a href="qinputdialog.html#getDouble">getDouble</a>(), and <a href="qinputdialog.html#getItem">getItem</a>().

<h3 class="fn"><a name="getItem"></a><a href="qstring.html">QString</a> QInputDialog::getItem ( <a href="qwidget.html">QWidget</a> * parent, const <a href="qstring.html">QString</a> & title, const <a href="qstring.html">QString</a> & label, const <a href="qstringlist.html">QStringList</a> & list, int current = 0, bool editable = true, bool * ok = 0, <a href="qt.html#WFlags-typedef">Qt::WFlags</a> f = 0 )  <tt> [static]</tt></h3>

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). list is the string list which is inserted into the combobox, and current is the number of the item which should be the current item. If editable is true the user can enter their own text; if editable is false the user may only select one of the existing items.

If ok is non-null *a 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 f.

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

100

Use this static function like this:

101

<pre>  QStringList items;

102

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

103

104

bool ok;

105

QString item = QInputDialog::getItem(this, tr("QInputDialog::getItem()"),

106

tr("Season:"), items, 0, false, &ok);

107

if (ok && !item.isEmpty())

108

itemLabel->setText(item);</pre>

109

See also <a href="qinputdialog.html#getText">getText</a>(), <a href="qinputdialog.html#getInteger">getInteger</a>(), and <a href="qinputdialog.html#getDouble">getDouble</a>().

110

<h3 class="fn"><a name="getText"></a><a href="qstring.html">QString</a> QInputDialog::getText ( <a href="qwidget.html">QWidget</a> * parent, const <a href="qstring.html">QString</a> & title, const <a href="qstring.html">QString</a> & label, <a href="qlineedit.html#EchoMode-enum">QLineEdit::EchoMode</a> mode = QLineEdit::Normal, const <a href="qstring.html">QString</a> & text = QString(), bool * ok = 0, <a href="qt.html#WFlags-typedef">Qt::WFlags</a> f = 0 )  <tt> [static]</tt></h3>

111

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. The mode is the echo mode the line edit will use. If ok is non-null *a 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 f.

112

This function returns the text which has been entered in the line edit. It will not return an empty string.

113

Use this static function like this:

114

<pre>  bool ok;

115

QString text = QInputDialog::getText(this, tr("QInputDialog::getText()"),

116

tr("User name:"), QLineEdit::Normal,

117

QDir::home().dirName(), &ok);

118

if (ok && !text.isEmpty())

119

textLabel->setText(text);</pre>

120

See also <a href="qinputdialog.html#getInteger">getInteger</a>(), <a href="qinputdialog.html#getDouble">getDouble</a>(), and <a href="qinputdialog.html#getItem">getItem</a>().

121

122

123

124

<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>

125

126

</tr></table></div></address></body>

127

</html>

Older »