jdd_mmidatatype.h.svn-base

gif to bmp conversion

/***************************************************************************
 * $Id: jdd_mmidatatype.h,v 1.50 2008/07/02 13:10:25 kawalccjims Exp $
 * $Revision: 1.50 $
 * $DateTime: $
 * 
 * IMPORTANT NOTICE
 *
 * Please note that any and all title and/or intellectual property rights 
 * in and to this Software or any part of this (including without limitation 
 * any images, photographs, animations, video, audio, music, text and/or 
 * "applets," incorporated into the Software), herein mentioned to as 
 * "Software", the accompanying printed materials, and any copies of the 
 * Software, are owned by Jataayu Software (P) Ltd., Bangalore ("Jataayu") 
 * or Jataayu's suppliers as the case may be. The Software is protected by 
 * copyright, including without limitation by applicable copyright laws, 
 * international treaty provisions, other intellectual property laws and 
 * applicable laws in the country in which the Software is being used. 
 * You shall not modify, adapt or translate the Software, without prior 
 * express written consent from Jataayu. You shall not reverse engineer, 
 * decompile, disassemble or otherwise alter the Software, except and 
 * only to the extent that such activity is expressly permitted by 
 * applicable law notwithstanding this limitation. Unauthorized reproduction 
 * or redistribution of this program or any portion of it may result in severe 
 * civil and criminal penalties and will be prosecuted to the maximum extent 
 * possible under the law. Jataayu reserves all rights not expressly granted. 
 * 
 * THIS SOFTWARE IS PROVIDED TO YOU "AS IS" WITHOUT WARRANTY OF ANY 
 * KIND AND ANY AND ALL REPRESENTATION AND WARRANTIES, EITHER EXPRESS 
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF 
 * MERCHANTABILITY ACCURACY OF INFORMATIONAL CONTENT, AND/OR FITNESS 
 * FOR A PARTICULAR PURPOSE OR USE, TITLE OR INFRINGEMENT ARE EXPRESSLY 
 * DISCLAIMED TO THE FULLEST EXTENT PERMITTED BY LAW. YOU ASSUME THE 
 * ENTIRE RISK AS TO THE ACCURACY AND THE USE OF THIS SOFTWARE. JATAAYU 
 * SHALL NOT BE LIABLE FOR ANY CONSEQUENTIAL, INCIDENTAL, INDIRECT, 
 * EXEMPLARY, SPECIAL OR PUNITIVE DAMAGES INCLUDING WITHOUT LIMITATION 
 * ANY LOSS OF DATA, OR; LOSS OF PROFIT, SAVINGS BUSINESS OR GOODWILL 
 * OR OTHER SIMILAR LOSS RESULTING FROM OR OUT OF THE USE OR INABILITY 
 * TO USE THIS SOFTWARE, EVEN IF JATAAYU HAS BEEN ADVISED OF THE 
 * POSSIBILITY OF SUCH DAMAGE, OR FOR ANY CLAIM BY ANY THIRD PARTY.
 *
 ***************************************************************************
 *
 * Revision Details
 * ----------------
 * $Log: jdd_mmidatatype.h,v $
 * Revision 1.50  2008/07/02 13:10:25  kawalccjims
 * *** empty log message ***
 *
 * 
 * 6     28/11/07 7:45p Anupr
 * 
 * 5     6/07/07 3:15p Anupr
 * 
 * 4     31/05/07 11:04a Anupr
 * 
 * 3     12/04/07 6:21p Anupr
 * 
 * 2     3/28/07 4:52p Vikhyath
 * Changed the value of STYLE_FONT_NAME_SIZE
 * 
 * 1     16/03/07 7:18p Anupr
 * Device Independent TreeView APIs
 * Revision 1.7  2007/01/12 11:18:05  browserdevjtbase
 * Update from the main base
 *
 * Revision 1.6  2006/11/29 13:09:24  browserdevjtbase
 * *** empty log message ***
 *
 * Revision 1.5  2006/11/16 11:32:26  browserdevjtbase
 * Update
 *
 * Revision 1.4  2006/07/03 07:26:11  browserdevjtbase
 * *** empty log message ***
 *
 * Revision 1.3  2006/06/20 13:28:37  browserdevjtbase
 * *** empty log message ***
 *
 * Revision 1.2  2006/05/02 11:19:21  kumardevjtbase
 * *** empty log message ***
 *
 * Revision 1.31  2006/02/28 11:00:53  kavithadevhtmlbrow
 * JC_CONTROL_DIMENSION and E_ASYNC_CTRL_EVENT added
 *
 * Revision 1.30  2006/01/31 07:47:17  kavithadevhtmlbrow
 * Stylus Datatype Updated
 *
 *  
 ***************************************************************************/

