d4d_check_box.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_CHECKBOX_H
#define __D4D_CHECKBOX_H

extern const D4D_OBJECT_SYS_FUNCTION d4d_checkBoxSysFunc;
/******************************************************************************
* D4D CHECK BOX setting  constants
*
*/
#ifndef D4D_CHECKBOX_BORDER_OFFSET
  #define D4D_CHECKBOX_BORDER_OFFSET 3
#endif

#ifndef D4D_CHECKBOX_TEXT_OFFSET
  #define D4D_CHECKBOX_TEXT_OFFSET 4
#endif

#ifndef D4D_COLOR_CHECKBOX_ICON_BCKG
  #define D4D_COLOR_CHECKBOX_ICON_BCKG  D4D_COLOR_WHITE
#endif


//********************* Check Box flags for check box specific flags *****************
#define D4D_CHECKBOX_F_ICON_RECTANGLE   (0x01 << D4D_OBJECT_F_OBJECT_SHIFT)     


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

#ifndef D4D_CHECKBOX_F_DEFAULT
  #define D4D_CHECKBOX_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_CHECKBOX_F_ICON_RECTANGLE )
#endif

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

#ifndef D4D_CHECKBOX_FNT_PRTY_DEFAULT
  #define D4D_CHECKBOX_FNT_PRTY_DEFAULT  ( 0 )
#endif

/******************************************************************************
* D4D CHECK BOX setting  public types
*
*/
/**************************************************************************/ 
typedef void (*D4D_CHCKBX_ON_CHANGE)(D4D_OBJECT* pThis);

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

// Check box configuration (goes to ROM by default)


typedef Byte D4D_CHECKBOX_STATUS;

#define D4D_CHECKBOX_STATUS_PRESSED_MASK    (0x01)
#define D4D_CHECKBOX_STATUS_CHECKED_MASK    (0x02)

typedef struct
{
    D4D_STRING textBuff;    // check box text
    const D4D_BMP*  pBmpChecked;    // Checked state bitmap
    const D4D_BMP*  pBmpUnChecked;    // Checked state bitmap
    D4D_CHECKBOX_STATUS*  pStatus;
    D4D_CHCKBX_ON_CHANGE OnChange;
} D4D_CHECKBOX;


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

// getting the CHECK BOX structure from general OBJECT
#define D4D_GET_CHECKBOX(pObj) ((D4D_CHECKBOX*)((pObj)->pParam))
#define D4D_GET_CHECKBOX_STATUS(pObj) ((D4D_CHECKBOX_STATUS*)(D4D_GET_CHECKBOX(pObj)->pStatus))



