QInputDialog(3qt)

NAME
QInputDialog - Simple convenience dialog to get a single value from the user

SYNOPSIS
#include <qinputdialog.h>

Inherits QDialog.

  Static Public Members

QString getText ( const QString & caption, const QString & label, QLineEdit::EchoMode mode = QLineEdit::Normal, const QString & text = QString::null, bool * ok = 0, QWidget * parent = 0, const char * name = 0 )

int getInteger ( const QString & caption, const QString & label, int num = 0, int from = -2147483647, int to = 2147483647, int step = 1, bool * ok = 0, QWidget * parent = 0, const char * name = 0 )

double getDouble ( const QString & caption, const QString & label, double num = 0, double from = -2147483647, double to = 2147483647, int decimals = 1, bool * ok = 0, QWidget * parent = 0, const char * name = 0 )

QString getItem ( const QString & caption, const QString & label, const QStringList & list, int current = 0, bool editable = TRUE, bool * ok = 0, QWidget * parent = 0, const char * name = 0 )

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

The QInputDialog is a simple dialog which can be used if you need to get a single input value from the user. The input value can be a string, a number or an item from a list. A label has to be set to tell the user what they should input.

Four static convenience functions are provided: getText(), getInteger(), getDouble() and getItem(). All the functions can be used in a similar way, for example:

  bool ok = FALSE;
  QString text = QInputDialog::getText(
                    tr( "Application name" ),
                    tr( "Please enter your name" ),
                    QLineEdit::Normal, QString::null, &ok, this );
  if ( ok && !text.isEmpty() )
      ;// user entered something and pressed OK
  else
      ;// user entered nothing or pressed Cancel

<center>
[Image Omitted]

</center>

See also Dialog Classes.

MEMBER FUNCTION DOCUMENTATION

double QInputDialog::getDouble ( const QString & caption, const QString & label, double num = 0, double from = -2147483647, double to = 2147483647, int decimals = 1, bool * ok = 0, QWidget * parent = 0, const char * name = 0 ) [static]
Static convenience function to get a floating point number from the user. caption 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 mention what they should input), num is the default floating point number that the line edit will be set to. from and to 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 not-null it will be set to TRUE if the user pressed OK and FALSE if the user pressed Cancel. The dialog's parent is parent; the dialog is called name. The dialog will be modal.

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

Use this static method like this:

  bool ok = FALSE;
  double res = QInputDialog::getDouble(
                tr( "Application name" ),
                tr( "Please enter a decimal number" ),
                33.7, 0, 1000, 2, &ok, this );
  if ( ok )
      ;// user entered something and pressed OK
  else
      ;// user pressed Cancel

int QInputDialog::getInteger ( const QString & caption, const QString & label, int num = 0, int from = -2147483647, int to = 2147483647, int step = 1, bool * ok = 0, QWidget * parent = 0, const char * name = 0 ) [static]
Static convenience function to get an integer input from the user. caption 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 mention what they should input), num is the default number which the spinbox will be set to. from and to 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 not-null it will be set to TRUE if the user pressed OK and FALSE if the user pressed Cancel. The dialog's parent is parent; the dialog is called name. The dialog will be modal.

This method returns the number which has been entered by the user.

Use this static method like this:

  bool ok = FALSE;
  int res = QInputDialog::getInteger(
                tr( "Application name" ),
                tr( "Please enter a number" ), 22, 0, 1000, 2, &ok, this );
  if ( ok )
      ;// user entered something and pressed OK
  else
      ;// user pressed Cancel

QString QInputDialog::getItem ( const QString & caption, const QString & label, const QStringList & list, int current = 0, bool editable = TRUE, bool * ok = 0, QWidget * parent = 0, const char * name = 0 ) [static]
Static convenience function to let the user select an item from a string list. caption 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 mention what they should input). 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 not-null it will be set to TRUE if the user pressed OK and FALSE if the user pressed Cancel. The dialog's parent is parent; the dialog is called name. The dialog will be modal.

This method returns the text of the current item, or if editable is TRUE, the current text of the combobox.

Use this static method like this:

  QStringList lst;
  lst << "First" << "Second" << "Third" << "Fourth" << "Fifth";
  bool ok = FALSE;
  QString res = QInputDialog::getItem(
                    tr( "Application name" ),
                    tr( "Please select an item" ), lst, 1, TRUE, &ok, this );
  if ( ok )
      ;// user selected an item and pressed OK
  else
      ;// user pressed Cancel

QString QInputDialog::getText ( const QString & caption, const QString & label, QLineEdit::EchoMode mode = QLineEdit::Normal, const QString & text = QString::null, bool * ok = 0, QWidget * parent = 0, const char * name = 0 ) [static]
Static convenience function to get a string from the user. caption 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 mention what they should input), text the default text which is placed in the line edit. The mode is the echo mode the line edit will use. If ok is not-null it will be set to TRUE if the user pressed OK and FALSE if the user pressed Cancel. The dialog's parent is parent; the dialog is called name. The dialog will be modal.

This method returns the text which has been entered in the line edit.

Use this static method like this:

  bool ok = FALSE;
  QString text = QInputDialog::getText(
                    tr( "Application name" ),
                    tr( "Please enter your name" ),
                    QLineEdit::Normal, QString::null, &ok, this );
  if ( ok && !text.isEmpty() )
      ;// user entered something and pressed OK
  else
      ;// user entered nothing or pressed Cancel

Example: network/ftpclient/ftpmainwindow.cpp.

SEE ALSO
http://doc.trolltech.com/qinputdialog.html http://www.trolltech.com/faq/tech.html

COPYRIGHT
Copyright 1992-2001 Trolltech AS, http://www.trolltech.com. See the license file included in the distribution for a complete license statement.

AUTHOR
Generated automatically from the source code.

BUGS
If you find a bug in Qt, please report it as described in http://doc.trolltech.com/bughowto.html. Good bug reports help us to help you. Thank you.

The definitive Qt documentation is provided in HTML format; it is located at $QTDIR/doc/html and can be read using Qt Assistant or with a web browser. This man page is provided as a convenience for those users who prefer man pages, although this format is not officially supported by Trolltech.

If you find errors in this manual page, please report them to qt-bugs@trolltech.com. Please include the name of the manual page (qinputdialog.3qt) and the Qt version (3.0.3).