FCL/sf/mw/hb: comparison src/hbwidgets/popups/hbinputdialog.cpp

equal deleted inserted replaced

-:f7ac710697a9
+:06ff229162e9
 ** If you have questions regarding the use of this file, please contact
 ** Nokia at developer.feedback@nokia.com.
 **
 ****************************************************************************/
 #include <hbinputdialog.h>
 #include "hbinputdialog_p.h"
 #include "hbglobal_p.h"
 #include <hblineedit.h>
 #include <hbaction.h>
 #include "hbinputdialogcontent_p.h"
-#include <hbstyleoptioninputdialog.h>
+#include <hbstyleoptioninputdialog_p.h>
 #include <hbvalidator.h>
 #include <QGraphicsScene>
 #ifdef HBINPUTDIALOG_DEBUG
 /*!
 @beta
 @hbwidgets
 \class HbInputDialog
-\brief A class used to get information from the user.
+\brief HbInputDialog creates a modal dialog for the user to get some information in the form of text or numbers.
-the input value can be a text, int, double or ip address.
+Based on the \InputMode user can enter text, int, double or an IP address. InputDialog can have one or two line edit input fields.
+HbInputDialog by default will have a label to display a descriptive text for the line edit input field and,
+OK and Cancel buttons.
 example code example:
 \code
 HbInputDialog *object = new HbInputDialog(parent);
 object->show();
 \endcode
 Four static convenience API's are provided: getText(), getInteger(), getDouble(), and getIp()
 static API's can be used to quickly get an input from user.
+\enum HbInputDialog::InputMode
+\value \b TextInput When this value is set as Input mode, input dialog accepts text input in its
+correspoinding line edit field.
+\value \b IntInput When this value is set as Input mode, input dialog accepts Integer input in its
+correspoinding line edit field.
+\value \b RealInput When this value is set as Input mode, input dialog accepts double or float input in its
+correspoinding line edit field.
+\value \b IpInput When this value is set as Input mode, input dialog accepts Ip address as input in its
+correspoinding line edit field.
 */
 /*!
-Constructor of HbInputDialog
+Constructor of HbInputDialog with a \a parent.
 \param parent. Parent widget
 */
 HbInputDialog::HbInputDialog(QGraphicsItem* parent) :
 HbDialog(*new HbInputDialogPrivate, parent)
 {
 */
 HbInputDialog::~HbInputDialog()
 {
 }
+/*!
-/*!
-@beta
 Sets the input mode of the primary(Top/default)line edit in the query widget.
+The default InputMode is TextInput
 \param mode. InputMode can be TextMode, IntMode, RealMode and Ip address mode.
 each mode will affect how the line edit filters its input.
 \param row. value 0 or 1
 \sa inputMode()
 */
 void HbInputDialog::setInputMode(InputMode mode ,int row)
 {
 Q_D(HbInputDialog);
 d->setInputMode(mode,row);
 }
+/*!
-/*!
-@beta
 Returns input mode for top/default line edit.
 The default InputMode is TextInput
 \param row. value 0 or 1
 \sa setInputMode()
 */
 HbInputDialog::InputMode HbInputDialog::inputMode(int row) const
 return (HbInputDialog::InputMode)0;
 }
 }
 }
+/*!
-/*!
-@beta
 Sets the prompt \a text for top/default line edit.
-\param text. user defined text
+\param text. Text for the label which describes the purpose of the corresponding input line edit field.
 \param row. value 0 or 1
 \sa promtText()
 */
 void HbInputDialog::setPromptText(const QString &text, int row)
 {
 Q_D(HbInputDialog);
 d->setPromptText(text, row);
 }
