jdd_mmiapi.h.svn-base

gif to bmp conversion

/**
 * @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 optgroup identifier that needs to be freed.
 * @see jdd_MMIComboBoxCreateOptgroup
 */
JC_RETCODE jdd_MMIComboBoxDeleteOptgroup (JC_UINT32		uiWindowID,
										  JC_UINT32		uiControlID,
										  JC_UINT32		uiOptgroupID) ;
/**
 * @brief This function sets the text for the individual items of the combo box. 
 * @param[in] uiWindowID Specifies the Window identifier.
 * @param[in] uiControlID Specifies the control identifier.
 * @param[in] pstComboItem Specifies the reference to the combo item information.
 * The item can be option group or option item. 
 */
JC_RETCODE jdd_MMIComboBoxSetTextItemOpt (JC_UINT32 uiWindowID, JC_UINT32 uiControlID,
										  const JC_COMBO_BOX_ITEM *pstComboItem) ;
/**
 * @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] iSelectedIndex Specifies the index of the combo box that needs to be selected.
 */
JC_RETCODE jdd_MMIComboBoxSetItem (JC_UINT32 uiWindowID,
								   JC_UINT32 uiControlID,
								   JC_INT32 iSelectedIndex) ;
/**
 * @brief This function gets the index that is selected for the combo box.
 * @param[in] uiWindowID Specifies the Window identifier.
 * @param[in] uiControlID Specifies the control identifier.
 * @param[out] piSelectedIndex Provides the index of the combo box that is selected.
 */
JC_RETCODE jdd_MMIComboBoxGetItem (JC_UINT32 uiWindowID, JC_UINT32 uiControlID,
								   JC_INT32 *piSelectedIndex) ;
/** End of Combo Box **/

/** Scrollbar **/
/**
 * @brief This function sets the scrollbar information to the specific scrollbar.
 * @param[in] uiWindowID Specifies the Window identifier.
 * @param[in] uiControlID Specifies the control identifier.
 * @param[in] pstScrollInfo Specifies the scroll bar information.
 */
JC_RETCODE jdd_MMISetScrollInfo (JC_UINT32 uiWindowID,
								 JC_UINT32 uiControlID,
								 const SCROLL_INFO *pstScrollInfo) ;

/**
 * @brief This function gets the scrollbar information to the specific scrollbar.
 * @param[in] uiWindowID Specifies the Window identifier.
 * @param[in] uiControlID Specifies the control identifier.
 * @param[out] pstScrollInfo Provides the scroll bar information
 */
JC_RETCODE jdd_MMIGetScrollInfo (JC_UINT32		uiWindowID,
								 JC_UINT32		uiControlID,
								 SCROLL_INFO	*pstScrollInfo) ;
/** End of Scrollbar **/

/** Softkeys **/
/**
 * @brief This function returns the number of soft keys that are available in the platform.
 * @param[in] uiWindowID Specifies the Window identifier
 * @param[out] puiNumSoftKeys Provides the number of soft key that are available in the platform for the specified window.
 */
JC_RETCODE jdd_MMIGetNumberOfSoftKeys (JC_UINT32 uiWindowID,
									   JC_UINT32 *puiNumSoftKeys) ;
/**
 * @brief This function sets the label for the soft key.
 * @param[in] uiWindowID Specifies the Window identifier
 * @param[in] uiSoftKeyIndex Specifies the index of the soft key label. The Index starts from 0. 
 * @param[in] pmSoftKeyLabel Specifies the string for the soft key label.
 */
JC_RETCODE jdd_MMISetSoftKeyLabel (JC_UINT32 uiWindowID, 
								   JC_UINT32 uiSoftKeyIndex, 
								   const JC_CHAR *pmSoftKeyLabel) ;
/** End of Softkeys **/

/** Object **/
/**
 * @brief This function should return the width and height of the image without fully decoding the image buffer. 
 * @param[in] uiWindowID Specifies the Window identifier.
 * @param[in] pstImageInfo Specifies the mime type, content and size of the image.
 * @param[out] puiWidth Provides the width that is required to render this image.
 * @param[out] puiHeight Provides the height that is required to render this image.
 */
JC_RETCODE jdd_MMIGetImageSize (JC_UINT32		uiWindowID,
								JC_IMAGE_INFO	*pstImageInfo, 
								JC_UINT32		*puiWidth, 
								JC_UINT32		*puiHeight) ;
/**
 * @brief This function should return the width and height of the image where the image content resides in the file system. 
 * @param[in] uiWindowID Specifies the Window identifier.
 * @param[in] pmFileName Specifies the image filename.
 * @param[out] puiWidth Provides the width that is required to render this image.
 * @param[out] puiHeight Provides the height that is required to render this image.
 */
JC_RETCODE jdd_MMIGetFileStreamImageSize (JC_UINT32 uiWindowID,
										  JC_CHAR	*pmFileName, 
										  JC_UINT32 *puiWidth, 
										  JC_UINT32 *puiHeight) ;
/**
 * @brief This function checks if the given URL is present in the pictogram list. 
 * @param[in] pmPictURL Specifies the URL that should be checked for the pictogram
 * 
 * Returns E_TRUE if the given URL is present in the list and E_FALSE otherwise. 
 * If the device does not support pictogram then this function can return E_FALSE.
 */
JC_BOOLEAN jdd_MMIIsPictogram (JC_CHAR *pmPictURL) ;

