d4d_icon.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_ICON_H
#define __D4D_ICON_H

extern const D4D_OBJECT_SYS_FUNCTION d4d_iconSysFunc;

/******************************************************************************
* D4D ICON setting  constants
*
*/
#ifndef D4D_ICON_F_DEFAULT
  #define D4D_ICON_F_DEFAULT  (D4D_OBJECT_F_VISIBLE | D4D_OBJECT_F_ENABLED)
#endif

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

#ifndef D4D_ICON_FNT_PRTY_DEFAULT
  #define D4D_ICON_FNT_PRTY_DEFAULT  ( 0 )
#endif

#ifndef D4D_ICON_ENABLE_ANIMATION
  #define D4D_ICON_ENABLE_ANIMATION D4D_TRUE
#endif

#ifndef D4D_ICON_ANIMATION_TICK_COUNTER
  #define D4D_ICON_ANIMATION_TICK_COUNTER  ( 4 )
#endif


/******************************************************************************
* D4D ICON setting  public types
*
*/
/**************************************************************************/ 
typedef void (*D4D_ICON_ON_CHANGE)(D4D_OBJECT* pThis);

typedef Byte D4D_ICON_INDEX;

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



typedef D4D_BMP D4D_ICON_BMPS;

typedef struct
{
    D4D_ICON_INDEX index;      // current value

#if D4D_ICON_ENABLE_ANIMATION == D4D_TRUE
    D4D_BOOL animationEnabled;
    Word tickCounter;
    Word tickCounterTrshld;
#endif

} D4D_ICON_DATA;

// ICON configuration (in ROM by default)

typedef struct
{
    D4D_STRING textBuff;       // ICON text
    D4D_POINT txtOff;           // text coordinates as offset from scrPos
    const D4D_ICON_BMPS* const*  pBmpX;           // ICON state X idication bitmaps
    D4D_ICON_ON_CHANGE  OnValueChanged;
    D4D_ICON_DATA* pData;
} D4D_ICON;

/******************************************************************************
* Macros
******************************************************************************/

// getting the ICON structure from general OBJECT
#define D4D_GET_ICON(pObj) ((D4D_ICON*)((pObj)->pParam))

