jdd_mmiapi.h.svn-base

gif to bmp conversion

/** Input Box **/

/**
 * @brief This function gets the cursor position from the input control that is identified by the control ID.
 * @param[in] uiWindowID Specifies the Window identifier
 * @param[in] uiControlID Specifies the control identifier
 * @param[out] piTextLen Returns the current cursor position. 
 */
JC_RETCODE jdd_MMIGetInputCurPosition (JC_UINT32 uiWindowID, JC_UINT32 uiControlID, 
									   JC_INT32 *piTextLen)  ;

/**
 * @brief This function sets the cursor position from the input control identified by the control ID.
 * @param[in] uiWindowID Specifies the Window identifier
 * @param[in] uiControlID Specifies the control identifier
 * @param[in] iTextLen Specifies the value as to where the cursor should be placed in the Input or Password control.
 */
JC_RETCODE jdd_MMISetInputCurPosition (JC_UINT32 uiWindowID, JC_UINT32 uiControlID, 
									   JC_INT32 iTextLen)   ;

/**
 * @brief This function sets the input value to the input box control. 
 * @param[in] uiWindowID Specifies the Window identifier.
 * @param[in] uiControlID Specifies the control identifier.
 * @param[in] pmInputValue Specifies the input value that needs to be set to the input or password box. 
 * @see jdd_MMIGetInputValue
 */
JC_RETCODE jdd_MMISetInputValue (JC_UINT32 uiWindowID, JC_UINT32 uiControlID, 
								 const JC_CHAR *pmInputValue) ;

/**
 * @brief This function gets the input value for the input box control. 
 * @param[in] uiWindowID Specifies the Window identifier
 * @param[in] uiControlID Specifies the control identifier
 * @param[out] ppmInputValue Returns the input value for the input/password/multi-line box. 
 *			   The MMI abstraction layer needs to allocate the memory and provide the reference to the application. 
 *			   The application shall call the #jdd_MMIFreeInputValue function to free this memory reference.
 * @see jdd_MMISetInputValue
 * @see jdd_MMIFreeInputValue
 */
JC_RETCODE jdd_MMIGetInputValue (JC_UINT32 uiWindowID, JC_UINT32 uiControlID, 
								 JC_CHAR **ppmInputValue) ;

/**
 * @brief This function frees the input value that has been allocated using #jdd_MMIGetInputValue function. 
 * @param[in] uiWindowID Specifies the Window identifier
 * @param[in] uiControlID Specifies the control identifier
 * @param[in] pmInputValue Specifies the input value for the input or password box which needs to be freed 
 * @see jdd_MMIGetInputValue
 */
void jdd_MMIFreeInputValue (JC_UINT32	uiWindowID, JC_UINT32	uiControlID, 
							JC_CHAR		*pmInputValue) ;

/** End of Input Box **/

/** Check Box **/
/**
 * @brief This function provides the status of the checkbox. 
 * @param[in] uiWindowID Specifies the Window identifier
 * @param[in] uiControlID Specifies the control identifier
 * @param[out] peCheckBoxStatus Provides the state of the checkbox control. 
 */
JC_RETCODE jdd_MMIGetCheckBoxStatus (JC_UINT32 uiWindowID, JC_UINT32 uiControlID, 
									 E_OPTIONBOX_STATUS	*peCheckBoxStatus) ;
/**
 * @brief This function sets the status of the check box. 
 * @param[in] uiWindowID Specifies the Window identifier.
 * @param[in] uiControlID Specifies the control identifier.
 * @param[in] eCheckBoxStatus Specifies the state of the check box control.
 */
JC_RETCODE jdd_MMISetCheckBoxStatus (JC_UINT32 uiWindowID, JC_UINT32 uiControlID, 
									 E_OPTIONBOX_STATUS eCheckBoxStatus) ;
/** End of Check Box **/

/** Radio Box **/
/**
 * @brief This function creates the group identifier for the radio box, to group different radio box control.
 * @param[in] uiWindowID Specifies the Window identifier
 * @param[out] puiGroupRadioID Returns the group identifier.
 * @see jdd_MMIDeleteRadioBoxGroupID
 */
JC_RETCODE jdd_MMICreateRadioBoxGroupID (JC_UINT32 uiWindowID,
										 JC_UINT32 *puiGroupRadioID) ;
