jdd_mmidatatype.h.svn-base

gif to bmp conversion

	JC_CHAR			*psText ; /**< Specifies the text of the combo item. */
} JC_COMBO_BOX_ITEM ;

/**
 * @brief This structure contains the scrollbar properties.
 */
typedef struct st_scrollbar
{
	EScrollBarType eScrollBarType ; /**< Specifies the type of the scrollbar. */
} JC_SCROLL_BAR ;

/**
 * @brief This structure contains the border properties. 
 */
typedef struct st_border_props
{
    JC_UINT32 uiLeftBorderWidth ; /**< Specifies the width of the left side of the rectangle border. */
    JC_INT32 iLeftBorderColor ; /**< Specifies the color of the left side of the rectangle border. */
    E_BORDER_STYLE iLeftBorderStyle ; /**< Specifies the border style of the left side of the rectangle border. */
    JC_UINT32 uiRightBorderWidth ; /**< Specifies the width of the right side of the rectangle border. */
    JC_INT32 iRightBorderColor ; /**< Specifies the color of the right side of the rectangle border.*/
    E_BORDER_STYLE iRightBorderStyle ; /**< Specifies the border style of the right side of the rectangle border. */
    JC_UINT32 uiTopBorderWidth ; /**< Specifies the width of the top side of the rectangle border. */
    JC_INT32 iTopBorderColor ; /**< Specifies the color of the top side of the rectangle border. */
    E_BORDER_STYLE iTopBorderStyle ; /**< Specifies the border style of the top side of the rectangle border. */
    JC_UINT32 uiBottomBorderWidth ; /**< Specifies the width of the bottom side of the rectangle border. */
    JC_INT32 iBottomBorderColor ; /**< Specifies the color of the bottom side of the rectangle border. */
    E_BORDER_STYLE iBottomBorderStyle ; /**< Specifies the border style of the bottom side of the rectangle border. */
} JC_BORDER_PROPS ;

/**
 * @brief This structure contains the rectangle properties.
 */
typedef struct st_rect_info 
{
	JC_BORDER_PROPS		stBorderProp ; /**< Specifies the border properties for the rectangle. */
} JC_RECT_INFO ;

/**
 * @brief This structure contains the generic control properties, which shall be used in the jdd_MMICreateControl function.
 */
typedef struct st_control_properties
{
	JC_CHAR			*psCaptionValue ; /**< Specifies the caption for the specific control. */
	JC_STYLE		controlStyle ; /**< Specifies the style attribute which needs to be applied for the control. */
	JC_BOOLEAN		bIsSelectable ; /**< Specifies whether the control is selectable while scrolling. */
	ERenderingStyle eRenderingStyle ; /**< Specifies the style of rendering. */
	JC_IMAGE_INFO	activeImageAttribute ; /**< Reserved for future usage. */
	JC_IMAGE_INFO	inactiveImageAttribute ; /**< Reserved for future usage. */
	JC_UINT32		eEventCode ; /**< Specifies the event code that can be used by the MMI to generate the event. If the value is zero, the MMI need to generate the default event value for the specific control. */
	JC_INT32		iMaxWidth ; /**< Specifies the maximum width that needs to be used by this control. */
	JC_BOOLEAN		bReturnDimension ; /**< Specifies whether only the dimension needs to be generated instead of creating the actual controls, when this flag is set to E_TRUE. */
	JC_BOOLEAN		bIsDisabled ; /**< Specifies whether the control needs to be disabled for selection. */
	union
	{
		JC_TEXT_BOX				textBox ; /**< Specifies the text box control properties. */
		JC_INPUT_BOX			inputBox ; /**< Specifies the input box control properties. */
		JC_LIST_BOX				listBox ; /**< Specifies the list box control properties. */
 		JC_RADIO_BOX			radioBox ; /**< Specifies the radio box control properties. */
		JC_CHECK_BOX			checkBox ; /**< Specifies the check box control properties. */
		JC_COMBO_BOX			comboBox ; /**< Specifies the combo box control properties. */
		JC_SCROLL_BAR			scrollBar ; /**< Specifies the scroll bar control properties. */
		JC_IMAGE_INFO			image ; /**< Specifies the image control properties. */
		JC_VIDEOCONTROL_INFO	video ; /**< Specifies the video control properties. */
		JC_OBJECT_INFO			object ; /**< Specifies the object control properties. */
		JC_OBJECT_TEXT			objectText ; /**< Specifies the object text control properties */
		JC_PICTOGRAM_INFO		pictogram ; /**< Specifies the pictogram control properties. */
		JC_ICON_INFO			icon ; /**< Specifies the icon control properties. */
		JC_RECT_INFO			rect ; /**< Specifies the rect control properties. */
	} typeOfControl ; /**< Specifies the individual control properties. */
	JC_UINT32 uiReserved ; /**< Reserved for future usage. */
} JC_CONTROL_PROPERTIES ;

