25 

    25 #include "hbinputdialog_p.h"

    47     \brief HbInputDialog creates a modal dialog for the user to get some information in the form of text or numbers.

    45     \brief HbInputDialog is a convenient class for getting user inputs. 

    48 

    51     HbInputDialog by default will have a label to display a descriptive text for the line edit input field and,

    48     \image html inputdialog.png  "An Input dialog with prompt text and a user input field."

    52         OK and Cancel buttons.

    49 

    50     HbInputDialog by default will have a label to display a descriptive text which gives information on the user input field, 

    51     an edit field for entering text and,two action buttons.

    56     HbInputDialog *object = new HbInputDialog(parent);

    55     HbInputDialog *object = new HbInputDialog();

    57     object->show();

    59     

    57 

    60     Four static convenience API's are provided: getText(), getInteger(), getDouble(), and getIp()

    58     The HbDialog::open( QObject* receiver, const char* member ) method  from the HbDialog is used to show the HbInputDialog. 

    59 

    60     The open method can be attached with a SLOT of the format finished(HbAction*) or finished(int). When the open is used with a slot then the slot 

    61     will be invoked once the user does any action such as accept or reject (The Ok or Cancel press).

    62 

    63     

    64     below is the declaration of the slot.

    65     \code

    66     public slots : 

    67     void dialogClosed(int);

    68     \endcode

    69 

    70     below code shows how the open method can be called using this slot.

    71     \snipped{ultimatecodesnipped/ultimatecodesnippet.cpp,56}    

    72 

    73     A sample slot definition is shown below    

    74     \snipped{ultimatecodesnipped/ultimatecodesnippet.cpp,55}    

    75 

    76     In HbInputDialog four static convenience API's are provided: queryText(), queryInteger(), queryDouble(), and queryIp()

    63      \enum HbInputDialog::InputMode

    79     \enum HbInputDialog::InputMode

    64 

    80 

    65     \value \b TextInput When this value is set as Input mode, input dialog accepts text input in its 

    81     \value \b TextInput When this value is set as Input mode, Input Dialog accepts text input in its 

    68     \value \b IntInput When this value is set as Input mode, input dialog accepts Integer input in its 

    84     \value \b IntInput When this value is set as Input mode, Input Dialog accepts Integer input in its 

    71     \value \b RealInput When this value is set as Input mode, input dialog accepts double or float input in its 

    87     \value \b RealInput When this value is set as Input mode, Input Dialog accepts double or float input in its 

    74     \value \b IpInput When this value is set as Input mode, input dialog accepts Ip address as input in its 

    90     \value \b IpInput When this value is set as Input mode, Input Dialog accepts Ip address as input in its 

   110     Sets the input mode of the primary(Top/default)line edit in the query widget.

   126     Sets the input mode of the user field. The default InputMode is TextInput.

   111 

   127     The other available modes are IntInput,RealInput and IpInput.

   112     The default InputMode is TextInput

   117     \param row. value 0 or 1

   132     \param row. This parameter indicates which row of the field.0 (by default) means the 

   118     

   133     the first user field and 1 means second user field.

   134 

   128     Returns input mode for top/default line edit.

   144     Returns input mode of the user field.The default InputMode is TextInput.

   129 

   145 

   130     The default InputMode is TextInput

   146     \param row This parameter indicates which row of the field.0 means the

   131 

   147     the first user field and 1 means second user field.

   132     \param row. value 0 or 1

   151     Sets the prompt \a text for top/default line edit.

   166     Sets the prompt text for the user field. This prompt text text can be very descriptive like username,password etc.

   152 

   167 

   153     \param text. Text for the label which describes the purpose of the corresponding input line edit field.

   168     \param text The promt text string. Maximum number of lines shown is 2.

   154     \param row. value 0 or 1

   169     \param row This parameter indicates which row of the user field.0 (by default) means the 

   170     the first user field and 1 means second user field.

   165     Returns prompt text for top/default line edit.

   181     Returns descriptive prompt text.

   166     the default is null string.

   182 

   167     \param row. value 0 or 1

   183     \param row This parameter indicates which row of the field. 0 means the 

   184     the user field in the first row and 1 means user field in the second row.

   178     Sets the top/default line edit value in \a text format.

   195     Sets the value for the user input field.The value should in sync HbInputDialog::InputMode of the field.

   179 

   196     

   180     \param value. user defined value for the default line edit.

   197     \param value The value that should be presented to the user.

   181     \param row. value 0 or 1

   198     

   199     \param row This parameter indicates which row of the user field.0 (by default) means the 

   200     the first user field and 1 means second user field.

   192     Returns top/default line edit value as QVariant object.

   211     This returns the value of the user field row. The return type is QVariant which can be converted to

   193 

   212     corresponding type based on HbInputDialog::InputMode of the field.

   194     \param row. value 0 or 1

   213    

   214    \param row This parameter indicates which row of the user field.0 (by default) means the 

   215     the first user field and 1 means second user field

   205     Sets the visibility of bottom line edit and prompt text.

   226     HbInputDialog is capable of showing one or two user input fields. This can be set using this function.

   206 

   227     By default this is false and only first row is visible.

   207     \param visible true or false.

   228 

   229     \param visible true or false. If true then two user fields will be visible otherwise one.

   218     Returns the visibility of secondary row(bottom line edit and prompt text).

   240     Returns the visibility of second row user input field.The default is false.

   219     the default is false

   241 

   229     Validator is used to validate the content and cursor movements.

   251    

   230 

   252     This API allows the user to set any validator to the user input field.

   231     \param validator. Validator uses undo stack to back out invalid changes. Therefore undo

   253 

   254     \param validator Validator uses undo stack to back out invalid changes. Therefore undo

   234     \sa HbAbstractEdit::setValidator

   257 	\param row This parameter indicates which row of the user field.0 means the 

   258     the first user field and 1 means second user field

   259 

   260     \sa HbAbstractEdit::validator

   247     Returns the validator of the inputDialog's line edit.

   273     This API returns the validator of the corresponding user input row.

   248 

   274 

   249     \param row. A value 0 or 1

   275     \param row This parameter indicates which row of the user field.0 (by default) means the 

   276     the first user field and 1 means second user field

   265     returns the lineEdit pointer. will return NULL if row is greater than 2.

   292     This returns the editor instance used in HbInputDialog.

   266 

   293     \param row This parameter indicates which row of the user field.0 (by default) means the 

   267     \param row. A value 0 or 1

   294     the first user field and 1 means second user field

   281     sets the echo mode for the given row.

   308     sets the echo mode for the user input fiels. The echo mode is defined in HbLineEdit.

   282 

   309     Normal, NoEcho, Password, PasswordEchoOnEdit are the different echo modes supportted in HbLineEdit.

   283     \param echoMode

   310 

   284     \param row. A value 0 or 1

   311     \param echoMode which can be HbLineEdit::Normal, HbLineEdit::NoEcho, HbLineEdit::Password or HbLineEdit::PasswordEchoOnEdit.

   285 

   312     

   286     \sa HbLineEdit::setEchoMode

   313     \param row This parameter indicates which row of the user field.0 (by default) means the 

   314     the first user input field and 1 means second user input field

   315 

   316     \sa echoMode() , HbLineEdit::setEchoMode()

   354 /*!

   382 void HbInputDialog::done(int code)

   355     Returns the echoMode of line edit. returns -1 if row is more than 2.

   383 {

   356 

   384     Q_D(HbInputDialog);

   357     \param row. A value 0 or 1

   385     if(code==Accepted) {

   386         QString text;

   387         if(d->mContentWidget && d->mContentWidget->mEdit1) {

   388             text = d->mContentWidget->mEdit1->text();

   389         }

   390         switch(d->mPrimaryMode) {

   391             case HbInputDialog::TextInput:

   392             case HbInputDialog::IpInput: {

   393                 emit textValueSelected(text);

   394                 break;

   395             }        

   396             case HbInputDialog::IntInput: {

   397                 emit intValueSelected(text.toInt(0,10));       

   398                 break;

   399             }

   400             case HbInputDialog::RealInput: {

   401                 emit doubleValueSelected(text.toDouble());       

   402                 break;

   403             }

   404             default:

   405                 break;

   406         }

   407     }

   408     HbDialog::done(code);

   409 }

   410 

   411 /*!

   412     Returns the echoMode of the user input field.It returns HbLineEdit::EchoMode.

   413 

   414     \param row This parameter indicates which row of the user field.0  means the 

   415     the first user input field and 1 means second user input field

   373     Static convenience function for creating an input dialog to get a string from the user. 

   431     \deprecated HbInputDialog::getText(const QString&,QObject*,const char*,const QString&,QGraphicsScene*,QGraphicsItem*)

   374     \a label is the text which is shown to the user (it should

   432         is deprecated.

   375     say what should be entered). \a text is the default text which is

   433     

   376     placed in the line edit. If \a ok is non-null \e *\a ok will be 

   434     This is a static convenience function for creating an Input Dialog and to get a string data from the the user. The Application can use this 

   377     set to true if the user pressed \gui OK and to false if the user pressed

   435     function in order to get any text data from user like username,search data etc. This API allows a slot to be passed as a param. This slot will 

   378     \gui Cancel. The dialog's parent is \a parent. The dialog will be

   436     be invoked when the user does the action like OK press or CANCEL press.  

   379     modal.

   437     

   380 

   438     HbInputDialog::getText(iTitle,this,SLOT(dialogClosed(HbAction*)),iText);  iTitle is the prompt text.dialogClosed will be invoked when the user does the action.

   381     This function return data has to be queried in the finished(HbAction*) slot.

   439     Please refer the class documentation to know how to handle the slot.

   382 

   440    

   441     \param label The prompt text which gives information on user input field.

   442     \param receiver The instance where the slot is declared.

   443     \param member The slot which has dialogClosed(HbAction*) signature. 

   444     \param text The default text that should be presented to the user.

   445     \param scene The scene parameter.

   446     \param parent The parent item for the dialog.

   447    

   405     Static convenience function to get an integer input from the

   470     \deprecated HbInputDialog::getInteger(const QString&,QObject*,const char*,int,QGraphicsScene*,QGraphicsItem*)

   406     user.\a label is the text which is shown to the user

   471         is deprecated.

   407     (it should say what should be entered). \a value is the default

   472 

   408     integer which the spinbox will be set to.  

   473     \sa queryInteger(), queryDouble(), queryIp()

   409     If \a ok is non-null *\a ok will be set to true if the user

   410     pressed \gui OK and to false if the user pressed \gui Cancel. The

   411     dialog's parent is \a parent. The dialog will be modal.

   412 

   413     This function return data has to be queried in the finished(HbAction*) slot.

   414 

   415     \sa getText(), getDouble(), getIp()

   435     Static convenience function to get a floating point number from

   493     \deprecated HbInputDialog::getDouble(const QString&,QObject*,const char*,double,QGraphicsScene*,QGraphicsItem*)

   436     the user.\a label is the text which is shown to the user

   494         is deprecated.

   437     (it should say what should be entered). \a value is the default

   495    

   438     floating point number that the line edit will be set to.

   496     \sa queryInteger(), queryDouble(), queryIp()

   439 

   440     If \a ok is non-null, *\a ok will be set to true if the user

   441     pressed \gui OK and to false if the user pressed \gui Cancel. The

   442     dialog's parent is \a parent. The dialog will be modal.

   443 

   444     This function return data has to be queried in the finished(HbAction*) slot.

   445 

   446     \sa getText(), getInteger(), getIp()

   465 

   515 /*!

   466 /*!

   516     \deprecated HbInputDialog::getIp(const QString &,QObject*,const char*,const QString&,QGraphicsScene*,QGraphicsItem*)

   467     Static convenience function to get an ip address from

   517         is deprecated.

   468     the user.\a label is the text which is shown to the user

   518 

   469     (it should say what should be entered). \a address is the default

   519     \sa queryInteger(), queryDouble(), queryIp()

   470     QHostAddress that the line edit will be set to.

   520 */

   471 

   521 

   472     If \a ok is non-null, *\a ok will be set to true if the user

   473     pressed \gui OK and to false if the user pressed \gui Cancel. The

   474     dialog's parent is \a parent. The dialog will be modal.

   475 

   476     This function return data has to be queried in the finished(HbAction*) slot.

   477 

   478     \sa getText(), getInteger(), getDouble()

   479 */

   492 	dlg->setValue(ipaddress);

   534     dlg->setValue(ipaddress);