/**
 * @brief This function deletes the radio box group identifier that has been created using #jdd_MMICreateRadioBoxGroupID.
 * @param[in] uiWindowID Specifies the Window identifier
 * @param[in] uiGroupRadioID Specifies the group identifier which needs to be freed.
 * @see jdd_MMICreateRadioBoxGroupID
 */
void jdd_MMIDeleteRadioBoxGroupID (JC_UINT32 uiWindowID, JC_UINT32 uiGroupRadioID) ;

/**
 * @brief This function provides the status of the radio box.
 * @param[in] uiWindowID Specifies the Window identifier.
 * @param[in] uiControlID Specifies the control identifier.
 * @param[out] peRadioBoxStatus Provides the Radio Box status. 
 */
JC_RETCODE jdd_MMIGetRadioBoxStatus (JC_UINT32 uiWindowID, JC_UINT32 uiControlID, 
									 E_OPTIONBOX_STATUS	*peRadioBoxStatus) ;
/**
 * @brief This function sets the status of the radio box. 
 * @param[in] uiWindowID Specifies the Window identifier.
 * @param[in] uiControlID Specifies the control identifier.
 * @param[in] eRadioBoxStatus Specifies the radio box status.
 */
JC_RETCODE jdd_MMISetRadioBoxStatus (JC_UINT32 uiWindowID, JC_UINT32 uiControlID, 
									 E_OPTIONBOX_STATUS eRadioBoxStatus) ;
/** End of Radio Box **/

/** List Box **/
/**
 * @brief This function creates option group ID for ListBox. 
 * @param[in] uiWindowID Specifies the Window identifier.
 * @param[in] uiControlID Specifies the control identifier.
 * @param[in] pstListItem Specifies the List item information structure
 * @param[out] puiOptgroupID Returns the identifier for the created optgroup. This ID should be unique among the list box.
 * @see jdd_MMIListBoxDeleteOptgroup
 */
JC_RETCODE jdd_MMIListBoxCreateOptgroup (JC_UINT32 uiWindowID, 
										 JC_UINT32 uiControlID,
										 const JC_LIST_BOX_ITEM	*pstListItem,
										 JC_UINT32				*puiOptgroupID) ;
/**
 * @brief This function deletes an optional group box.
 * @param[in] uiWindowID Specifies the Window identifier.
 * @param[in] uiControlID Specifies the control identifier.
 * @param[in] uiOptgroupID Specifies the Optional group id that should be deleted.
 */
JC_RETCODE jdd_MMIListBoxDeleteOptgroup (JC_UINT32		uiWindowID,
										 JC_UINT32		uiControlID,
										 JC_UINT32		uiOptgroupID) ;
/**
 * @brief This function sets the text for the individual items of the list box.
 * @param[in] uiWindowID Specifies the Window identifier.
 * @param[in] uiControlID Specifies the control identifier.
 * @param[in] uiIndexItem Specifies the index of the list box item to set the text value.
 * @param[in] pmText Specifies the text of the list box item.
 * @param[in] pstImageInfo Specifies the image info (content type, buffer, buffer len) [optional].
 */
JC_RETCODE jdd_MMIListBoxSetTextItem (JC_UINT32 uiWindowID,
									  JC_UINT32 uiControlID,
									  JC_UINT32 uiIndexItem,
									  const JC_CHAR *pmText,
									  const JC_IMAGE_INFO *pstImageInfo) ;
/**
 * @brief This function sets the text for the individual items of the list box. 
 * @param[in] uiWindowID Specifies the Window identifier.
 * @param[in] uiControlID Specifies the control identifier.
 * @param[in] pstListItem Specifies the List item information structure.
 * The item can be either option group or option item. 
 */
JC_RETCODE jdd_MMIListBoxSetTextItemOpt (JC_UINT32 uiWindowID,
										 JC_UINT32 uiControlID,
										 const JC_LIST_BOX_ITEM *pstListItem) ;
/**
 * @brief This function sets the item that needs to be selected from the list. 
 * @param[in] uiWindowID Specifies the Window identifier.
 * @param[in] uiControlID Specifies the control identifier.
 * @param[in] puiSelectedIndex Specifies the index of the list box items that need to be selected.
 * @param[in] uiSelectedCounts Specifies the number of items in the puiSelectedIndex.
 */
