d4d_menu.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_MENU_H
#define __D4D_MENU_H

extern const D4D_OBJECT_SYS_FUNCTION d4d_menuSysFunc;
void D4D_MenuScrollBarsFeedBack(D4D_OBJECT* pThis, D4D_INDEX old_position, D4D_INDEX new_position);
/******************************************************************************
* D4D MENU setting  constants
*
*/
//********************* Menu flags for button specific flags *****************
  #define D4D_MENU_F_INDEX    (0x01 << D4D_OBJECT_F_OBJECT_SHIFT)       
  #define D4D_MENU_F_SIDEBAR  (0x02 << D4D_OBJECT_F_OBJECT_SHIFT)       

#ifndef D4D_MENU_F_DEFAULT
  #define D4D_MENU_F_DEFAULT  (D4D_OBJECT_F_VISIBLE | D4D_OBJECT_F_ENABLED | D4D_OBJECT_F_TABSTOP | D4D_OBJECT_F_TOUCHENABLE | D4D_OBJECT_F_MOUSE_NORMAL | D4D_OBJECT_F_BEVEL_RAISED | D4D_MENU_F_INDEX | D4D_MENU_F_SIDEBAR)
#endif

#ifndef D4D_MENU_F_SCRLBRS_DEFAULT
  #define D4D_MENU_F_SCRLBRS_DEFAULT  (D4D_OBJECT_F_ENABLED | D4D_OBJECT_F_TOUCHENABLE | D4D_OBJECT_F_FASTTOUCH | D4D_OBJECT_F_MOUSE_NORMAL)
#endif

#ifndef D4D_MENU_SCRLBR_WIDTH
  #define D4D_MENU_SCRLBR_WIDTH  ( 20 )
#endif

#ifndef D4D_MENU_SCRLBR_STEP
  #define D4D_MENU_SCRLBR_STEP  ( 1 )
#endif

#ifndef D4D_MENU_TXT_PRTY_DEFAULT
  #define D4D_MENU_TXT_PRTY_DEFAULT  (D4D_ALIGN_H_CENTER_MASK | D4D_ALIGN_V_CENTER_MASK)
#endif

#ifndef D4D_MENU_FNT_PRTY_DEFAULT
  #define D4D_MENU_FNT_PRTY_DEFAULT  ( 0 )
#endif

#ifndef D4D_MENU_IX_FNT_PRTY_DEFAULT
  #define D4D_MENU_IX_FNT_PRTY_DEFAULT  ( 0 )
#endif

#ifndef D4D_MENU_IX_TXT_PRTY_DEFAULT
  #define D4D_MENU_IX_TXT_PRTY_DEFAULT  ( D4D_ALIGN_H_CENTER_MASK | D4D_ALIGN_V_CENTER_MASK )
#endif

#ifndef D4D_MENU_ITEM_FNT_PRTY_DEFAULT
  #define D4D_MENU_ITEM_FNT_PRTY_DEFAULT  ( 0 )
#endif

#ifndef D4D_MENU_ITEM_TXT_PRTY_DEFAULT
  #define D4D_MENU_ITEM_TXT_PRTY_DEFAULT  ( D4D_ALIGN_V_CENTER_MASK | D4D_ALIGN_H_LEFT_MASK )
#endif

/******************************************************************************
* D4D MENU setting  public types
*
*/
typedef sByte D4D_MENU_INDEX;

/**************************************************************************/ 
typedef void (*D4D_MENU_ON_CLICK)(D4D_OBJECT* pThis, D4D_MENU_INDEX ix);


/******************************************************************************
* Private Types
******************************************************************************/

// Menu configuration (goes to ROM by default)
typedef struct
{
  D4D_STRING text;
  const D4D_BMP*  pIcon;    // Item Icon
  void* pUser;
}D4D_MENU_ITEM;

typedef struct
{
   D4D_MENU_INDEX ix;
   D4D_MENU_INDEX page_ix;
} D4D_MENU_DATA;

typedef struct
{
    D4D_STRING title_text;    // menu title text
    D4D_FONT  indexFontId;
    D4D_FONT  itemsFontId;
    D4D_MENU_INDEX posCnt; // Number of visiable position
    D4D_COOR textOff; // text offset between individual item on screen
    const D4D_BMP*  pIcon;    // Title Icon
    D4D_MENU_DATA* pData;     // Menu volatile data struct
    const D4D_MENU_ITEM*  pItems;
    D4D_MENU_ON_CLICK OnClicked;
} D4D_MENU;


