d4d_button.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_BUTTON_H
#define __D4D_BUTTON_H

extern const D4D_OBJECT_SYS_FUNCTION d4d_btnSysFunc;

/******************************************************************************
* D4D BUTTON setting  constants
*
*/
#ifndef D4D_BTN_3D_SHIFT
  #define D4D_BTN_3D_SHIFT 1
#endif

//********************* Button flags for button specific flags *****************
  #define D4D_BTN_F_3D            (0x01 << D4D_OBJECT_F_OBJECT_SHIFT)   
  #define D4D_BTN_F_CONT_RECT     (0x02 << D4D_OBJECT_F_OBJECT_SHIFT)   
  #define D4D_BTN_F_INVERT        (0x04 << D4D_OBJECT_F_OBJECT_SHIFT)   

//******************************************************************************

// button configuration (goes to ROM by default)

#ifndef D4D_BTN_F_DEFAULT
  #define D4D_BTN_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_BTN_F_3D)
#endif

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

#ifndef D4D_BTN_FNT_PRTY_DEFAULT
  #define D4D_BTN_FNT_PRTY_DEFAULT  ( 0 )
#endif

#ifndef D4D_BUTTON_3D_FORE_INTENSITY
  #define D4D_BUTTON_3D_FORE_INTENSITY    D4D_BEVEL_FORE_INTENSITY
#endif

#ifndef D4D_BUTTON_3D_BCKG_INTENSITY
  #define D4D_BUTTON_3D_BCKG_INTENSITY    D4D_BEVEL_BCKG_INTENSITY
#endif

/******************************************************************************
* D4D BUTTON setting  public types
*
*/
/**************************************************************************/ 
typedef void (*D4D_BTN_ON_CLICK)(D4D_OBJECT* pThis);

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

typedef Byte D4D_BUTTON_STATUS;

#define D4D_BUTTON_STATUS_PRESSED_MASK          (0x01)
#define D4D_BUTTON_STATUS_1ST_TOUCH_MASK        (0x02)
#define D4D_BUTTON_STATUS_MOUSE_CLICK_MASK      (0x04)


typedef struct
{
    D4D_STRING textBuff;    // button text
    const D4D_BMP*  pBmpNormal;    // normal state bitmap
    const D4D_BMP*  pBmpFocus;     // focused state bitmap
    D4D_BUTTON_STATUS*  pStatus;
    D4D_BTN_ON_CLICK OnClicked;
} D4D_BUTTON;


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

// getting the BUTTON structure from general OBJECT
#define D4D_GET_BUTTON(pObj) ((D4D_BUTTON*)((pObj)->pParam))
#define D4D_GET_BUTTON_STATUS(pObj) ((D4D_BUTTON_STATUS*)(D4D_GET_BUTTON(pObj)->pStatus))


