jdd_mmiapi.h.svn-base

gif to bmp conversion

/***************************************************************************
 * $Id: jdd_mmiapi.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_mmiapi.h,v $
 * Revision 1.50  2008/07/02 13:10:25  kawalccjims
 * *** empty log message ***
 *
 * 
 * 4     31/05/07 11:04a Anupr
 * 
 * 1     16/03/07 7:18p Anupr
 * Device Independent TreeView APIs
 * Revision 1.6  2007/01/12 11:18:05  browserdevjtbase
 * Update from the main base
 *
 * Revision 1.5  2006/11/29 13:09:24  browserdevjtbase
 * *** empty log message ***
 *
 * Revision 1.4  2006/11/16 11:32:26  browserdevjtbase
 * Update
 *
 * 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.23  2006/03/02 06:50:13  kavithadevhtmlbrow
 * jdd_MMIHightlighText updated
 *
 * Revision 1.22  2006/03/02 06:22:50  kavithadevhtmlbrow
 * jdd_MMIGetObectSize and jdd_MMIFreeObjectSize
 *
 * Revision 1.21  2006/02/28 10:59:56  kavithadevhtmlbrow
 * New Parameter added to jdd_MMIGetObjectSize
 *
 *
 *  
 ***************************************************************************/


#ifndef _JDD_MMI_API_H
#define _JDD_MMI_API_H


