d4d_screen.h

Go to the documentation of this file.

/**************************************************************************
*
* Copyright 2014 by Petr Gargulak. eGUI Community.
* Copyright 2009-2013 by Petr Gargulak. Freescale Semiconductor, Inc.
*
***************************************************************************
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License Version 3
* or later (the "LGPL").
*
* As a special exception, the copyright holders of the eGUI project give you
* permission to link the eGUI sources with independent modules to produce an
* executable, regardless of the license terms of these independent modules,
* and to copy and distribute the resulting executable under terms of your
* choice, provided that you also meet, for each linked independent module,
* the terms and conditions of the license of that module.
* An independent module is a module which is not derived from or based
* on this library.
* If you modify the eGUI sources, you may extend this exception
* to your version of the eGUI sources, but you are not obligated
* to do so. If you do not wish to do so, delete this
* exception statement from your version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*
* You should have received a copy of the GNU General Public License
* and the GNU Lesser General Public License along with this program.
* If not, see <http://www.gnu.org/licenses/>.
*
***************************************************************************/
#ifndef __D4D_SCREEN_H
#define __D4D_SCREEN_H

/******************************************************************************
* D4D SCREEN setting  constants
*
*/
#ifndef D4D_SCR_TITLE_OFF_X
  #define D4D_SCR_TITLE_OFF_X  3
#endif

#ifndef D4D_SCR_TITLE_OFF_Y
  #define D4D_SCR_TITLE_OFF_Y  1
#endif

#ifndef D4D_SCR_HEADER_SIZE_MIN_SIZE
  #define D4D_SCR_HEADER_SIZE_MIN_SIZE  13
#endif

#ifndef D4D_SCR_TITLE_EXITBTN_MIN_SIZE
  #define D4D_SCR_TITLE_EXITBTN_MIN_SIZE  6
#endif

#ifndef D4D_SCR_EXITBTN_CROSS_SIZE
  #define D4D_SCR_EXITBTN_CROSS_SIZE 2
#endif

#ifndef D4D_SCR_TITLE_EXITBTN_OFFSET
  #define D4D_SCR_TITLE_EXITBTN_OFFSET  3
#endif

// Common flags as for initial as for runtime
#define D4D_SCR_F_OUTLINE       (0x01)  
#define D4D_SCR_F_BEVEL         (0x02)  
#define D4D_SCR_F_TITLEBAR      (0x04)  
#define D4D_SCR_F_EXIT          (0x08)  
#define D4D_SCR_F_BCKG          (0x10)  

#define D4D_SCR_F_TOUCHENABLE           (D4D_SCR_FINT_TOUCHENABLE << 8)         
#define D4D_SCR_F_MOUSE_NORMAL          (D4D_SCR_FINT_MOUSE_NORMAL << 8)        
#define D4D_SCR_F_MOUSE_BUSY            (D4D_SCR_FINT_MOUSE_BUSY << 8)          
#define D4D_SCR_F_MOUSE_UNAVAILABLE     (D4D_SCR_FINT_MOUSE_UNAVAILABLE << 8)   


#ifndef D4D_SCR_F_DEFAULT
  #define D4D_SCR_F_DEFAULT        (D4D_SCR_FINT_MOUSE_NORMAL)
#endif

/******************************************************************************
* Internal constants
******************************************************************************/
#define D4D_SCR_FINT_INITDONE       (0x01)
#define D4D_SCR_FINT_TOUCHENABLE    (0x02)
#define D4D_SCR_FINT_REDRAWC        (0x04)
#define D4D_SCR_FINT_CHECKOBJECTS   (0x08)

#define D4D_SCR_FINT_MOUSE_MASK     (0x60)
#define D4D_SCR_FINT_MOUSE_SHIFT    (5)

#define D4D_SCR_FINT_MOUSE_NORMAL       (0x20)
#define D4D_SCR_FINT_MOUSE_BUSY         (0x40)
#define D4D_SCR_FINT_MOUSE_UNAVAILABLE  (0x60)

struct D4D_STRING_S;
/******************************************************************************
* D4D Screen types
*
*/
typedef Byte D4D_SCREEN_FLAGS;