#ifndef _JDD_MMI_DATATYPE_H
#define _JDD_MMI_DATATYPE_H

/** 
 * @file jdd_mmidatatype.h
 * @ingroup MMI
 * @brief Describes the basic data type that are getting used in the
 * MMI abstraction API's
 */

/**
 * @brief Specifies the maximum size for the font name.
 */
#define STYLE_FONT_NAME_SIZE			25

/** @cond */
#define TRANSPARENT_VALUE				"transparent"
#define HASH_ACCESS_KEY					10
#define STAR_ACCESS_KEY					11
/** @endcond */

/**
 * @brief This enumeration contains the different window style that can be created using the 
 * jdd_MMICreateWindow. 
 */
typedef enum e_window_style
{
	E_MAIN_WINDOW, /**< Specifies the window style where it has the option for the title bar with a thin-line border separating the title area and the actual window space */
	E_CHILD_WINDOW, /**< Specifies the window style which is the child of the other window, the parent window can be created either using E_MAIN_WINDOW or E_CHILD_WINDOW itself */
	E_POPUP_WINDOW, /**< Specifies the pop-up window style */
	E_APPLICATION_WINDOW /**< Specifies the application level window */
} EWindowStyle, E_WINDOW_STYLE ;

/**
 * @brief This enumeration contains the different controls that can be created using the 
 * MMI abstraction layer. 
 */
typedef enum e_control_type
{
	E_TEXT_BOX, /**< A control that renders the text in the MMI. */
	E_INPUT_BOX, /**< A control that accepts input from the user. */
	E_BUTTON, /**< A control which allows the user to turn either on or off by selecting it. This control is called as push button or command button. */
	E_CHECK_BOX, /**< A control in the MMI to enable or disable one or more options from a set.  */
	E_RADIO_BOX, /**< A control in the MMI to enable or disable one option from a set. The enabling of one radio box will disable the already enabled radio box in the given set. */
	E_LIST_BOX, /**< A control that allows the user to choose more than one options from the list. */
	E_COMBO_BOX, /**< A control that allows the user to choose one options from the list. */
	E_SCROLLBAR, /**< A control that visually indicates that there is more data that is yet to be seen outside the visible area */
	E_IMAGE, /**< A control that allows creating an image. */
	E_VIDEO, /**< A control that specifies a video type */
	E_PICTOGRAM, /**< A control that allows creating a pictogram. */
	E_IMAGE_TEXT, /**< A control that allows creating an image with text. */
	E_ICON, /**< A control that allows creating an icon. */
	E_RECT, /**< A control that allows creating a rect. */
	E_OBJECT, /**< A control that is common for image, audio, video and any other unknown content type. */
	E_OBJECT_TEXT  /**< A control that allows creating an object alternate with text */
} EControlType, E_CONTROL_TYPE ;

/**
 * @brief This enumeration contains the style of rendering the content. It can be either left to right 
 * or right to left rendering. 
 */
typedef enum e_rendering_style
{
	E_LEFT_RIGHT, /**< Specifies the rendering style of the control, which starts from the left */
	E_RIGHT_LEFT, /**< Specifies the rendering style of the control, which starts from the right */
	E_DEFAULT_DIR /**< Specifies the default rendering style of the control. */
} ERenderingStyle, E_RENDERING_STYLE ;

/**
 * @brief This enumeration contains the different text style that can be created using the 
 * jdd_MMICreateControl for the text box (E_TEXT_BOX) controls.
 * 
 * Multi-line, Marquee and Blink are the styles that have been applied to the text control. 
 * If the environment does not support these styles at least it should display the text in the
 * normal style without the additional properties. 
 */
