jdd_mmidatatype.h.svn-base

gif to bmp conversion

    E_OUTSET_BORDER /**< Specifies a raised border. The effect depends on the border-color value. */
} E_BORDER_STYLE ;
 
/**
 * @brief This enumeration contains the different icon type.
 */
typedef enum e_icon_type
{
	E_DISC, /**< Specifies the icon type is disc. */
	E_CIRCLE, /**< Specifies the icon type is circle. */
	E_SQUARE /**< Specifies the icon type is square. */
} EIconType, E_ICON_TYPE ;

/**
 * @brief This enumeration contains different object type that can be specified when creating the object control. 
 */
typedef enum e_object_mime_type
{
	E_OBJECT_IMAGE, /**< Specifies the object type is image. */
	E_OBJECT_AUDIO, /**< Specifies the object type is audio. */
	E_OBJECT_VIDEO, /**< Specifies the object type is video. */
	E_OBJECT_OTHER /**< Specifies the unknown object type. */
} E_OBJECT_MIME_TYPE ;

/**
 * @brief This enumeration describes the different font style that can be applied when creating the control. 
 *
 * If any of the font styles are not supported, the best effort rendering 
 * should be supported by the platform.
 */
typedef enum e_mmi_font_style
{
	E_FONT_NORMAL, /**< Specifies the normal font style. */
	E_FONT_ITALIC, /**< Specifies the italic font style. */
	E_FONT_OBLIQUE /**< Specifies the oblique font style. */
} E_FONT_STYLE ;

/**
 * @brief This enumeration describes the different action associated with the object control. 
 * 
 * Not all the object type need to implement, only applicable object like audio and video may need
 * to implement these object action. 
 */
typedef enum e_object_action
{
	E_OBJECT_PLAY, /**< Specifies that the action has to be performed to play the object content. */
	E_OBJECT_PAUSE, /**< Specifies that the action has to be paused */
	E_OBJECT_RESUME, /**< Specifies that the action has to be resumed. */
	E_OBJECT_STOP /**< Specifies that the action has to be stopped. */
} E_OBJECT_ACTION ;

/**
 * @brief This enumeration describes the different text decoration that can be applied.
 */
typedef enum e_mmi_test_decoration
{
	E_DECN_NONE, /**< Specifies the empty text decoration. */
	E_DECN_UNDERLINE, /**< Specifies the underline text decoration, where the font needs to created with the underlined text, when this property is specified. */
	E_DECN_OVERLINE, /**< Specifies the overline text decoration. */
	E_DECN_LINE_THROUGH /**< Specifies the linethrough text decoration. */
} E_TEXT_DECORATION ;

typedef enum e_stylus_action
{
	E_STYLUS_TAP,
	E_STYLUS_DBL_TAP
}E_STYLE_ACTION ;

/**
 * @brief This structure defines the style attribute that is specified when creating the control.
 *
 */
typedef struct st_jc_style
{
	JC_UINT32			uiFontSize ; /**< Specifies the size of the font which need to be applied for the style. */
	JC_INT32			iForegroundColor ; /**< Specifies the foreground color of the style, if it is less than zero then this value shall be ignored. */
	JC_INT32			iBackgroundColor ; /**< Specifies the background color of the style, if it is less than zero then this value shall be ignored. */
	JC_INT32			iFontID ; /**< Specifies the font ID, which has got from #jdd_MMIIsFontAvailable. */
	JC_UINT16			uhFontWeight ; /**< Specifies the font weight. */
	JC_UINT16			uhMagnification ; /**< Specifies the magnification factor. */
	E_FONT_STYLE		eFontStyle ; /**< Specifies the font style. */
	E_TEXT_DECORATION	eTextDecoration ; /**< Specifies the font decoration. */
#ifdef FUTURE_USAGE
	JC_UINT32			uiReserved ; /**< Reserved for future use. */
#endif
} JC_STYLE ;

/**
 * @brief This structure contains the text metrics information, where it is used to calculate the required metrics for displaying the specified text.
 */
typedef struct st_text_metrics
{
	JC_UINT32 uiWidth ; /**< Specifies the width of the number of characters that can be rendered. */
	JC_UINT32 uiHeight ; /**< Specifies the height of the number of characters that can be rendered. */
	JC_UINT32 uiNumCharacters ; /**< Specifies the number of characters that can be rendered for the specified width. */
} JC_TEXTMETRICS ;

/** 
 * @brief This structure defines the Cartesian co-ordinates of the point.
 */