/**
 * @brief This structure contains the property for the window style.
 */
typedef struct st_window_props
{
	EWindowStyle	eWindowStyle ; /**< Specifies the style of the window. */
	JC_CHAR 		*pszCaptionValue ; /**< Specifies title for the window. */
	JC_TASK_INFO	srcTaskInfo ; /**< Specifies the source task information. */
	JC_TASK_INFO	destTaskInfo ; /**< Specifies the destination task information. */
	JC_UINT32		uiParentID ; /**< Specifies the parent window id. */
	JC_BORDER_PROPS	stBorderProp ; /**< Specifies the border properties of the window. */
	void			*pApplicationData ; /**< Reserved for future usage. */
	JC_UINT32		uiResourceID ; /**< Specifies the resource id. */
	JC_UINT32 		uiReserved ; /**< Reserved for future usage. */
} JC_WINDOW_PROPERTIES ;

/**
 * @brief This structure contains the scrolling information. 
 */
typedef struct st_scroll_info
{
	JC_UINT32 uiMinPos ; /**< Specifies the minimum position of the scrollbar. */
	JC_UINT32 uiMaxPos ; /**< Specifies the maximum position of the scrollbar. */
	JC_UINT32 uiPageSize ; /**< Specifies the maximum size of the page. */
	JC_UINT32 uiCurrPos ; /**< Specifies the current position. */
	JC_BOOLEAN bIsScrollDown ; /**< Specifies whether the scroll down is possible or not. */
	JC_BOOLEAN bIsScrollUp ; /**< Specifies whether the scroll up is possible or not. */
} SCROLL_INFO ;

/**
 * @brief This structure contains the device characteristics information. 
 */
typedef struct st_device_characteristics
{
	JC_UINT32 uiActualWidth ; /**< Specifies the actual width of the device. */
	JC_UINT32 uiActualHeight ; /**< Specifies the actual height of the device. */
	JC_UINT32 uiRenderingWidth ; /**< Specifies the width which needs to be used for rendering. */
	JC_UINT32 uiRenderingHeight ; /**< Specifies the height which needs to be used for rendering. */
	JC_UINT32 uiScrollBarWidth ; /*< Specifies the scrollbar width. */
	JC_UINT32 uiScrollBarHeight ; /**< Specifies the scrollbar height. */
	JC_UINT32 uiLeftMargin ; /**< Specifies the left margin. */
	JC_UINT32 uiTopMargin ; /**< Specifies the top margin. */
	JC_UINT32 uiWindowX ; /**< Specifies the x axis. */
	JC_UINT32 uiWindowY ; /**< Specifies the y axis. */
	JC_BOOLEAN bIsChildWindowSupported ; /**< Specifies whether platform support child window. */
	JC_BOOLEAN bIsHorizontalScrollSupported ; /**< Specifies whether platform support horizontal scroll bar. */
	JC_BOOLEAN bIsSoftKeySupported ; /**< Specifies whether the platform support any soft key label. */
} DeviceCharacteristics, DEVICE_CHARACTERISTICS ;

/**
 * @brief This structure defines the input event structure when there is any event that needs to be generated for the E_INPUT_BOX control type. 
 * It contains the key event type and the ASCII value of the key that is pressed. 
 */
typedef struct st_input_event
{
	JC_UINT32 uiKeyValue ; /**< Specifies the ascii value that is specified. */
} JC_INPUT_EVENT ;

/**
 * @brief This structure defines the check event structure when there is any event that needs to be generated for the E_CHECK_BOX control type. 
 * The check box control generates event when there is any change in the selection status.
 */
typedef struct st_check_event
{
	E_OPTIONBOX_STATUS eStatus ; /**< Specifies the E_CHECK_BOX status. */
} JC_CHECK_BOX_EVENT ;

/** 
 * @brief This structure defines the radio event structure when there is any event that needs to be generated for the E_RADIO_BOX control type. 
 * When there is any change in the selection of the radio box this control should generate this event. 
 */