typedef enum e_text_style
{
	E_TEXT_NORMAL, /**< Specifies the normal rendering of the text. */
	E_TEXT_MULTILINE, /**< Specifies the multi-line rendering of the text, the text control should create the control for the specified width and it should wrap the content accordingly. */
	E_TEXT_MARQUEE, /**< Specifies the marquee text control, where the text should marquee as per the direction specified. */
	E_TEXT_BLINK /**< Specifies the blink text control, where the text should blink */
} ETextStyle, E_TEXT_STYLE ;
	
/**
 * @brief This enumeration contains the different input style that can be created using the jdd_MMICreateControl for the input box controls. 
 */
typedef enum e_input_style
{
	E_INPUT_NORMAL, /**< Specifies the normal input box (edit box) */
	E_INPUT_MASK, /**< Specifies the password input box, where the character that are keyed in shall be masked. */
	E_INPUT_MULTILINE /**< Specifies the input box with the multiple line. */
} EInputBoxStyle, E_INPUTBOX_STYLE ;

/**
 * @brief This enumeration contains the state of the check box or radio box.
 */
typedef enum e_optionbox_status
{
	E_UNCHECKED, /**< Specifies the value for the check box or radio box when the control is not selected. */
	E_CHECKED /**< Specifies the value for the check box or radio box when the control is selected. */
} E_OPTIONBOX_STATUS ;

/**
 * @brief This enumeration contains the style of selection of the list box properties.
 */
typedef enum e_list_style
{
	E_SINGLE_SELECTION = 0 , /**< Specifies the list box control property for allowing selection of only one item at a time. */
	E_MULTIPLE_SELECTION /**< Specifies the list box control property to select multiple items at a time. */
} E_LIST_STYLE ;

/**
 * @brief This enumeration contains style property for the marquee text control.
 */
typedef enum e_marquee_style
{
	E_MARQUEE_NONE, /**< Specifies that the marquee is not present. */
	E_MARQUEE_SLIDE, /**< Specifies the marquee need to scroll only once. */
	E_MARQUEE_ALTERNATE, /**< Specifies the marquee need to scroll in alternate direction. */
	E_MARQUEE_SCROLL, /**< Specifies the marquee need to scroll in the direction specified. */
	E_MARQUEE_SCROLL_ONFOCUS, /**< Specifies the marquee needs to be applied only if the control is in focus. */
	E_MARQUEE_ALTERNATE_ONFOCUS /**< Specifies the marquee needs to be applied only if the control is in focus */
} EMarqueeStyle, E_MARQUEE_STYLE ;

/**
 * @brief This enumeration contains style of marquee property for the marquee control.	
 */
typedef enum e_marquee_direction
{
	E_MARQUEE_RIGHT_TO_LEFT, /**< Specifies the marquee scrolling direction from left towards the right side. */
	E_MARQUEE_LEFT_TO_RIGHT, /**< Specifies the marquee scrolling direction from right side towards the left side. */
	E_MARQUEE_UP_DOWN, /**< Specifies the marquee scrolling direction from up side towards the down side */
	E_MARQUEE_DOWN_UP /**< Specifies the marquee scrolling direction from down side towards the up side */
} EMarqueeDirection, E_MARQUEE_DIRECTION ;

/**
 * @brief This enumeration contains speed of marquee property for the marquee control.
 */
typedef enum e_marquee_speed
{
	E_MARQUEE_SLOW, /**< Specifies the slow speed in the marquee control. */
	E_MARQUEE_NORMAL, /**< Specifies the normal speed in the marquee control. */
	E_MARQUEE_FAST /**< Specifies the fast speed in the marquee control. */
} EMarqueeSpeed, E_MARQUEE_SPEED ;

/**
 * @brief This enumeration contains different type of the scrollbar that can be created. 
 */
typedef enum e_scrollbar_type
{
	E_VERTICAL_SCROLLBAR, /**< Specifies the vertical scrollbar properties. */
	E_HORIZONTAL_SCROLLBAR /**< Specifies the horizontal scrollbar properties. */
} EScrollBarType, E_SCROLLBAR_TYPE ;

/**
 * @brief This enumeration contains different style property for setting the wallpaper image. 
 */