#ifdef __cplusplus
extern "C"
{
#endif

/** 
 * @file jdd_mmiapi.h
 * @ingroup MMI
 * @{
 * @brief Describes the API's that are available in the MMI abstraction layer. 
 */

/** @cond */
#include <jdd_mimeapi.h>
/** @endcond */


/**
 * @brief This function shall be called to initialize the MMI layer for the specific platform. 
 * @param[in] pvMMIReference Specifies platform specific argument which is required to initialize the MMI layer. 
 *							 It can be HINSTANCE in case of Win32.
 * This shall be the first call by the application before invoking any other MMI related API calls. 
 * In general, the application startup code needs to call this initialize function with the required 
 * initialization parameter that is specific to the platform. 
 * @see jdd_MMIDeInitialize
 */
JC_RETCODE jdd_MMIInitialize (void *pvMMIReference) ;

/**
 * @brief This function shall de-initialize the MMI platform specific layer. 
 * @param[in] pvMMIReference Specifies the platform specific argument that has been passed when the #jdd_MMIInitialize function is executed.
 * This shall be the last call by the application in invoking any MMI related API calls. This function shall free any global resources that are used by the MMI platform specific layer.
 * @see jdd_MMIInitialize
 */
JC_RETCODE jdd_MMIDeInitialize (void *pvMMIReference) ;

/**
 * @brief This function should return whether the graphics is supported by the specific platform. 
 */
JC_BOOLEAN jdd_MMIIsGraphicsSupported (void) ;

/**
 * @brief This function provides the device characteristics for the platform.
 */
JC_RETCODE jdd_MMIGetDeviceCharacteristics (DeviceCharacteristics *pstCharacteristics) ;

/**
 * @brief This function creates a window for the given rectangle position.
 * @param[in] pstWinProp Specifies the window properties.
 * @param[in] pstRect Specifies the initial horizontal and vertical position of the window. It also contains the width and height of the window in device units. If it is NULL then use the default width and height of the device capabilities.
 * @param[out] puiWindowID Returns the identifier for the newly created window. 
 * @see jdd_MMIDestroyWindow
 */
JC_RETCODE jdd_MMICreateWindow (JC_WINDOW_PROPERTIES	*pstWinProp,
								const JC_RECT			*pstRect,
								JC_UINT32				*puiWindowID) ;
/**
 * @brief This function allows to set the caption for the given window. 
 * @param[in] uiWindowID Specifies the window identifier.
 * @param[in] pmTitleValue Specifies the title for the window.
 * The application may free the value that has passed on to this function so MMI layer should have the copy of this content if required. 
 */
JC_RETCODE jdd_MMISetTitle (JC_UINT32		uiWindowID,
							const JC_CHAR	*pmTitleValue) ;
/**
 * @brief This function gets the background and foreground color for the window.
 * @param[in] uiWindowID Specifies the window identifier.
 * @param[in] piBackgroundColor Provides the background color that is set to the specific window.
 * @param[in] piForegroundColor Provides the foreground color that is set to the specific window.
 */
JC_RETCODE jdd_MMIGetColor (JC_UINT32	uiWindowID,
							JC_INT32	*piBackgroundColor,
							JC_INT32	*piForegroundColor) ;
/**
 * @brief This function sets the background and foreground color for the window.
 * @param[in] uiWindowID Specifies the window identifier.
 * @param[in] iBackgroundColor Specifies the background color.
 * @param[in] iForegroundColor Specifies the foreground color.
 */
JC_RETCODE jdd_MMISetColor (JC_UINT32	uiWindowID,
							JC_INT32	iBackgroundColor,
							JC_INT32	iForegroundColor) ;
/**
 * @brief This function sets the default color for the window.
 * @param[in] uiWindowID Specifies the window identifier.
 * @param[in] bIsBackgroundColor Specifies the whether the default background color need to be set.
 * @param[in] bIsForegroundColor Specifies the whether the default foreground color need to be set.
 */
JC_RETCODE jdd_MMISetDefaultColor (JC_UINT32	uiWindowID,
								   JC_BOOLEAN	bIsBackgroundColor,
								   JC_BOOLEAN	bIsForegroundColor) ;
/**
 * @brief This function sets the wallpaper for the window at the location specified in pRect.
 * @param[in] uiWindowID Specifies the window identifier.
 * @param[in] stObjectInfo Specifies the mime type, object content and size of the object.
 * @param[in] eProperty Specifies the background property for the object.
 * @param[in] pstRect Specifies the location where the object needs to be rendered.
 */
JC_RETCODE jdd_MMISetWallpaper (JC_UINT32			uiWindowID,
								JC_OBJECT_INFO		stObjectInfo,
								EWallpaperProperty	eProperty,
								JC_RECT				*pstRect) ;

/**
 * @brief This function clears the wallpaper that was earlier set using the API jdd_MMISetWallpaper.
 * @param[in] uiWindowID Specifies the window identifier.
 * @param[in] uiWallpaperID Reserved, not used.
 */
JC_RETCODE jdd_MMIClearWallpaper (JC_UINT32 uiWindowID, JC_UINT32 uiWallpaperID) ;

/**
 * @brief This function sets the specified window's show state.
 * @param[in] uiWindowID Specifies the identifier for the window 
 * @param[in] bIsVisible Specifies the state of the window state. If it is JC_TRUE the window state shall be set to visible otherwise it shall be set to invisible.
 */
JC_RETCODE jdd_MMIShowWindow (JC_UINT32 uiWindowID, JC_BOOLEAN bIsVisible) ;

/**
 * @brief This function changes the position of the specified window. 
 * @param[in] uiWindowID Specifies the identifier for the window 
 * @param[in] pstRect Specifies the new co-ordinates for the window
 */
JC_RETCODE jdd_MMIMoveWindow (JC_UINT32 uiWindowID, const JC_RECT *pstRect) ;

/**
 * @brief This function gets the current position, width and height of the specified window. 
 * @param[in] uiWindowID Specifies the identifier for the window 
 * @param[in] pstRect Provides the current horizontal position, vertical position, width and height of the control
 */
JC_RETCODE jdd_MMIGetWindowRect (JC_UINT32 uiWindowID, JC_RECT *pstRect) ;

/**
 * @brief This function is used to focused or defocus the window.
 * @param[in] uiWindowID Specifies the identifier for the window.
 * @param[in] bIsFocus Specifies whether the focus is to be provided or not. E_TRUE specifies the window has to be focused.
 */
JC_RETCODE jdd_MMISetFocusWindow (JC_UINT32 uiWindowID, JC_BOOLEAN bIsFocus) ;

/**
 * @brief This function destroys the window and frees any memory the window is occupied. 
 * @param[in] uiWindowID Specifies the identifier for the window. 
 * @see jdd_MMICreateWindow
 */
JC_RETCODE jdd_MMIDestroyWindow (JC_UINT32 uiWindowID) ;

/**
 * @brief This function shall be invoked by the application before drawing or redrawing the controls on the specified window. 
 * @param[in] uiWindowID Specifies the identifier for the window 
 */
void jdd_MMIBeginDisplay (JC_UINT32 uiWindowID) ;
/**
 * @brief This function shall be invoked by the application after drawing or redrawing the controls on the specified window. 
 * @param[in] uiWindowID Specifies the identifier for the window.