/******************************************************************************
* D4D BUTTON setting  public macros
*
*/
/**************************************************************************/ 
#define _D4D_DECLARE_BUTTON(type, name, text, x, y, cx, cy, radius, pMargin, pRelations, flags, pBmpN, pBmpF, pScheme, fontId, pUser, onclick, pOnUsrMsg) \
    static D4D_BUTTON_STATUS  name##_status = { 0 }; \
    static D4D_STR_PROPERTIES name##_strPrties = { D4D_BTN_FNT_PRTY_DEFAULT, D4D_BTN_TXT_PRTY_DEFAULT}; \
    static type D4D_BUTTON name##_params = \
    { \
        { text, D4D_TEXT_LEN(text), fontId, &name##_strPrties, D4D_OBJECT_MAX_TEXT_LEN(text), 0}, /* textBuff */ \
        pBmpN,      /* pBmpNormal */ \
        pBmpF,      /* pBmpFocus */ \
        &(name##_status), /* Status clear */ \
        onclick     /* Click event */ \
    }; \
    \
    D4D_DECLARE_OBJECT(type, name, x, y, cx, cy, radius, pMargin, pRelations, pOnUsrMsg,  &d4d_btnSysFunc, &(name##_params), flags, pUser, pScheme)

/**************************************************************************/ 
#define D4D_DECLARE_BUTTON(name, text, x, y, cx, cy, flags, pBmpN, pBmpF, pScheme, fontId, pUser, onclick, pOnUsrMsg) \
  _D4D_DECLARE_BUTTON(D4D_CONST, name, text, x, y, cx, cy, 0, NULL, NULL, flags, pBmpN, pBmpF, pScheme, fontId, pUser, onclick, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_BUTTON(name, text, x, y, cx, cy, pBmpN, pBmpF, fontId, onclick) \
    D4D_DECLARE_BUTTON(name, text, x, y, cx, cy, (D4D_BTN_F_DEFAULT), pBmpN, pBmpF, NULL, fontId, NULL, onclick, NULL)

/**************************************************************************/ 
#define D4D_DECLARE_TXT_BUTTON(name, text, x, y, cx, cy, fontId, onclick) \
    D4D_DECLARE_STD_BUTTON(name, text, x, y, cx, cy,  NULL, NULL, \
        fontId, onclick)


// Rounded button definition
/**************************************************************************/ 
#define D4D_DECLARE_RBUTTON(name, text, x, y, cx, cy, radius, flags, pBmpN, pBmpF, pScheme, fontId, pUser, onclick, pOnUsrMsg) \
  _D4D_DECLARE_BUTTON(D4D_CONST, name, text, x, y, cx, cy, radius, NULL, NULL, flags, pBmpN, pBmpF, pScheme, fontId, pUser, onclick, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_RBUTTON(name, text, x, y, cx, cy, radius, pBmpN, pBmpF, fontId, onclick) \
    D4D_DECLARE_RBUTTON(name, text, x, y, cx, cy, radius, (D4D_BTN_F_DEFAULT), pBmpN, pBmpF, NULL, fontId, NULL, onclick, NULL)

/**************************************************************************/ 
#define D4D_DECLARE_TXT_RBUTTON(name, text, x, y, cx, cy, radius, fontId, onclick) \
    D4D_DECLARE_STD_RBUTTON(name, text, x, y, cx, cy,  radius, NULL, NULL, \
        fontId, onclick)

// IN RAM instantion macros
/**************************************************************************/ 
#define D4D_DECLARE_BUTTON_INRAM(name, text, x, y, cx, cy, flags, pBmpN, pBmpF, pScheme, fontId, pUser, onclick, pOnUsrMsg) \
  _D4D_DECLARE_BUTTON(D4D_NO_CONST, name, text, x, y, cx, cy, 0, NULL, NULL, flags, pBmpN, pBmpF, pScheme, fontId, pUser, onclick, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_BUTTON_INRAM(name, text, x, y, cx, cy, bmpN, bmpF, fontId, onclick) \
    D4D_DECLARE_BUTTON_INRAM(name, text, x, y, cx, cy, (D4D_BTN_F_DEFAULT), bmpN, bmpF, NULL, fontId, NULL, onclick, NULL)

/**************************************************************************/ 
#define D4D_DECLARE_TXT_BUTTON_INRAM(name, text, x, y, cx, cy, fontId, onclick) \
    D4D_DECLARE_STD_BUTTON_INRAM(name, text, x, y, cx, cy,  NULL, NULL, \
        fontId, onclick)

// Rounded button definition
/**************************************************************************/ 
#define D4D_DECLARE_RBUTTON_INRAM(name, text, x, y, cx, cy, radius, flags, pBmpN, pBmpF, pScheme, fontId, pUser, onclick, pOnUsrMsg) \
  _D4D_DECLARE_BUTTON(D4D_NO_CONST, name, text, x, y, cx, cy, radius, NULL, NULL, flags, pBmpN, pBmpF, pScheme, fontId, pUser, onclick, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_RBUTTON_INRAM(name, text, x, y, cx, cy, radius, bmpN, bmpF, fontId, onclick) \
    D4D_DECLARE_RBUTTON_INRAM(name, text, x, y, cx, cy, radius, (D4D_BTN_F_DEFAULT), bmpN, bmpF, NULL, fontId, NULL, onclick, NULL)

/**************************************************************************/ 
#define D4D_DECLARE_TXT_RBUTTON_INRAM(name, text, x, y, cx, cy, radius, fontId, onclick) \
    D4D_DECLARE_STD_RBUTTON_INRAM(name, text, x, y, cx, cy,  radius, NULL, NULL, \
        fontId, onclick)

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

/*********************************************************
*
* Object API
*
*********************************************************/

// Obsolete functions, replaced by any general
#define  D4D_BtnSetText D4D_SetText

#endif /*__D4D_BUTTON_H*/