d4d_group_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_GROUP_BOX_H
#define __D4D_GROUP_BOX_H

extern const D4D_OBJECT_SYS_FUNCTION d4d_groupBoxSysFunc;

/******************************************************************************
* D4D GROUP BOX setting  constants
*
*/
//********************* Group Box flags for its specific flags *****************
  #define D4D_GROUP_BOX_F_CONTENT_OUTLINE            (0x01 << D4D_OBJECT_F_OBJECT_SHIFT)        


#ifndef D4D_GROUP_BOX_F_DEFAULT
  #define D4D_GROUP_BOX_F_DEFAULT  (D4D_OBJECT_F_VISIBLE | D4D_OBJECT_F_ENABLED | D4D_OBJECT_F_MOUSE_NORMAL |  D4D_OBJECT_F_TOUCHENABLE | D4D_OBJECT_F_BEVEL_RAISED | D4D_GROUP_BOX_F_CONTENT_OUTLINE)
#endif

#ifndef D4D_GROUP_BOX_TEXT_OFFSET
  #define D4D_GROUP_BOX_TEXT_OFFSET 6
#endif

#ifndef D4D_GROUP_BOX_HEADER_MARGIN
  #define D4D_GROUP_BOX_HEADER_MARGIN 16
#endif

#ifndef D4D_GROUP_BOX_FRAME_MARGIN
  #define D4D_GROUP_BOX_FRAME_MARGIN 4
#endif

/******************************************************************************
* Types
******************************************************************************/

// groupBox configuration (goes to ROM by default)

typedef struct
{
    D4D_STRING textBuff;    // group box text
} D4D_GROUP_BOX;


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

// getting the GROUP_BOX structure from general OBJECT
#define D4D_GET_GROUP_BOX(pObj) ((D4D_GROUP_BOX*)((pObj)->pParam))

/******************************************************************************
* D4D GROUP BOX setting  public macros
*
*/
/**************************************************************************/ 
#define _D4D_DECLARE_GROUP_BOX(type, name, x, y, cx, cy, radius, pMargin, pRelations, text, fontId, flags, pScheme, pUser, pOnUsrMsg) \
    static D4D_STR_PROPERTIES name##_strPrties = { D4D_FNT_PRTY_TRANSPARENT_NO_MASK, (D4D_TXT_PRTY_ALIGN_H_CENTER_MASK | D4D_TXT_PRTY_ALIGN_V_CENTER_MASK)}; \
    static type D4D_GROUP_BOX name##_params = \
    { \
        { text, sizeof(text), fontId,  &name##_strPrties, D4D_OBJECT_MAX_TEXT_LEN(text), 0}, /* textBuff */ \
    }; \
    \
    D4D_DECLARE_OBJECT(type, name, x, y, cx, cy, radius, pMargin, pRelations, pOnUsrMsg, &d4d_groupBoxSysFunc, &(name##_params), flags, pUser, pScheme)



/**************************************************************************/ 
#define D4D_DECLARE_GROUP_BOX_BEGIN(name, x, y, cx, cy, radius, pParent, pMargin, text, fontId, flags, pScheme, pUser, pOnUsrMsg)\
    extern const D4D_OBJECT* const name##_pRelations[];\
    _D4D_DECLARE_GROUP_BOX(D4D_CONST, name, x, y, cx, cy, radius, pMargin, name##_pRelations, text, fontId, flags, pScheme, pUser, pOnUsrMsg)\
    D4D_DECLARE_OBJECT_RELATIONS_BEGIN(name##_pRelations, pParent)

/**************************************************************************/ 
#define D4D_DECLARE_GROUP_BOX_OBJECT(name)  D4D_DECLARE_OBJECT_RELATIONS_CHILD(name)

/**************************************************************************/ 
#define D4D_DECLARE_GROUP_BOX_OBJECT_END    D4D_DECLARE_OBJECT_RELATIONS_END

/**************************************************************************/ 
#define D4D_DECLARE_STD_GROUP_BOX_BEGIN(name, x, y, cx, cy, radius, pParent, text, fontId) \
  D4D_DECLARE_GROUP_BOX_BEGIN(name, x, y, cx, cy, radius, pParent, &groupBox_marginDefault, text, fontId, (D4D_GROUP_BOX_F_DEFAULT), NULL, NULL, NULL)


//IN RAM instantions macros
/**************************************************************************/ 
#define D4D_DECLARE_GROUP_BOX_BEGIN_INRAM(name, x, y, cx, cy, radius, pParent, pMargin, text, fontId, flags, pScheme, pUser, pOnUsrMsg)\
    extern const D4D_OBJECT* const name##_pRelations[];\
    _D4D_DECLARE_GROUP_BOX(D4D_NO_CONST, name, x, y, cx, cy, radius, pMargin, name##_pRelations, text, fontId, flags, pScheme, pUser, pOnUsrMsg)\
    D4D_DECLARE_OBJECT_RELATIONS_BEGIN(name##_pRelations, pParent)

/**************************************************************************/ 
#define D4D_DECLARE_STD_GROUP_BOX_BEGIN_INRAM(name, x, y, cx, cy, radius, pParent, text, fontId) \
  D4D_DECLARE_GROUP_BOX_BEGIN_INRAM(name, x, y, cx, cy, radius, pParent, &groupBox_marginDefault, text, fontId, (D4D_GROUP_BOX_F_DEFAULT), NULL,  NULL, NULL)

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

extern D4D_MARGIN groupBox_marginDefault;

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



#endif /* __D4D_GROUP_BOX_H */