+/*!
-/*!
-@beta
 Returns prompt text for top/default line edit.
 the default is null string.
 \param row. value 0 or 1
 \sa setPromptText()
 Q_D(const HbInputDialog);
 return d->promptText(row);
 }
 /*!
-@beta
 Sets the top/default line edit value in \a text format.
-\param value. user defined value
+\param value. user defined value for the default line edit.
 \param row. value 0 or 1
 \sa value()
 */
 void HbInputDialog::setValue(const QVariant &value,int row)
 Q_D(HbInputDialog);
 d->setText(value.toString(),row);
 }
 /*!
-@beta
 Returns top/default line edit value as QVariant object.
 \param row. value 0 or 1
 \sa setValue()
 Q_D(const HbInputDialog);
 return QVariant(d->text(row));
 }
 /*!
-@beta
 Sets the visibility of bottom line edit and prompt text.
 \param visible true or false.
 \sa isAdditionalRowVisible()
 Q_D(HbInputDialog);
 d->setAdditionalRowVisible(visible);
 }
 /*!
-@beta
 Returns the visibility of secondary row(bottom line edit and prompt text).
 the default is false
 \sa setAdditionalRowVisible()
 */
 bool HbInputDialog::isAdditionalRowVisible()
 {
 Q_D(HbInputDialog);
 return d->isAdditionalRowVisible();
 }
+/*!
-/*!
-@beta
 Validator is used to validate the content and cursor movements.
 \param validator. Validator uses undo stack to back out invalid changes. Therefore undo
 is enabled when validator is set.
 } else if( (row == 1) && (d->mContentWidget->mEdit2) ) {
 d->mContentWidget->mEdit2->setValidator(validator);
 }
 }
+/*!
-/*!
+Returns the validator of the inputDialog's line edit.
-@beta
-returns the validator of the inputDialog's line edit.
 \param row. A value 0 or 1
 \sa setValidator()
 */
 return d->mContentWidget->mEdit2->validator();
 }
 return NULL;
 }
+/*!
-/*!
-@beta
 returns the lineEdit pointer. will return NULL if row is greater than 2.
 \param row. A value 0 or 1
 */
 HbLineEdit* HbInputDialog::lineEdit(int row) const
 }
 return NULL;
 }
 /*!
-@beta
 sets the echo mode for the given row.
 \param echoMode
 \param row. A value 0 or 1
 }
 d->mEchoMode = echoMode;
 }
 };
+/*!
-/*!
 \deprecated HbInputDialog::primitive(HbStyle::Primitive)
 is deprecated.
 Provides access to primitives of HbInputDialog.
 \param primitive is the type of the requested primitive. The available
 return 0;
 }
 }
 /*!
-@beta
 \reimp
 Initializes \a option with the values from this HbInputDialog.
 */
 void HbInputDialog::initStyleOption(HbStyleOptionInputDialog *option) const
 {
 HbDialog::initStyleOption(option);
 option->text = d->mPromptText;
 option->additionalText = d->mPromptAdditionalText;
 }
+/*!
-/*!
+\reimp
-@beta
 updatePrimitives.
 */
 void HbInputDialog::updatePrimitives()
 {
 Q_D(HbInputDialog);
 if (d->mContentWidget->mLabel2 && d->mContentWidget->mAdditionalRowVisible) {
 style()->updatePrimitive(d->mContentWidget->mLabel2, HbStyle::P_InputDialog_additionaltext, &option);
 }
 }
+/*!
-/*!
+Returns the echoMode of line edit. returns -1 if row is more than 2.
-@beta
-returns the echoMode of line edit. returns -1 if row is more than 2.
 \param row. A value 0 or 1
 \sa setEchoMode()
 */
 return d->mEchoMode;
 }
 return HbLineEdit::EchoMode(-1);//
 }