typedef struct
{
  // other runtime data
  D4D_OBJECT* focusedObject;            
  Byte flags;                           
} D4D_SCREEN_DATA;

// screen configuration (goes to ROM by default)

typedef struct D4D_SCREEN_S
{
    // object list
    const D4D_OBJECT* const * pObjects;                 

    // event handlers
    void (*OnInit)(void);                               
    void (*OnMain)(void);                               
    void (*OnActivate)(void);                           
    void (*OnDeactivate)(void);                         
    Byte (*OnObjectMsg)(struct D4D_MESSAGE_S* pMsg);    

    // Screen advanced properties
    D4D_POINT position;                 
    D4D_SIZE size;                      
    D4D_COOR radius;                    
    D4D_MARGIN* pMargin;                
    struct D4D_STRING_S textBuff;       
    const D4D_BMP* pIcon;               

    D4D_SCREEN_FLAGS flags;             
    struct D4D_CLR_SCHEME_S* clrScheme; 

    // pointer to runtime data
    D4D_SCREEN_DATA* pData;             
} D4D_SCREEN;

/*********************************************************
*
* static declaration macros
*
*********************************************************/
/******************************************************************************
* D4D Screen macros
*
*/
/**************************************************************************/ 
#define _D4D_DECLARE_SCREEN_BEGIN(type, name, funcPrefix, x ,y, cx, cy, radius, text, fontId, icon, initFlags, pScheme) \
    extern const D4D_OBJECT * const name##_objects[]; \
    static void funcPrefix##OnInit(void); \
    static void funcPrefix##OnMain(void); \
    static void funcPrefix##OnActivate(void); \
    static void funcPrefix##OnDeactivate(void); \
    static Byte funcPrefix##OnObjectMsg(D4D_MESSAGE* pMsg); \
    static D4D_SCREEN_DATA name##_data = { NULL,  (Byte)((D4D_SCREEN_FLAGS)(initFlags >> 8) & 0x00FF)}; \
    static D4D_STR_PROPERTIES name##_strPrties = { D4D_FNT_PRTY_TRANSPARENT_YES_MASK, (D4D_ALIGN_H_LEFT_MASK | D4D_ALIGN_V_CENTER_MASK)}; \
    type D4D_SCREEN name = \
    { \
        name##_objects, \
        funcPrefix##OnInit, \
        funcPrefix##OnMain, \
        funcPrefix##OnActivate, \
        funcPrefix##OnDeactivate, \
        funcPrefix##OnObjectMsg, \
        {x, y}, \
        {cx, cy}, \
        radius, \
        NULL, \
        { text, sizeof(text), fontId,  &name##_strPrties, 0, 0}, /* textBuff */ \
        icon, \
        (D4D_SCREEN_FLAGS)(initFlags & 0x00FF), \
        pScheme, \
        &(name##_data) \
    }; \
    const D4D_OBJECT * const name##_objects[] = \
    {

/**************************************************************************/ 
#define D4D_DECLARE_SCREEN_BEGIN(name, funcPrefix, x ,y, cx, cy, text, fontId, icon, initFlags, pScheme)\
  _D4D_DECLARE_SCREEN_BEGIN(D4D_CONST, name, funcPrefix, x ,y, cx, cy, 0, text, fontId, icon, initFlags, pScheme)

/**************************************************************************/ 
#define D4D_DECLARE_STD_SCREEN_BEGIN(name, funcPrefix) D4D_DECLARE_SCREEN_BEGIN(name, funcPrefix, 0 ,0, \
          (D4D_COOR)(D4D_SCREEN_SIZE_LONGER_SIDE), (D4D_COOR)(D4D_SCREEN_SIZE_SHORTER_SIDE), NULL, 0, NULL, D4D_SCR_F_DEFAULT, NULL)

/**************************************************************************/ 
#define D4D_DECLARE_STD_PORTRAIT_SCREEN_BEGIN(name, funcPrefix) D4D_DECLARE_SCREEN_BEGIN(name, funcPrefix, 0 ,0, \
          (D4D_COOR)(D4D_SCREEN_SIZE_SHORTER_SIDE), (D4D_COOR)(D4D_SCREEN_SIZE_LONGER_SIDE), NULL, 0, NULL, D4D_SCR_F_DEFAULT, NULL)

/**************************************************************************/ 
#define D4D_DECLARE_RSCREEN_BEGIN(name, funcPrefix, x ,y, cx, cy, radius, text, fontId, icon, initFlags, pScheme)\
  _D4D_DECLARE_SCREEN_BEGIN(D4D_CONST, name, funcPrefix, x ,y, cx, cy, radius, text, fontId, icon, initFlags, pScheme)

/**************************************************************************/ 
#define D4D_DECLARE_SCREEN_OBJECT(name) &(name),

/**************************************************************************/ 
#define D4D_DECLARE_SCREEN_END() NULL };

/**************************************************************************/ 
#define D4D_DECLARE_SCREEN_BEGIN_INRAM(name, funcPrefix, x ,y, cx, cy, text, fontId, icon, initFlags, pScheme)\
  _D4D_DECLARE_SCREEN_BEGIN(D4D_NO_CONST, name, funcPrefix, x ,y, cx, cy, 0, text, fontId, icon, initFlags, pScheme)

/**************************************************************************/ 
#define D4D_DECLARE_STD_SCREEN_BEGIN_INRAM(name, funcPrefix) D4D_DECLARE_SCREEN_BEGIN_INRAM(name, funcPrefix, 0 ,0, \
          (D4D_COOR)(D4D_SCREEN_SIZE_LONGER_SIDE), (D4D_COOR)(D4D_SCREEN_SIZE_SHORTER_SIDE), NULL, 0, NULL, D4D_SCR_F_DEFAULT, NULL)