/******************************************************************************
* Macros
******************************************************************************/
#define D4D_MENU_CHILD_SCROLL_BAR_VER_IX 1

// getting the MENU structure from general OBJECT
#define D4D_GET_MENU(pObj) ((D4D_MENU*)((pObj)->pParam))

#define D4D_GET_MENU_SCROLL_BAR_HOR(pObj) ((D4D_OBJECT*)((pObj)->pRelations[D4D_MENU_CHILD_SCROLL_BAR_VER_IX]))

/******************************************************************************
* D4D MENU setting  public macros
*
*/
/**************************************************************************/ 
#define _D4D_DECLARE_MENU_BEGIN(type, name, title_text, title_font, x, y, cx, cy, radius, pMargin, pParent, flags, pScheme,\
    indexFontId, itemsFontId, posCnt, menuItemsOff, pIcon, pUser, pOnClick, pOnUsrMsg) \
    extern type D4D_MENU_ITEM name##_items[];\
    extern D4D_OBJECT name##_scrollBarVer;\
    static const D4D_OBJECT * name##_relations[] = {pParent, &name##_scrollBarVer, NULL};\
    static D4D_MENU_DATA name##_data = { 0, 0};\
    static D4D_STR_PROPERTIES name##_strPrties = { D4D_MENU_FNT_PRTY_DEFAULT , D4D_MENU_TXT_PRTY_DEFAULT }; \
    static type D4D_MENU name##_params = \
    { \
        { title_text, D4D_TEXT_LEN(title_text), title_font, &name##_strPrties, D4D_OBJECT_MAX_TEXT_LEN(title_text), 0},  \
        indexFontId,        \
                        itemsFontId,        \
                        posCnt, \
                        menuItemsOff, \
                        pIcon, \
                        &(name##_data), \
                        (const D4D_MENU_ITEM*)&(name##_items[0]),\
                        pOnClick, \
    }; \
    \
    D4D_DECLARE_OBJECT(type, name, x, y, cx, cy, radius, pMargin, name##_relations, pOnUsrMsg, &d4d_menuSysFunc, &(name##_params), flags, pUser, pScheme)\
    \
    static const D4D_OBJECT* const name##_scrollBarRelations[] = {&name, NULL};\
    \
    _D4D_DECLARE_SCROLL_BAR(D4D_NO_CONST, name##_scrollBarVer,  20, 100, 100, 20, radius, NULL, name##_scrollBarRelations, D4D_MENU_F_SCRLBRS_DEFAULT, pScheme, NULL, D4D_MenuScrollBarsFeedBack, NULL) \
    \
    type D4D_MENU_ITEM name##_items[] = {

/**************************************************************************/ 
#define D4D_DECLARE_MENU_ITEM(pText, pIcon) { {(pText), D4D_TEXT_LEN(pText), 0, NULL, D4D_OBJECT_MAX_TEXT_LEN(pText), 0}, pIcon, NULL},

/**************************************************************************/ 
#define D4D_DECLARE_MENU_ITEM_FULL(pText, pIcon, pUser) { {(pText), D4D_TEXT_LEN(pText), 0, NULL, D4D_OBJECT_MAX_TEXT_LEN(pText), 0}, pIcon, (void*)pUser},

/**************************************************************************/ 
#define _D4D_DECLARE_MENU_END() { {NULL, 0, 0, NULL, 0, 0}, NULL, NULL} };

/**************************************************************************/ 
#define D4D_DECLARE_MENU_END(name)  _D4D_DECLARE_MENU_END()


/**************************************************************************/ 
#define D4D_DECLARE_MENU_BEGIN(name, title_text, title_font, x, y, cx, cy, flags, pScheme,\
    indexFontId, itemsFontId, posCnt, menuItemsOff, pIcon, pUser, pOnClick, pOnUsrMsg) \
 _D4D_DECLARE_MENU_BEGIN(D4D_CONST, name, title_text, title_font, x, y, cx, cy, 0, NULL, NULL, flags, pScheme,\
    indexFontId, itemsFontId, posCnt, menuItemsOff, pIcon, pUser, pOnClick, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_MENU_BEGIN(name, title_text, title_font, x, y, cx, cy, indexFontId, itemsFontId, pIcon, pOnClick) \
    D4D_DECLARE_MENU_BEGIN(name, title_text, title_font, x, y, cx, cy, (D4D_MENU_F_DEFAULT), NULL,\
    IndexFontId, ItemsFontId, 0, 0, pIcon, NULL, pOnClick, NULL)

// Rounded menu definition
/**************************************************************************/ 
#define D4D_DECLARE_RMENU_BEGIN(name, title_text, title_font, x, y, cx, cy, radius, flags, pScheme,\
    indexFontId, itemsFontId, posCnt, menuItemsOff, pIcon, pUser, pOnClick, pOnUsrMsg) \
 _D4D_DECLARE_MENU_BEGIN(D4D_CONST, name, title_text, title_font, x, y, cx, cy, radius, NULL, NULL, flags, pScheme,\
    indexFontId, itemsFontId, posCnt, menuItemsOff, pIcon, pUser, pOnClick, pOnUsrMsg)



/**************************************************************************/ 
#define D4D_DECLARE_STD_RMENU_BEGIN(name, title_text, title_font, x, y, cx, cy, radius, indexFontId, itemsFontId, pIcon, pOnClick) \
    D4D_DECLARE_RMENU_BEGIN(name, title_text, title_font, x, y, cx, cy, radius, (D4D_MENU_F_DEFAULT), NULL,\
    indexFontId, itemsFontId, 0, 0, pIcon, NULL, pOnClick, NULL)


//IN RAM instantions macros
/**************************************************************************/ 
#define D4D_DECLARE_MENU_BEGIN_INRAM(name, title_text, title_font, x, y, cx, cy, flags, pScheme,\
    indexFontId, itemsFontId, posCnt, menuItemsOff, pIcon, pUser, pOnClick, pOnUsrMsg) \
 _D4D_DECLARE_MENU_BEGIN(D4D_NO_CONST, name, title_text, title_font, x, y, cx, cy, 0, NULL, NULL, flags, pScheme,\
    indexFontId, itemsFontId, posCnt, menuItemsOff, pIcon, pUser, pOnClick, pOnUsrMsg)


/**************************************************************************/ 
#define D4D_DECLARE_STD_MENU_BEGIN_INRAM(name, title_text, title_font, x, y, cx, cy, IndexFontId, ItemsFontId, pIcon, pOnClick) \
    D4D_DECLARE_MENU_BEGIN_INRAM(name, title_text, title_font, x, y, cx, cy, (D4D_MENU_F_DEFAULT), NULL,\
    IndexFontId, ItemsFontId, 0, 0, pIcon, NULL, pOnClick, NULL)


// Rounded menu definition
/**************************************************************************/ 
#define D4D_DECLARE_RMENU_BEGIN_INRAM(name, title_text, title_font, x, y, cx, cy, radius, flags, pScheme,\
    indexFontId, itemsFontId, posCnt, menuItemsOff, pIcon, pUser, pOnClick, pOnUsrMsg) \
 _D4D_DECLARE_MENU_BEGIN(D4D_NO_CONST, name, title_text, title_font, x, y, cx, cy, radius, NULL, NULL, flags, pScheme,\
    indexFontId, itemsFontId, posCnt, menuItemsOff, pIcon, pUser, pOnClick, pOnUsrMsg)



/**************************************************************************/ 
#define D4D_DECLARE_STD_RMENU_BEGIN_INRAM(name, title_text, title_font, x, y, cx, cy, radius, IndexFontId, ItemsFontId, pIcon, pOnClick) \
    D4D_DECLARE_RMENU_BEGIN_INRAM(name, title_text, title_font, x, y, cx, cy, radius, (D4D_MENU_F_DEFAULT), NULL,\
    IndexFontId, ItemsFontId, 0, 0, pIcon, NULL, pOnClick, NULL)

      /* Obsolete macros */

      #define D4D_DECLARE_RMENU_END(name)  D4D_DECLARE_MENU_END(name)
      #define D4D_DECLARE_MENU_END_INRAM(name)  _D4D_DECLARE_MENU_END()
      #define D4D_DECLARE_RMENU_END_INRAM(name)  D4D_DECLARE_MENU_END_INRAM(name)
/******************************************************************************
* Global functions
******************************************************************************/
D4D_MENU_INDEX D4D_MenuGetIndex(D4D_OBJECT* pThis);

void  D4D_MenuSetIndex(D4D_OBJECT* pThis, D4D_MENU_INDEX ix);
D4D_MENU_INDEX D4D_MenuGetItemCount(D4D_OBJECT_PTR pThis);
D4D_MENU_INDEX D4D_MenuFindUserDataItem(D4D_OBJECT_PTR pThis, void* pUser);
void* D4D_MenuGetItemUserData(D4D_OBJECT_PTR pThis);
D4D_STRING* D4D_MenuGetItemText(D4D_OBJECT_PTR pThis);


#endif /* __D4D_MENU_H  */