/******************************************************************************
* D4D CHECK BOX setting  public macros
*
*/
/**************************************************************************/ 
#define _D4D_DECLARE_CHECKBOX(type, name, text, x, y, cx, cy, radius, pMargin, pRelations, flags, pbmpChecked, pbmpUnChecked, pScheme, fontId, pUser, onchange, pOnUsrMsg) \
    static D4D_CHECKBOX_STATUS name##_status = { 0 }; \
    static D4D_STR_PROPERTIES name##_strPrties = { D4D_CHECKBOX_FNT_PRTY_DEFAULT, D4D_CHECKBOX_TXT_PRTY_DEFAULT}; \
    static type D4D_CHECKBOX name##_params = \
    { \
        { text, D4D_TEXT_LEN(text), fontId, &name##_strPrties, D4D_OBJECT_MAX_TEXT_LEN(text), 0}, /* textBuff */ \
        pbmpChecked,      /* pBmpChecked */ \
        pbmpUnChecked,      /* pBmpUnChecked */ \
        &(name##_status), /* Status clear */ \
        onchange     /* Click event */ \
    }; \
    \
    D4D_DECLARE_OBJECT(type, name, x, y, cx, cy, radius, pMargin, pRelations, pOnUsrMsg, &d4d_checkBoxSysFunc, &(name##_params), flags, pUser, pScheme)

/**************************************************************************/ 
#define D4D_DECLARE_CHECKBOX(name, text, x, y, cx, cy, flags, pbmpChecked, pbmpUnChecked, pScheme, fontId, pUser, onchange, pOnUsrMsg) \
  _D4D_DECLARE_CHECKBOX(D4D_CONST, name, text, x, y, cx, cy, 0, (D4D_MARGIN*)&d4d_marginDefault, NULL, flags, pbmpChecked, pbmpUnChecked, pScheme, fontId, pUser, onchange, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_CHECKBOX(name, text, x, y, cx, cy, pbmpChecked, pbmpUnChecked, fontId, onchange) \
    D4D_DECLARE_CHECKBOX(name, text, x, y, cx, cy, (D4D_CHECKBOX_F_DEFAULT), pbmpChecked, pbmpUnChecked, NULL, fontId, NULL, onchange, NULL)

// Rounded check box definition

/**************************************************************************/ 
#define D4D_DECLARE_RCHECKBOX(name, text, x, y, cx, cy, radius, flags, pbmpChecked, pbmpUnChecked, pScheme, fontId, pUser, onchange, pOnUsrMsg) \
  _D4D_DECLARE_CHECKBOX(D4D_CONST, name, text, x, y, cx, cy, radius, (D4D_MARGIN*)&d4d_marginDefault, NULL, flags, pbmpChecked, pbmpUnChecked, pScheme, fontId, pUser, onchange, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_RCHECKBOX(name, text, x, y, cx, cy, radius, pbmpChecked, pbmpUnChecked, fontId, onchange) \
    D4D_DECLARE_RCHECKBOX(name, text, x, y, cx, cy, radius, (D4D_CHECKBOX_F_DEFAULT), pbmpChecked, pbmpUnChecked, NULL, fontId, NULL, onchange, NULL)


// IN RAM instantions macros
/**************************************************************************/ 
#define D4D_DECLARE_CHECKBOX_INRAM(name, text, x, y, cx, cy, flags, pbmpChecked, pbmpUnChecked, pScheme, fontId, pUser, onchange, pOnUsrMsg) \
  _D4D_DECLARE_CHECKBOX(D4D_NO_CONST, name, text, x, y, cx, cy, 0, (D4D_MARGIN*)&d4d_marginDefault, NULL, flags, pbmpChecked, pbmpUnChecked, pScheme, fontId, pUser, onchange, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_CHECKBOX_INRAM(name, text, x, y, cx, cy, pbmpChecked, pbmpUnChecked, fontId, onchange) \
    D4D_DECLARE_CHECKBOX_INRAM(name, text, x, y, cx, cy, 0, (D4D_CHECKBOX_F_DEFAULT), pbmpChecked, pbmpUnChecked, NULL, fontId, NULL, onchange, NULL)


// Rounded check box definition
/**************************************************************************/ 
#define D4D_DECLARE_RCHECKBOX_INRAM(name, text, x, y, cx, cy, radius, flags, pbmpChecked, pbmpUnChecked, pScheme, fontId, pUser, onchange, pOnUsrMsg) \
  _D4D_DECLARE_CHECKBOX(D4D_NO_CONST, name, text, x, y, cx, cy, radius, (D4D_MARGIN*)&d4d_marginDefault, NULL, flags, pbmpChecked, pbmpUnChecked, pScheme, fontId, pUser, onchange, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_RCHECKBOX_INRAM(name, text, x, y, cx, cy, radius, pbmpChecked, pbmpUnChecked, fontId, onchange) \
    D4D_DECLARE_RCHECKBOX_INRAM(name, text, x, y, cx, cy, radius, (D4D_CHECKBOX_F_DEFAULT), pbmpChecked, pbmpUnChecked, NULL, fontId, NULL, onchange, NULL)

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

void D4D_CheckBoxSetValue(D4D_OBJECT_PTR pThis, D4D_BOOL value);
D4D_BOOL D4D_CheckBoxGetValue(D4D_OBJECT_PTR pThis);

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



#endif /*__D4D_CHECKBOX_H*/