/**************************************************************************/ 
#define D4D_DECLARE_STD_PORTRAIT_SCREEN_BEGIN_INRAM(name, funcPrefix) D4D_DECLARE_SCREEN_BEGIN_INRAM(name, funcPrefix, 0 ,0, \
          (D4D_COOR)(D4D_SCREEN_SIZE_SHORTER_SIDE), (D4D_COOR)(D4D_SCREEN_SIZE_LONGER_SIDE), NULL, 0, NULL, D4D_SCR_F_DEFAULT, NULL)

/**************************************************************************/ 
#define D4D_DECLARE_RSCREEN_BEGIN_INRAM(name, funcPrefix, x ,y, cx, cy, radius, text, fontId, icon, initFlags, pScheme)\
  _D4D_DECLARE_SCREEN_BEGIN(D4D_NO_CONST, name, funcPrefix, x ,y, cx, cy, radius, text, fontId, icon, initFlags, pScheme)

/**************************************************************************/ 
#define D4D_EXTERN_SCREEN(name) \
    extern D4D_SCREEN name;

/**************************************************************/
#ifdef D4D_LLD_TCH
  void D4D_EnableScrTouchScreen(const D4D_SCREEN* pScr, D4D_BOOL bEnable);
#else
  #define  D4D_EnableScrTouchScreen(pScr, bEnable)
#endif

D4D_SCREEN* D4D_GetActiveScreen(void);
void D4D_ActivateScreen(const D4D_SCREEN* pNewScreen, D4D_BOOL bReplaceCurrent);
void D4D_EscapeScreen(void);
void D4D_EscapeToBaseScreen(void);
void D4D_InitScreen(const D4D_SCREEN* pScreen);
void D4D_InvalidateScreen(const D4D_SCREEN* pScreen, D4D_BOOL bComplete);
void D4D_SetScreenTextProperties(const D4D_SCREEN* pScreen, D4D_TEXT_PROPERTIES property);
void D4D_SetScreenFontProperties(const D4D_SCREEN* pScreen, D4D_FONT_PROPERTIES property);


D4D_POINT D4D_GetClientToScreenPoint(D4D_OBJECT* pObject, D4D_POINT* nClientPoint);
D4D_POINT D4D_GetScreenToClientPoint(D4D_OBJECT* pObject, D4D_POINT* nScreenPoint);



#endif /* __D4D_SCREEN_H */