typedef struct st_jc_point
{
	JC_UINT32 uiX ; /**< Specifies the x-coordinate of the point. */
	JC_UINT32 uiY ; /**< Specifies the y-coordinate of the point. */
} JC_POINT ;

/**
 * @brief This structure defines the co-ordinates of the upper-left, width and height of the rectangle. 
 */
typedef struct st_jc_rect
{
	JC_INT32 iLeft ; /**< Specifies the x-coordinate of the upper-left corner of the rectangle. */
	JC_INT32 iTop ; /**< Specifies the y-coordinate of the upper-left corner of the rectangle. */
	JC_UINT32 uiWidth ; /**< Specifies the width of the rectangle. */
	JC_UINT32 uiHeight ; /**< Specifies the height of the rectangle. */
} JC_RECT ;

/**
 * @brief This structure contains the image information.
 */
typedef struct st_image_info
{
	JC_UINT8 *pImgBuffer ; /**< Specifies the content of the image. */
	JC_UINT32 uiImgSize ; /**< Specifies the size of the image content. */
	JC_INT8 *psMimeType ; /**< Specifies the mime type of the image content, in case of NULL, the device needs to parse the image content to find the mime type. */
	EWallpaperProperty eProperty ; /**< Specifies the wall paper property. */
} JC_IMAGE_INFO ;

/**
 * @brief This structure contains the video control information. 
 *
 * @deprecated This structure is deprecated and recommended to use JC_OBJECT_INFO. 
 */
typedef struct st_video_info
{
	JC_UINT8 *pVideoBuffer ; /**< Specifies the content of the video. */
	JC_UINT32 uiVideoSize ; /**< Specifies the size of the video content. */
	JC_INT8 *psMimeType ; /**< Specifies the content type of the video. */ 
} JC_VIDEOCONTROL_INFO ;

/**
 * @brief Contains the object data either as an memory reference or persistent storage reference.
 */ 
typedef union u_object_buffer
{
	JC_UINT8		*pucBuffer ; /**< Specifies the memory reference to the object content. */
	JC_CHAR			*pmFileName ; /**< Specifies the file reference to the object content. */
} U_OBJECT_BUFFER ;

/**
 * @brief This structure contains the information about the object control. 
 */
typedef struct st_object_info
{
	JC_BOOLEAN			bIsFileContent ; /**< Specifies the object content available in memory or file.*/
	U_OBJECT_BUFFER		uBuffer ; /**< Specifies the mode of content (memory/file). */
	JC_UINT32			uiObjectLen ; /**< Specifies the size of the object. */
	JC_UINT32			uiTotalLen ; /**< Specifies the total length of the object */
	JC_BOOLEAN			bHasMoreData ; /**< Specifies more data flag */
	JC_INT8				*psMimeType ; /**< Specifies the mime type of the object. */
	E_OBJECT_MIME_TYPE	eType ; /**< Specifies the object mime type. */
	JC_HANDLE			vHandle ; /**< Specifies the handle associated with the object. Depending upon the application nature, this should be applied. */
} JC_OBJECT_INFO ;

/**
 * @brief This structure contains the information about more object control
 */
typedef struct st_object_more
{
	JC_UINT8			*pucBuffer ; /**< Specifies the reference to the buffer */
	JC_UINT32			uiBufLen ;  /**< Specifies the current buffer length */
	JC_BOOLEAN			bHasMoreData ; /**< Specifies the  more data flag */
	JC_RETCODE			rCode ; /**< Specifies the error code if any */
} JC_OBJECT_MORE ;


/**
 * @brief This structure contains the information about the object text control . 
 */
typedef struct st_object_text
{
	JC_CHAR			*pmURI ;
	JC_CHAR			*pmType ;
} JC_OBJECT_TEXT ;

/**
 * @brief This structure contains the pictogram information.
 */
typedef struct st_pictogram_info
{
	JC_CHAR *pmURL ; /**< Specifies the pictogram URL. */
} JC_PICTOGRAM_INFO ;

/**
 * @brief This structure contains the information about the icon information.
 */
typedef struct st_icon_info
{
	EIconType eType ; /**< Specifies the icon type. */
} JC_ICON_INFO ;

/**
 * @brief This structure contains the marquee text control properties.
 */