+/*!
-/*!
+Static convenience function for creating an input dialog to get a string from the user.
-@beta
+\a label is the text which is shown to the user (it should
-Static convenience function to get a string from the user. \a
-label is the text which is shown to the user (it should
 say what should be entered). \a text is the default text which is
 placed in the line edit. If \a ok is non-null \e *\a ok will be
 set to true if the user pressed \gui OK and to false if the user pressed
 \gui Cancel. The dialog's parent is \a parent. The dialog will be
 modal.
 if (scene && !parent) {
 scene->addItem(dlg);
 }
 dlg->setPromptText(label);
 dlg->setInputMode(TextInput);
 dlg->setValue(text);
 dlg->setAttribute(Qt::WA_DeleteOnClose);
 dlg->open(receiver,member);
 }
-/*!
-\deprecated HbInputDialog::getText(const QString&,const QString&,bool*,QGraphicsScene*,QGraphicsItem*)
+/*!
-is deprecated. Please use the other available getText API.
-Static convenience function to get a string from the user. \a
-label is the text which is shown to the user (it should
-say what should be entered). \a text is the default text which is
-placed in the line edit. If \a ok is non-null \e *\a ok will be
-set to true if the user pressed \gui OK and to false if the user pressed
-\gui Cancel. The dialog's parent is \a parent. The dialog will be
-modal.
-This function returns the text which has been entered in the line
-edit. It will not return an empty string.
-\sa getInteger(), getDouble(), getIp()
-*/
-QString HbInputDialog::getText(const QString &label,const QString &text,
-bool *ok, QGraphicsScene *scene, QGraphicsItem *parent)
-{
-HB_DEPRECATED("HbInputDialog::getText is deprecated. Please use HbInputDialog::getText((const QString&, QObject*, const char*, const QString&, QGraphicsScene*, QGraphicsItem*) instead.");
-Q_UNUSED(parent);//this is a bug in popup framework, cannot set parent will affect fading
-HbInputDialog *dlg = new HbInputDialog();
-if (scene) {
-scene->addItem(dlg);
-}
-QString result;
-dlg->setPromptText(label);
-dlg->setInputMode(TextInput);
-dlg->setValue(text);
-HbAction* action = dlg->exec();
-if(action == dlg->secondaryAction()) { //Cancel was pressed
-if(ok) {
-			*ok = false;
-}
-} else { //OK was pressed
-if(ok) {
-			*ok = true;
-}
-result = dlg->value().toString();
-}
-delete dlg;
-return result;
-}
-/*!
-@beta
 Static convenience function to get an integer input from the
 user.\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.
 If \a ok is non-null *\a ok will be set to true if the user
 dlg->setValue(QString::number(value));
 dlg->setAttribute(Qt::WA_DeleteOnClose);
 dlg->open(receiver,member);
 }
 /*!
-\deprecated HbInputDialog::getInteger(const QString&,int,bool*,QGraphicsScene*,QGraphicsItem*)
-is deprecated. Please use the other available HbInputDialog::getInteger API.
-Static convenience function to get an integer input from the
-user.\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.
-If \a ok is non-null *\a ok will be set to true if the user
-pressed \gui OK and to false if the user pressed \gui Cancel. The
-dialog's parent is \a parent. The dialog will be modal.
-This function returns the integer which has been entered by the user.
-\sa getText(), getDouble(), getIp()
-*/
-int HbInputDialog::getInteger(const QString &label, int value,
-bool *ok,QGraphicsScene *scene,QGraphicsItem *parent)
-{
-HB_DEPRECATED("HbInputDialog::getInteger is deprecated. Please use HbInputDialog::getInteger(const QString&, QObject*, const char*,int,QGraphicsScene*,QGraphicsItem *) instead.");
-Q_UNUSED(parent)
-HbInputDialog *dlg = new HbInputDialog();
-QString result;
-dlg->setPromptText(label);
-dlg->setInputMode(IntInput);
-dlg->setValue(QString::number(value));
-if(scene) {
-scene->addItem(dlg);
-}
-HbAction* action = dlg->exec();
-if(action == dlg->secondaryAction()) { //Cancel was pressed
-if(ok) {
-*ok = false;
-}
-} else { //OK was pressed
-if(ok) {
-			*ok = true;
-}
-	    result = dlg->value().toString();
-}
-delete dlg;
-#ifdef HBINPUTDIALOG_DEBUG
-qDebug()<<"Value:"<<result;
-#endif
-return result.toInt();
-}
-/*!
 Static convenience function to get a floating point number from
 the user.\a label is the text which is shown to the user
 (it should say what should be entered). \a value is the default
 floating point number that the line edit will be set to.
 QGraphicsScene *scene,
 QGraphicsItem *parent)
 {
 HbInputDialog *dlg = new HbInputDialog(parent);
 if(scene && !parent) {
 scene->addItem(dlg);
 }
 dlg->setPromptText(label);
 dlg->setInputMode(RealInput);
 dlg->setValue(QString::number(value));
 dlg->open(receiver,member);
 }
 /*!
-\deprecated HbInputDialog::getDouble(const QString &,double,bool*,QGraphicsScene*,QGraphicsItem*)
+Static convenience function to get an ip address from
-is deprecated. Please use the other available HbInputDialog::getDouble(...) API.
-Static convenience function to get a floating point number from
-the user.\a label is the text which is shown to the user
-(it should say what should be entered). \a value is the default
-floating point number that the line edit will be set to.
-If \a ok is non-null, *\a ok will be set to true if the user
-pressed \gui OK and to false if the user pressed \gui Cancel. The
-dialog's parent is \a parent. The dialog will be modal.
-This function returns the floating point number which has been
-entered by the user.
-\sa getText(), getInteger(), getIp()
-*/
-double HbInputDialog::getDouble(const QString &label, double value,
-bool *ok, QGraphicsScene *scene, QGraphicsItem *parent)
-{
-HB_DEPRECATED("HbInputDialog::getDouble is deprecated.Please use HbInputDialog::getDouble(const QString&, QObject*,const char*,double, QGraphicsItem*) instead.");
-Q_UNUSED(parent)
-HbInputDialog *dlg = new HbInputDialog();
-QString result;
-dlg->setPromptText(label);
-dlg->setInputMode(RealInput);
-dlg->setValue(QString::number(value));
-if(scene) {
-scene->addItem(dlg);
-}
-HbAction* action = dlg->exec();
-if(action == dlg->secondaryAction()){ //Cancel was pressed
-if(ok) {
-			*ok = false;
-}
-} else { //OK was pressed
-if(ok) {
-*ok = true;
-}
-result = dlg->value().toString();
-}
-delete dlg;
-#ifdef HBINPUTDIALOG_DEBUG
-qDebug()<<"Value:"<<result;
-#endif
-return result.toDouble();
-}
-/*!
-@beta
-Static convenience function to get a ip address from
 the user.\a label is the text which is shown to the user
 (it should say what should be entered). \a address is the default
 QHostAddress that the line edit will be set to.
 If \a ok is non-null, *\a ok will be set to true if the user
 QGraphicsScene *scene,
 QGraphicsItem *parent)
 {
 HbInputDialog *dlg = new HbInputDialog(parent);
 if(scene && !parent) {
 scene->addItem(dlg);
 }
 dlg->setPromptText(label);
-dlg->setInputMode(IpInput);
+	dlg->setValue(ipaddress);
-dlg->setValue(ipaddress);
+dlg->setInputMode(IpInput);
 dlg->open(receiver,member);
 }
-/*!
-\deprecated HbInputDialog::getIp(const QString &,const QString&, bool *,QGraphicsScene*,QGraphicsItem*)
-is deprecated. Please use the other available HbInputDialog::getIp API.
-Static convenience function to get a ip address from
-the user.\a label is the text which is shown to the user
-(it should say what should be entered). \a address is the default
-QHostAddress that the line edit will be set to.
-If \a ok is non-null, *\a ok will be set to true if the user
-pressed \gui OK and to false if the user pressed \gui Cancel. The
-dialog's parent is \a parent. The dialog will be modal.
-This function returns the ip address number which has been
-entered by the user.
-\sa getText(), getInteger(), getDouble()
-*/
-QString HbInputDialog::getIp(const QString &label, const QString &ipaddress, bool *ok, QGraphicsScene *scene,
-QGraphicsItem *parent)
-{
-HB_DEPRECATED("HbInputDialog::getIp is deprecated. Please use HbInputDialog::getIp(const QString &,QObject *,const char *,const QString &, QGraphicsScene *, QGraphicsItem *)");
-Q_UNUSED(parent)
-HbInputDialog *dlg = new HbInputDialog();
-QString result;
-dlg->setPromptText(label);
-dlg->setInputMode(IpInput);
-dlg->setValue(ipaddress);
-if(scene) {
-scene->addItem(dlg);
-}
-HbAction* action = dlg->exec();
-if(action == dlg->secondaryAction()){ //Cancel was pressed
-if(ok) {
-*ok = false;
-}
-} else { //OK was pressed
-if(ok) {
-*ok = true;
-}
-result = dlg->value().toString();
-}
-delete dlg;
-#ifdef HBINPUTDIALOG_DEBUG
-qDebug()<<"Value:"<<result;
-#endif
-return result;
-}
 #include "moc_hbinputdialog.cpp"

changeset 2	06ff229162e9
parent 1	f7ac710697a9
child 3	11d3954df52a