JC_RETCODE jdd_MMIListBoxSetItem (JC_UINT32 uiWindowID,
								  JC_UINT32 uiControlID,
								  JC_INT32 *puiSelectedIndex,
								  JC_UINT32 uiSelectedCounts) ;
/**
 * @brief This function gets the items that have been selected in the list control.
 * @param[in] uiWindowID Specifies the Window identifier.
 * @param[in] uiControlID Specifies the control identifier.
 * @param[out] ppiSelectedIndex Provides the indexes of the list box items that are selected
 * @param[out] puiSelectedCounts Provides the number of items that are selected.
 * @see jdd_MMIListBoxFreeItem
 */
JC_RETCODE jdd_MMIListBoxGetItem (JC_UINT32 uiWindowID,
								  JC_UINT32 uiControlID,
								  JC_INT32 **ppiSelectedIndex,
								  JC_UINT32 *puiSelectedCounts) ;

void jdd_MMIFreeListBoxSelectItem (JC_UINT32	uiWindowID,
								   JC_UINT32	uiListBoxID,
								   JC_UINT32	uiSelectedCounts,
								   JC_INT32		*piSelectedIndex) ;

/**
 * @brief This function gets the focus item index among the selected items in the list box.
 * @param[in] uiWindowID Specifies the Window identifier.
 * @param[in] uiControlID Specifies the control identifier.
 * @param[out] piFocusedIndex Provides the index of the list box item that has focus. 
 */
JC_RETCODE jdd_MMIListBoxGetFocusedItem (JC_UINT32 uiWindowID, 
										 JC_UINT32 uiControlID,
										 JC_INT32 *piFocusedIndex) ;
/**
 * @brief This function is used to free the memory associated with the item in the list box, which was previously allocated using the API jdd_MMIListBoxGetItem.
 * @param[in] uiWindowID Specifies the Window identifier.
 * @param[in] uiControlID Specifies the control identifier.
 * @param[in] piSelectedIndex Specifies the pointer, which needs to be freed. 
 * @see jdd_MMIListBoxGetItem
 */
void jdd_MMIListBoxFreeItem (JC_UINT32		uiWindowID, 
							 JC_UINT32		uiControlID, 
							 JC_INT32		*piSelectedIndex) ;
/**
 * @brief This function is used to delete the specified index from the list box.
 * @param[in] uiWindowID Specifies the Window identifier.
 * @param[in] uiControlID Specifies the control identifier.
 * @param[in] puiSelectedIndex Specifies the list of index that needs to be removed from the list box.
 * @param[in] uiSelectedCounts Specifies the number of list index that needs to be removed.
 */
JC_RETCODE jdd_MMIListBoxDeleteItem (JC_UINT32		uiWindowID,
									 JC_UINT32		uiControlID,
									 JC_INT32		*puiSelectedIndex ,
									 JC_INT32		uiSelectedCounts) ; 

/** End of List Box **/

/** Combo Box **/
/**
 * @brief This function sets the text for the individual items for the combo box.
 * @param[in] uiWindowID Specifies the Window identifier
 * @param[in] uiControlID Specifies the control identifier
 * @param[in] uiIndexItem Specifies the index of the combo box item to set the text value
 * @param[in] pmText Specifies the text of the combo box item
 */
JC_RETCODE jdd_MMIComboBoxSetTextItem (JC_UINT32 uiWindowID, JC_UINT32 uiControlID, 
									   JC_UINT32 uiIndexItem, const JC_CHAR *pmText) ;

/**
 * @brief This function creates the option group ID for ComboBox. 
 * @param[in] uiWindowID Specifies the Window identifier.
 * @param[in] uiControlID Specifies the control identifier.
 * @param[in] pstComboItem Specifies the Combo item information.
 * @param[in] puiOptgroupID Holds the unique group id that is created.
 * @see jdd_MMIComboBoxDeleteOptgroup
 */
JC_RETCODE jdd_MMIComboBoxCreateOptgroup (JC_UINT32 uiWindowID, JC_UINT32 uiControlID,
										  JC_COMBO_BOX_ITEM		*pstComboItem,
										  JC_UINT32				*puiOptgroupID) ;