typedef struct st_marquee
{
	EMarqueeStyle eStyle ; /**< Specifies the marquee style. If the marquee style is E_MARQUEE_ALTERNATE, the alignment should be based on the number of iteration. The text should be aligned where the iteration stops irrespective of the eDirection. */
	JC_INT32 iCount ; /**< Specifies the number of times the marquee needs to be rendered. If the value is zero, then the marquee should be treated as normal label and as per the direction the text needs to be aligned. If the value is -1, then the marquee needs to be rendered continuously. If the direction is left to right, then the text should right aligned when the marquee stops. If the direction is right to left, then the text should be left aligned when the marquee stops. */
	EMarqueeDirection eDirection ; /**< Specifies the direction for the marquee. */
	EMarqueeSpeed eSpeed ; /**< Specifies the speed for the marquee control. */
	JC_UINT32 uiBorder ; /**< Specifies the border size for the marquee control, in case of zero, the marquee control shall not have any border. */
} JC_MARQUEE ;

/**
 * @brief This structure contains the blink text control properties.
 */
typedef struct st_blink
{
	JC_UINT32 uiSpeed ; /**< Specifies the speed for the blink control. */
} JC_BLINK ;

/**
 * @brief This structure contains the text control properties.
 */
typedef struct st_text
{
	ETextStyle	etextStyle ; /**< Specifies the text style for the text control. */
	JC_MARQUEE	marqueeAttribute ; /**< Specifies the marquee attribute if the text style is of type Marquee control. */
	JC_BLINK	blinkAttribute ; /**< Specifies the blink attribute if the text style is of type Blink control. */
	JC_UINT32	uiTextLen ;
} JC_TEXT_BOX ;

/**
 * @brief This structure contains the input box properties.
 */
typedef struct st_input_box
{
	EInputBoxStyle einputBoxStyle ; /**< Specifies the input style for the input box control. */
	JC_UINT32 uiRows ; /**< Specifies the number of rows if the input style is multiline input box. */
	JC_UINT32 uiColumns ; /**< Specifies the number of columns if the input style is multi-line input box. */
	JC_CHAR *psInputFormat ; /**< Specifies the input format. */
	JC_INT32  iMaxLength ; /**< Specifies the maximum number of characters can be entered in the input box. */
	JC_CHAR *pDefaultValue ; /**< Specifies the initial value that needs to be set to the control. */
	JC_BOOLEAN bIsNotEditable ; /**< Specifies whether the input box is not editable. If it is E_TRUE, it should be displayed as disabled.*/
	JC_BOOLEAN bIsNotEmpty ; /**< Specifies whether the input box can be empty or not. */
} JC_INPUT_BOX ;

/**
 * @brief This structure contains the list box properties.
 */
typedef struct st_list_box
{
	JC_UINT32 uiNumberItems ; /**< Specifies the number of items in the list box. */
	JC_UINT32 uiOptgroupCount ; /**< Specifies the number of opt groups present in the list box. */
	JC_UINT32 uiVisibleRows ; /**< Specifies the no of visible rows in the list box. */
	E_LIST_STYLE listStyle ; /**< Specifies the style property for the list box. */
} JC_LIST_BOX ;

/**
 * @brief This structure contains the list box item properties.
 */
typedef struct st_list_box_item
{
	JC_UINT32		uiIndexItem ; /**< Specifies the index of the item in the opt group. */
	JC_CHAR			*psText ; /**< Specifies the text of the list item. */
	JC_UINT32		uiOptgroupId ; /**< Specifies the opt group id to which this item belongs. */
	JC_BOOLEAN		bIsEnabled ; /**< Specifies if the item is enabled or not. */
	JC_IMAGE_INFO	*pImageInfo ; /**< Specifies the image info if the item is an image. */
} JC_LIST_BOX_ITEM ;

/**
 * @brief This structure contains the radio box properties.
 */
typedef struct st_radio_box
{
	JC_UINT32 uiGroupID ; /**< Specifies the group identifier for the radio box. */
	E_OPTIONBOX_STATUS eStatus ; /**< Specifies the radio box status. */
} JC_RADIO_BOX ;

/**
 * @brief This structure contains the check box properties.
 */
typedef struct st_check_box
{
	E_OPTIONBOX_STATUS eStatus ; /**< Specifies the check box status. */
} JC_CHECK_BOX ;

/**
 * @brief This structure contains the combo box properties.
 */
typedef struct st_combo_box
{
	JC_UINT32 uiNumberItems ; /**< Specifies the number of items for the combo box. */
	JC_UINT32 uiOptgroupCount ; /**< Specifies the total number of opt groups. */
} JC_COMBO_BOX ;

/**
 * @brief This structure contains the combo box item properties.
 */
typedef struct st_combo_box_item
{
	JC_UINT32		uiIndexItem ; /**< Specifies the index of the item in the opt group. */
	JC_UINT32		uiOptgroupId ; /**< Specifies the opt group id to which this item belongs. */
	JC_BOOLEAN		bIsEnabled ; /**< Specifies if the item is enabled or not. */