From 94694424cae1f5533dcbe2a0b36ff49c8418a613 Mon Sep 17 00:00:00 2001 From: Marc Mutz Date: Mon, 24 Sep 2012 13:02:53 +0200 Subject: [PATCH] [docs] QInputDialog: document deprecated member getInteger() Change-Id: I2ac24acbecd67db74f9474a7a2a1ee94b03282d4 Reviewed-by: Qt Doc Bot Reviewed-by: Stephen Kelly --- src/widgets/dialogs/qinputdialog.cpp | 32 ++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/src/widgets/dialogs/qinputdialog.cpp b/src/widgets/dialogs/qinputdialog.cpp index b14517578d4..27f2d0adc1d 100644 --- a/src/widgets/dialogs/qinputdialog.cpp +++ b/src/widgets/dialogs/qinputdialog.cpp @@ -1219,6 +1219,38 @@ int QInputDialog::getInt(QWidget *parent, const QString &title, const QString &l } } +/*! + \fn QInputDialog::getInteger(QWidget *parent, const QString &title, const QString &label, int value, int min, int max, int step, bool *ok, Qt::WindowFlags flags) + \deprecated use getInt() + + Static convenience function to get an integer input from the user. + + \a title is the text which is displayed in the title bar of the dialog. + \a label is the text which is shown to the user (it should say what should + be entered). + \a value is the default integer which the spinbox will be set to. + \a min and \a max are the minimum and maximum values the user may choose. + \a step is the amount by which the values change as the user presses the + arrow buttons to increment or decrement the value. + + If \a ok is nonnull *\a 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 + \a parent. The dialog will be modal and uses the widget \a flags. + + On success, this function returns the integer which has been entered by the + user; on failure, it returns the initial \a value. + + Use this static function like this: + + \snippet dialogs/standarddialogs/dialog.cpp 0 + + \warning Do not delete \a parent during the execution of the dialog. If you + want to do this, you should create the dialog yourself using one of the + QInputDialog constructors. + + \sa getText(), getDouble(), getItem() +*/ + /*! Static convenience function to get a floating point number from the user.