typedef enum e_wallpaper_image
{
	E_POSITION_POINT, /**< Specifies the wallpaper property for the image, which needs to be rendered on the specified location. */
	E_POSITION_CENTER, /**< Specifies the wallpaper property for the image, which needs to be rendered in the center of the window for the exact width and height of the given image. */
	E_POSITION_STRETCH, /**< Specifies the wallpaper property for the image, which needs to be rendered for the full screen of the window, the image need to be stretched/resized if the actual width and height of the image is not equal to the window's width and height. */
	E_POSITION_TILE, /**< Specifies the wallpaper property for the image which needs to be tiled across vertical and horizontal for the full width and height of the window. */
	E_POSITION_VERTICAL_TILE, /**< Specifies the wallpaper property for the image which needs to be tiled across vertical for the full height of the window. */
	E_POSITION_HORIZONTAL_TILE /**< Specifies the wallpaper property for the image which needs to be tiled across horizontal for the full width of the window. */
} EWallpaperProperty, E_WALLPAPER_PROPERTY ;

/**
 * @brief This enumeration describes the different event that are generated by the MMI layer.
 */
typedef enum e_mmi_event_type
{
	JC_MMI_LINK_EVENT, /**< Whenever the link is used, the MMI need to generate this event. */
	JC_MMI_INPUT_EVENT, /**< Any key event in the E_INPUT_BOX, the MMI need to generate this event. */
	JC_MMI_BUTTON_EVENT, /**< Any action event for the E_BUTTON, the MMI needs to generate this event. */
	JC_MMI_CHECK_EVENT, /**< When there is any change in the state of the check box, the MMI need to generate this event. */
	JC_MMI_RADIO_EVENT, /**< When there is any change in the state of the radio box, the MMI need to generate this event. */
	JC_MMI_LIST_EVENT, /**< When any of the list box item is selected or de-selected, the MMI need to generate this event. */
	JC_MMI_COMBO_EVENT, /**< When any of the combo box item is selected, the MI need to generate this event. */
	JC_MMI_IMAGE_EVENT, /**< Any action event in the E_IMAGE, the MMI needs to generate this event. */
	JC_MMI_ACCESSKEY_EVENT, /**< Whenever an access key is entered, the MMI needs to generate this event. */
	JC_MMI_SOFTKEY_EVENT /**< When there is action key event on the soft key on the device, this specific event needs to be generated by the MMI layer. */
} EMMIEventType, E_MMI_EVENT_TYPE ;

/**
 * @brief This enumeration contains different style property for setting the different message type. 
 */
typedef enum e_mmi_notification
{
	E_NOTIFICATION_ERR /**< Specifies the message box needs to be rendered as an error message. */
} EMMINotificationMsgType, E_MMI_NOTIFICATION_MSGTYPE ;

/**
 * @brief This enumeration contains different style property for setting the different confirmation message type. 
 */
typedef enum e_mmi_confirmatation
{
	E_CONFIRMATION_OK_CANCEL, /**< Specifies the confirmation box needs to provide two options such as "Ok" and "Cancel". */
	E_CONFIRMATION_YES_NO /**< Specifies the confirmation box needs to provide two options such as "Yes" and "No". */
} EMMIConfirmationMsgType, E_MMI_CONFIRMATION_MSGTYPE ;

/**
 * @brief This enumeration contains the different border style.
 */
typedef enum e_border_style
{
    E_NO_BORDER, /**< Specifies the border style where the border no needs to be drawn. */
    E_SOLID_BORDER, /**< Specifies the solid border style where the border needs to be continuously drawn. */
    E_DOTTED_BORDER, /**< Specifies the dotted border style where the border needs to be drawn continuously. */
    E_DASHED_BORDER, /**< Specifies dashed border. Can be Rendered as solid. */
    E_DOUBLE_BORDER, /**< Specifies two borders. The width of the two borders are the same as the border-width value. */
    E_GROOVE_BORDER, /**< Specifies a grooved border. The effect depends on the border-color value. */
    E_RIDGE_BORDER, /**< Specifies a ridge border. The effect depends on the border-color value. */
    E_INSET_BORDER, /**< Specifies a recessed border. The effect depends on the border-color value. */