/**
 * @brief This function obtains the width and height of the pictogram specified by the URL.
 * @param[in] uiWindowID Specifies the Window identifier
 * @param[in] pmURI Specifies the pictogram URI.
 * @param[out] puiWidth Provides the width that is required to render this pictogram image.
 * @param[out] puiHeight Provides the height that is required to render this pictogram image.
 */
JC_RETCODE jdd_MMIGetPictogramSize (JC_UINT32  uiWindowID,
									JC_CHAR		*pmURI,
									JC_UINT32	*puiWidth,
									JC_UINT32	*puiHeight) ;
/**
 * @brief This function provides the count of the different icons that are being used.
 * 
 */
JC_UINT32 jdd_MMIGetIconCount (void) ;

/**
 * @brief This function provides the size of the given icon type.
 * @param[in] uiWindowID Specifies the Window identifier.
 * @param[in] eType Specifies the icon type.
 * @param[out] puiWidth Provides the width that is required to render this icon image.
 * @param[out] puiHeight Provides the height that is required to render this icon image.
 */
JC_RETCODE jdd_MMIGetIconSize (JC_UINT32	uiWindowID, 
							   EIconType	eType,
							   JC_UINT32	*puiWidth, 
							   JC_UINT32	*puiHeight) ;
/**
 * @brief This function gets the dimensions of the object specified.
 * @param[in] uiWindowID Specifies the Window identifier.
 * @param[in] pstObjectInfo Specifies the information about the object 
 * @param[in] vObjectHandle Specifies the object handle associated to this object, should be used when 
 *							this API is implemented as a non-blocking call.
 * @param[out] puiWidth Provides the width that is required to render this object.
 * @param[out] puiHeight Provides the height that is required to render this object.
 * @param[in] puiObjectID Provides the object identifier, if it is implemented as non-blocking call.
 * @see jdd_MMIFreeObjectSize 
 */
JC_RETCODE jdd_MMIGetObjectSize (JC_UINT32			uiWindowID,
								 JC_OBJECT_INFO		*pstObjectInfo, 
								 JC_HANDLE			vObjectHandle,
								 JC_UINT32			*puiWidth,
								 JC_UINT32			*puiHeight,
								 JC_UINT32			*puiObjectID) ;
/**
 * @brief This function free's the reference that is allocated while calculating the object size.
 * @param[in] uiWindowID Specifies the Window identifier
 * @param[in] uiObjectID Specifies the object identifier
 * @see jdd_MMIGetObjectSize
 */
void jdd_MMIFreeObjectSize (JC_UINT32		uiWindowID,
							JC_UINT32		uiObjectID) ;
/**
 * @brief This function performs the specified action on the given object.
 * @param[in] uiWindowID Specifies the Window identifier.
 * @param[in] uiControlID Specifies the control identifier.
 * @param[in] eAction Specifies the action type.
 */
JC_RETCODE jdd_MMIObjectAction (JC_UINT32			uiWindowID,
								JC_UINT32			uiControlID,
								E_OBJECT_ACTION		eAction) ;

/**
 * @brief This function gets the duration of the object action.
 * @param[in] uiWindowID Specifies the Window identifier.
 * @param[in] uiControlID Specifies the control identifier.
 * @param[out] piDuration Returns duration value of the object action.
 */
JC_RETCODE jdd_MMIGetObjectDuration (JC_UINT32		uiWindowID,
									 JC_UINT32		uiControlID,
									 JC_INT32		*piDuration) ;

/**
 * @brief This function sets the object content more
 * @param[in] uiWindowID    Specifies the Window identifier
 * @param[in] uiControlID   Specifies the control identifier
 * @param[in] pstObjectMore Specifies the reference to the object more content
 */
JC_RETCODE jdd_MMIObjectContentMore (JC_UINT32		uiWindowID,
									 JC_UINT32		uiControlID,
									 JC_OBJECT_MORE	*pstObjectMore) ;

/** end of object **/

/** Others **/
/**
 * @brief This function displays the notification message either information message or error message depending on the enumeration type. 
 * @param[in] iRCode Specifies the information message need to be displayed according to the return code.
 * @param[in] eType Specifies the type of message.
 * @param[in] cbInfoFnc Specifies the callback function.
 * @param[in] pvArg Specifies the callback argument.
 * 
 * The callback function should be used only when this function is implemented as a non-blocking call. 
 */
JC_RETCODE jdd_MMINotificationMessage (JC_INT32					iRCode, 
									   EMMINotificationMsgType	eType, 
									   JDD_MMI_INFORMATION_CB	cbInfoFnc, 
									   void						*pvArg) ;

/**
 * @brief This function displays the confirmation message either "Ok/Cancel" or "Yes/No" depending on the enumeration type. 
 * @param[in] pmChar Specifies the string.
 * @param[in] eType Specifies the type of message.
 * @param[in] cbConfFnc Specifies the callback function.
 * @param[in] pvArg Specifies the callback argument.
 * If the environment does not support the blocking information message to be rendered the MMI should invoke the callback function with the argument once the notification message is closed.
 */
JC_RETCODE jdd_MMIConfirmationMessage (JC_CHAR					*pmChar, 
									   EMMIConfirmationMsgType	eType, 
									   JDD_MMI_CONFIRMATION_CB	cbConfFnc, 
									   void						*pvArg) ;
/** End of Others **/

/**
 * @}
 */

#ifdef __cplusplus
}
#endif

#endif

/* END OF FILE */