guistyle.h

IT projecotr reference design.

/*****************************************************************************
**             TEXAS INSTRUMENTS PROPRIETARY INFORMATION
**
**  (c) Copyright, Texas Instruments Incorporated, 2006.
**      All Rights Reserved.
**
**  Property of Texas Instruments Incorporated. Restricted Rights -
**  Use, duplication, or disclosure is subject to restrictions set
**  forth in TI's program license agreement and associated documentation.
******************************************************************************/

#ifndef _GUI_STYLE_H
#define _GUI_STYLE_H

#include "common.h"
#include "DDP2230_OSD_OSD.h"

/* enumerations for messages affecting the GUI */
typedef enum
{
   GUIMSG_LEFT,
   GUIMSG_RIGHT,
   GUIMSG_UP,
   GUIMSG_DOWN,
   GUIMSG_SELECT,
   GUIMSG_STRING,
   GUIMSG_VALUE,
   GUIMSG_INC,
   GUIMSG_DEC,
   GUIMSG_INC_Y,
   GUIMSG_DEC_Y,
   GUIMSG_ASSERT,
   GUIMSG_DEASSERT,
   GUIMSG_CHANGEITEMFOCUS
} GUIMSGTYPE;

typedef enum
{
    GUI_ERR_ITEMHIGHLIGHT


} GUIRETURN;

/* arbitrary number of items for 'for' loops */
#define GUI_STYLE_MAXITEMS 100

/* structure used to pass messages affecting the GUI 
 * between functions and GUI ADLs */
typedef struct _GUIMSG
{
    GUIMSGTYPE type;
    void *data;
} GUIMSG;

/* link list structure to keep track of hidden items */
typedef struct _GUI_STYLE_HIDDEN_ITEM
{
    struct _GUI_STYLE_HIDDEN_ITEM *next;
    int16 itemId;
} GUI_STYLE_HIDDEN_ITEM;

/* Link list structure describing the open menus */
typedef struct _GUI_OPEN_MENU
{
    struct _GUI_OPEN_MENU *previousMenu;  /* menu opened before this menu */
    int16 menuId;  /* current menu's ID */
    int16 itemId;  /* selected item's ID */
    GUI_STYLE_HIDDEN_ITEM *hiddenItemList;  /* link list of hidden items */
} GUI_OPEN_MENU;

/* Interface to gui_msgpump and gui_action */
BOOL guiStyle_IsOsdDisplayed( void );
BOOL guiStyle_IsMenuDisplayed( int16 menuId );
int08 guiStyle_StartMenu( int16 newMenuId, GUIMSG *msg );
int08 guiStyle_Exit( void );
int08 guiStyle_SendTopMenuMsg( GUIMSG *msg );
int08 guiStyle_SendMenuMsg( int16 menuId, GUIMSG *msg );
int08 guiStyle_Redraw( void );
int08 guiStyle_Reload( void );
int08 guiStyle_CloseMenu( int16 menuId );
int08 guiStyle_Init( uint32 memPoolID,
                      void (*onOsdStartCallback)(void),
                      void (*onOsdCloseCallback)(void),
                      int08 (*actionOnStartCallback)( int16 menuId, GUIMSG *msg ),
                      int08 (*actionOnCloseCallback)( int16 menuId ),
                      int08 (*actionGuiMsgCallback)( int16 menuId, int16 itemId, GUIMSG *msg ),
                      int08 (*actionRedrawCallback)( int16 menuId, GUIMSG *msg ),
                      int08 (*actionGetHighlightWindowCallback)( int16 menuId, uint08 *window )
                     );
int08 guiStyle_HideItem( int16 menuId, int16 itemId, BOOL hide );
int08 guiStyle_GrayOutItem( int16 menuId, int16 itemId, BOOL disable );
int08 guiStyle_SetVerticalBackPorchTimeInUS( uint32 backporch );
BOOL guiStyle_IsFadeEnabled( void );
int08 guiStyle_SetFadeEnabled( BOOL enable );


/* Addition interface functions declared in guiStyle_menu_lut.h and guiStyle_item_lut.h */
#include "guiStyle_menu_lut.h"
#include "guiStyle_item_lut.h"

/* callback functions for the application */ //mcc test
extern void (*gui_AppTask_OsdOnStart)( void );
extern void (*gui_AppTask_OsdOnClose)( void );
extern int08 (*gui_AppAction_OnStart)( int16 menuId, GUIMSG *msg );
extern int08 (*gui_AppAction_OnClose)( int16 menuId );
extern int08 (*gui_AppAction_GuiMsg)( int16 menuId, int16 itemId, GUIMSG *msg );
extern int08 (*gui_AppAction_Redraw)( int16 menuId, GUIMSG *msg );
extern int08 (*gui_AppAction_GetHighlightWindow)( int16 menuId, uint08 *window );

//mcc test
#define OSD_ERR_WINNUM_INVALID 0xFF

#endif