typedef struct st_radio_event
{
	E_OPTIONBOX_STATUS eStatus ; /**< Specifies the E_RADIO_BOX status. */ 
} JC_RADIO_BOX_EVENT ;

/** 
 * @brief This structure defines the list box event structure when there is any event that needs to be generated for the E_LIST_BOX control type. 
 * If any of the list box item is selected/deselected this event need to be generated with the specific index that has been modified. 
 */
typedef struct st_list_event
{
	JC_UINT32 uiIndex ; /**< Specifies the index in the list box, which got changed. */
	JC_BOOLEAN bIsSelected ; /**< Specifies whether the index has been selected or not. */
} JC_LIST_BOX_EVENT ;

/** 
 * @brief This structure defines the combo box event structure when there is any event that needs to be generated for the E_COMBO_BOX control type. 
 * If there is any change in the combo box state the control generates the event with the newly selected index and the previously selected index. 
 */
typedef struct st_combobox_event
{
	JC_UINT32 uiSelectedIndex ; /**< Specifies the index, which has been selected in the combo box. */
	JC_UINT32 uiDeSelectedIndex ; /**< Specifies the index, which has been deselected because of this combo box. */
} JC_COMBO_BOX_EVENT ;

/** 
 * @brief This structure defines the soft key event structure when the user has selected the soft key. 
 * The particular soft key index needs to be passed on to the application.
 */
typedef struct st_softkey_event 
{
	JC_UINT32 uiSoftKeyIndex ; /**< Specifies the soft key index.*/
} JC_SOFT_KEY_EVENT ;

/** 
 * @brief This structure defines the access key event.
 */
typedef struct st_accesskey_event 
{
	JC_UINT32 uiAccessKeyIndex ; /**< Specifies the access key index. */
} JC_ACCESS_KEY_EVENT ;

/** 
 * @brief This is the generic event structure that shall be generated by the MMI layer to the application layer for any event in the MMI.
 */
typedef struct st_mmi_event
{
	JC_UINT32 uiWindowID ; /**< Specifies the window's identifier. */
	JC_UINT32 uiControlID ; /**< Specifies the control identifier. */
	EMMIEventType eEventType ; /**< Specifies the event type. */
	union
	{
		JC_INPUT_EVENT 		inputEvent ; /**< Specifies the input event. */
		JC_CHECK_BOX_EVENT 	checkBoxEvent ; /**< Specifies the check box event. */
		JC_RADIO_BOX_EVENT 	radioBoxEvent ; /**< Specifies the radio box event. */
		JC_LIST_BOX_EVENT 	listBoxEvent ; /**< Specifies the list box event. */
		JC_COMBO_BOX_EVENT 	comboBoxEvent ; /**< Specifies the combox box event. */
		JC_SOFT_KEY_EVENT 	softKeyEvent ; /**< Specifies the soft key event. */
		JC_ACCESS_KEY_EVENT	accessKeyEvent ; /**< Specifies the access key event. */
	} eventData ; /**< Specifies the event data. */
} JC_MMI_EVENT ;

/** 
 * @brief This structure defines the stylus event. 
 */
typedef struct st_stylus_event
{
	JC_UINT32 uiWindowID ; /**< Specifies the window identifier, where the stylus or mouse has been activated. */
	E_STYLE_ACTION eStylusAction ;
	JC_UINT32 uiX ; /**< Specifies the x axis. */
	JC_UINT32 uiY ; /**< Specifies the y axis. */
} JC_STYLUS_EVENT ;

/** 
 * @brief When the computation of the control dimension is asynchronous then the application needs to post
 * the event with this structure.
 */
typedef struct st_ctrl_dimension
{
	JC_RETCODE			rCode ; /**< Specifies the status code for the computation of the control dimension. */
	JC_HANDLE			vObjectHandle ; /**< Specifies the reference that has been passed when creating the control. */
	JC_UINT32			uiWidth ; /**< Specifies the width of the control. */
	JC_UINT32			uiHeight ; /**< Specifies the height of the control. */
} JC_CONTROL_DIMENSION ;

/** 
 * @brief This callback function is registered with the #jdd_MMIConfirmationMessage. 
 * This function is called by the JDD layer when the confirmation message is implemented as a non-blocking call.
 * @param[in] eConfirmationStatus Specifies the confirmation status. 
 * @param[in] pvArg Specifies the argument that is passed when the confirmation message function is invoked. 
 */