/******************************************************************************
* D4D ICON setting  public macros
*
*/
/**************************************************************************/ 
#define _D4D_DECLARE_ICON_BEGIN(type, name, text, x, y, cx, cy, tx, ty, radius, pMargin, pRelations, flags, pScheme, fontId, pUser, pOnValch, pOnUsrMsg) \
    extern const D4D_ICON_BMPS*  const name##_bmps[];\
    static D4D_ICON_DATA name##_data; \
    static D4D_STR_PROPERTIES name##_strPrties = { D4D_ICON_FNT_PRTY_DEFAULT, D4D_ICON_TXT_PRTY_DEFAULT}; \
    static type D4D_ICON name##_params = \
    { \
        { text, D4D_TEXT_LEN(text), fontId, &name##_strPrties, D4D_OBJECT_MAX_TEXT_LEN(text), 0}, /* textBuff */ \
        { tx, ty },   /* txtOff     */ \
        &(name##_bmps[0]),  /* pBmpX     */ \
        pOnValch,      /* OnValueCanged */ \
        &(name##_data) /* RAM-based data */ \
    }; \
    \
    D4D_DECLARE_OBJECT(type, name, x, y, cx, cy, radius, pMargin, pRelations, pOnUsrMsg, &d4d_iconSysFunc, &(name##_params), (flags), pUser, pScheme)\
    \
    const D4D_ICON_BMPS*   const name##_bmps[] = \
    {

/**************************************************************************/ 
#define D4D_DECLARE_ICON_BMP(pBmp) (pBmp),

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

/**************************************************************************/ 
#define D4D_DECLARE_ICON_BEGIN(name, text, x, y, cx, cy, tx, ty, flags, pScheme, fontId, pUser, pOnValch, pOnUsrMsg) \
  _D4D_DECLARE_ICON_BEGIN(D4D_CONST, name, text, x, y, cx, cy, tx, ty, 0, NULL, NULL, flags, pScheme, fontId, pUser, pOnValch, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_ICON_BEGIN(name, text, x, y, cx, cy, tx, ty, fontId, pOnValch) \
  D4D_DECLARE_ICON_BEGIN(name, text, x, y, cx, cy, tx, ty, (D4D_ICON_F_DEFAULT), NULL, fontId, NULL, pOnValch, NULL)


// Rounded icon definition
/**************************************************************************/ 
#define D4D_DECLARE_RICON_BEGIN(name, text, x, y, cx, cy, tx, ty, radius, flags, pScheme, fontId, pUser, pOnValch, pOnUsrMsg) \
  _D4D_DECLARE_ICON_BEGIN(D4D_CONST, name, text, x, y, cx, cy, tx, ty, radius, NULL, NULL, flags, pScheme, fontId, pUser, pOnValch, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_RICON_BEGIN(name, text, x, y, cx, cy, tx, ty, radius, fontId, pOnValch) \
  D4D_DECLARE_RICON_BEGIN(name, text, x, y, cx, cy, tx, ty, radius, (D4D_ICON_F_DEFAULT), NULL, fontId, NULL, pOnValch, NULL)


// IN RAM instantions macros
/**************************************************************************/ 
#define D4D_DECLARE_ICON_BEGIN_INRAM(name, text, x, y, cx, cy, tx, ty, flags, pScheme, fontId, pUser, pOnValch, pOnUsrMsg) \
  _D4D_DECLARE_ICON_BEGIN(D4D_NO_CONST, name, text, x, y, cx, cy, tx, ty, 0, NULL, NULL, flags, pScheme, fontId, pUser, pOnValch, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_ICON_BEGIN_INRAM(name, text, x, y, cx, cy, tx, ty, fontId, onvalch) \
  D4D_DECLARE_ICON_BEGIN_INRAM(name, text, x, y, cx, cy, tx, ty, (D4D_ICON_F_DEFAULT), NULL, fontId, NULL, onvalch, NULL)


// Rounded icon definition
/**************************************************************************/ 
#define D4D_DECLARE_RICON_BEGIN_INRAM(name, text, x, y, cx, cy, tx, ty, radius, flags, pScheme, fontId, pUser, pOnValch, pOnUsrMsg) \
  _D4D_DECLARE_ICON_BEGIN(D4D_NO_CONST, name, text, x, y, cx, cy, tx, ty, radius, NULL, NULL, flags, pScheme, fontId, pUser, pOnValch, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_RICON_BEGIN_INRAM(name, text, x, y, cx, cy, tx, ty, radius, fontId, onvalch) \
  D4D_DECLARE_RICON_BEGIN_INRAM(name, text, x, y, cx, cy, tx, ty, radius, (D4D_ICON_F_DEFAULT), NULL, fontId, NULL, onvalch, NULL)

    // Obsolete macros
#define D4D_DECLARE_STD_ICON1(name, text, x, y, cx, cy, tx, ty, pBmp0, font, onvalch) \
    D4D_DECLARE_ICON_BEGIN(name, text, x, y, cx, cy, tx, ty, (D4D_ICON_F_DEFAULT), NULL, font, NULL, onvalch, NULL)\
    D4D_DECLARE_ICON_BMP((pBmp0))\
    D4D_DECLARE_ICON_END()

#define D4D_DECLARE_STD_ICON2(name, text, x, y, cx, cy, tx, ty, pBmp1, pBmp0, font, onvalch) \
    D4D_DECLARE_ICON_BEGIN(name, text, x, y, cx, cy, tx, ty, (D4D_ICON_F_DEFAULT), NULL, font, NULL, onvalch, NULL)\
    D4D_DECLARE_ICON_BMP((pBmp0))\
    D4D_DECLARE_ICON_BMP((pBmp1))\
    D4D_DECLARE_ICON_END()

#define D4D_DECLARE_STD_ICON1_INRAM(name, text, x, y, cx, cy, tx, ty, pBmp0, font, onvalch) \
    D4D_DECLARE_ICON_BEGIN_INRAM(name, text, x, y, cx, cy, tx, ty, (D4D_ICON_F_DEFAULT), NULL, font, NULL, onvalch, NULL)\
    D4D_DECLARE_ICON_BMP((pBmp0))\
    D4D_DECLARE_ICON_END()

#define D4D_DECLARE_STD_ICON2_INRAM(name, text, x, y, cx, cy, tx, ty, pBmp1, pBmp0, font, onvalch) \
    D4D_DECLARE_ICON_BEGIN_INRAM(name, text, x, y, cx, cy, tx, ty, (D4D_ICON_F_DEFAULT), NULL, font, NULL, onvalch, NULL)\
    D4D_DECLARE_ICON_BMP((pBmp0))\
    D4D_DECLARE_ICON_BMP((pBmp1))\
    D4D_DECLARE_ICON_END()

/******************************************************************************
* Global variables
******************************************************************************/

/******************************************************************************
* Global functions
******************************************************************************/

/*********************************************************
*
* global functions
*
*********************************************************/
void D4D_IconSetIndex(D4D_OBJECT_PTR pThis, D4D_ICON_INDEX index);
void D4D_IconChangeIndex(D4D_OBJECT_PTR pThis, sByte incr);
D4D_ICON_INDEX D4D_IconGetIndex(D4D_OBJECT_PTR pThis);

#if D4D_ICON_ENABLE_ANIMATION == D4D_TRUE
  void D4D_IconAnimationStart(D4D_OBJECT_PTR pThis);
  void D4D_IconAnimationStop(D4D_OBJECT_PTR pThis);
  void D4D_IconAnimationSetCounts(D4D_OBJECT_PTR pThis, Word cnt);
#endif

D4D_ICON_INDEX D4D_IconGetBmpCount(D4D_OBJECT_PTR pThis);
// Obsolete functions, replaced by any general
#define D4D_IconSetText D4D_SetText




#endif /* __D4D_ICON_H */