typedef void (*JDD_MMI_CONFIRMATION_CB) (JC_BOOLEAN eConfirmationStatus, void *pvArg) ;

/** 
 * @brief This callback function is registered with the #jdd_MMINotificationMessage.
 * This function is called by the JDD layer when the notification message is implemented as a non-blocking call.
 * @param[in] pvArg Specifies the argument that is passed when the information message is invoked. 
 */
typedef void (*JDD_MMI_INFORMATION_CB) (void *pvArg) ;

/** 
 * @brief This specifies different enumeration that can be generated by the JDD layer.
 * These events vary from different to different. 
 */
typedef enum e_sec_ddl_event_type_
{
	E_F1_EVENT = 0x01, /**< This event occurs when "F1" key is pressed. */

	E_F2_EVENT, /**< This event occurs when "F2" key is pressed. */
	E_F3_EVENT, /**< This event occurs when "F3" key is pressed. */
	E_F4_EVENT, /**< This event occurs when "F4" key is pressed. */
	E_F6_EVENT, /**< This event occurs when "F6" key is pressed. */
	E_F7_EVENT, /**< This event occurs when "F7" key is pressed. */
	E_F8_EVENT, /**< This event occurs when "F8" key is pressed. */
	E_F9_EVENT, /**< This event occurs when "F9" key is pressed. */

	E_PRIMARY_MMI_EVENT, /**< This event is a "primary MMI" event. */
	E_F11_EVENT, /**< This event occurs when "F11" key is pressed. */

	E_VK_UP_EVENT, /**< This event occurs when the "up arrow" key is pressed. */
	E_VK_DOWN_EVENT, /**< This event occurs when the "down arrow" key is pressed. */
	E_VK_LEFT_EVENT, /**< This event occurs when the "left" key is pressed. */
	E_VK_RIGHT_EVENT, /**< This event occurs when the "right" key is pressed. */
	E_VK_PRIOR_EVENT, /**< This event occurs when the "page up" key is pressed. */
	E_VK_NEXT_EVENT, /**< This event occurs when the "page down" key is pressed. */
	E_VK_HOME_EVENT, /**< This event occurs when the "home" key is pressed. */
	E_VK_END_EVENT, /**< This event occurs when the "end" key is pressed. */
	E_VK_RETURN_EVENT , /**< This event occurs when the "enter" key is pressed. */
	E_VK_NUM0_EVENT, /**< This event occurs when the key '0' is pressed. */
	E_VK_NUM1_EVENT, /**< This event occurs when the key '1' is pressed. */
	E_VK_NUM2_EVENT, /**< This event occurs when the key '2' is pressed. */
	E_VK_NUM3_EVENT, /**< This event occurs when the key '3' is pressed. */
	E_VK_NUM4_EVENT, /**< This event occurs when the key '4' is pressed. */
	E_VK_NUM5_EVENT, /**< This event occurs when the key '5' is pressed. */
	E_VK_NUM6_EVENT, /**< This event occurs when the key '6' is pressed. */
	E_VK_NUM7_EVENT, /**< This event occurs when the key '7' is pressed. */
	E_VK_NUM8_EVENT, /**< This event occurs when the key '8' is pressed. */
	E_VK_NUM9_EVENT, /**< This event occurs when the key '9' is pressed. */
	E_VK_HASH_EVENT, /**< This event occurs when the key '#' is pressed. */
	E_VK_STAR_EVENT, /**< This event occurs when the key '*' is pressed. */
	
	E_STYLUS_EVENT, /**< This event occurs when an action is performed with the stylus. */
	E_CTRL_ASYNC_EVENT, /**< This event occurs when an control async event is performed. */

	E_F12_EVENT, /**< This event occurs when "F12" key is pressed. */

	E_CBN_SELCHANGE_EVENT, /**< This event is generated when change event occurs. */
	E_DISPLAY_REFRESH_EVENT, /**< This event occurs when a window is refreshed. */
	E_RESIZE_EVENT, /**< This event occurs when a window is resized. */
	E_CLOSE_EVENT, /**< This event occurs when a window is closed. */
	E_SHUTDOWN_EVENT, /**< This event occurs when the application is closed. */

	E_TOTAL_EVENTS /**< Not used for events. */

} ESecondaryDDLEventType, E_SECONDARY_DDL_EVENTTYPE ;

#endif

/* END OF FILE */