d4d_combo_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_COMBO_BOX_H
#define __D4D_COMBO_BOX_H

extern const D4D_OBJECT_SYS_FUNCTION d4d_comboBoxSysFunc;
void D4D_ComboBoxListFeedBack(D4D_OBJECT* pThis, D4D_EVENTID eventId);
void D4D_ComboBoxEditFeedBack(D4D_OBJECT* pThis, D4D_EVENTID eventId);
void D4D_ComboBoxButtonFeedBack(D4D_OBJECT* pThis);
Byte D4D_ComboBoxButtonMsgFeedBack(D4D_MESSAGE* pMsg);
Byte D4D_ComboBoxListBoxMsgFeedBack(D4D_MESSAGE* pMsg);
/******************************************************************************
* Constants
******************************************************************************/

/******************************************************************************
* D4D COMBO BOX setting  constants
*
*/
#ifndef D4D_COMBO_BOX_F_DEFAULT
  #define D4D_COMBO_BOX_F_DEFAULT  (D4D_OBJECT_F_VISIBLE | D4D_OBJECT_F_ENABLED | D4D_OBJECT_F_TABSTOP | D4D_OBJECT_F_TOUCHENABLE | D4D_OBJECT_F_FOCUSRECT | D4D_OBJECT_F_MOUSE_NORMAL | D4D_OBJECT_F_BEVEL_RAISED)
#endif

#ifndef D4D_COMBO_BOX_F_EDITBOX_DEFAULT
  #define D4D_COMBO_BOX_F_EDITBOX_DEFAULT       (D4D_OBJECT_F_VISIBLE | D4D_OBJECT_F_ENABLED | D4D_OBJECT_F_TABSTOP | D4D_OBJECT_F_TOUCHENABLE  | D4D_OBJECT_F_FASTTOUCH | D4D_OBJECT_F_MOUSE_NORMAL | D4D_OBJECT_F_BEVEL_DENTED)
#endif

#ifndef D4D_COMBO_BOX_F_BTN_DEFAULT
  #define D4D_COMBO_BOX_F_BTN_DEFAULT       (D4D_OBJECT_F_VISIBLE | D4D_OBJECT_F_ENABLED | D4D_OBJECT_F_TABSTOP | D4D_OBJECT_F_TOUCHENABLE | D4D_OBJECT_F_FASTTOUCH | D4D_OBJECT_F_MOUSE_NORMAL | D4D_OBJECT_F_BEVEL_RAISED | D4D_BTN_F_3D | D4D_BTN_F_CONT_RECT)
#endif

#ifndef D4D_COMBO_BOX_F_LISTBOX_DEFAULT
  #define D4D_COMBO_BOX_F_LISTBOX_DEFAULT  (D4D_OBJECT_F_ENABLED | D4D_OBJECT_F_TABSTOP | D4D_OBJECT_F_TOUCHENABLE | D4D_OBJECT_F_FASTTOUCH | D4D_OBJECT_F_FOCUSRECT | D4D_OBJECT_F_MOUSE_NORMAL | D4D_OBJECT_F_BEVEL_RAISED)
#endif

#ifndef D4D_COMBO_BOX_ITEM_FNT_PRTY_DEFAULT
  #define D4D_COMBO_BOX_ITEM_FNT_PRTY_DEFAULT  ( 0 )
#endif

#ifndef D4D_COMBO_BOX_STR_MAX_LEN
  #define D4D_COMBO_BOX_STR_MAX_LEN  (20)
#endif

/******************************************************************************
* D4D COMBO BOX setting  public types
*
*/
/**************************************************************************/ 
typedef void (*D4D_CMBBX_ON_EVENT)(D4D_OBJECT* pThis, D4D_EVENTID eventId);

// ComboBox configuration (goes to ROM by default)



/******************************************************************************
* Private Types
******************************************************************************/
typedef D4D_LIST_BOX_INDEX D4D_COMBO_BOX_INDEX;
typedef D4D_LIST_BOX_ITEM D4D_COMBO_BOX_ITEM;

typedef struct D4D_COMBO_BOX_DATA_S
{
  D4D_LIST_BOX_INDEX real_ix;
}D4D_COMBO_BOX_DATA;

typedef struct D4D_COMBO_BOX_S
{
  D4D_COOR              list_size_y;
  D4D_COMBO_BOX_DATA*   pData;
  D4D_CMBBX_ON_EVENT    OnEvent;
}D4D_COMBO_BOX;


#define D4D_COMBO_BOX_CHILD_EDIT_BOX_IX 1
#define D4D_COMBO_BOX_CHILD_BUTTON_IX   2
#define D4D_COMBO_BOX_CHILD_LIST_BOX_IX 3

D4D_EXTERN_BMP(bmp_arrow);

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

// getting the COMBO_BOX structure from general OBJECT
#define D4D_GET_COMBO_BOX(pObj) ((D4D_COMBO_BOX*)((pObj)->pParam))
#define D4D_GET_COMBO_BOX_DATA(pObj) ((D4D_COMBO_BOX_DATA*)((D4D_GET_COMBO_BOX(pObj))->pData))

#define D4D_GET_COMBO_BOX_EDIT_BOX(pObj)        ((D4D_OBJECT*)((pObj)->pRelations[D4D_COMBO_BOX_CHILD_EDIT_BOX_IX]))
#define D4D_GET_COMBO_BOX_BUTTON(pObj)          ((D4D_OBJECT*)((pObj)->pRelations[D4D_COMBO_BOX_CHILD_BUTTON_IX]))
#define D4D_GET_COMBO_BOX_LIST_BOX(pObj)        ((D4D_OBJECT*)((pObj)->pRelations[D4D_COMBO_BOX_CHILD_LIST_BOX_IX]))

/******************************************************************************
* D4D COMBO BOX setting  public macros
*
*/
/**************************************************************************/ 
#define _D4D_DECLARE_COMBO_BOX_BEGIN(type, name, x, y, cx, cy, cy_list, radius, pMargin, pParent, flags, pScheme,\
    itemsFontId, maxStrLen, posCnt, comboBoxItemsOff, pUser, pOnEvent, pOnUsrMsg) \
    extern type D4D_OBJECT name##_EditBox;\
    extern type D4D_OBJECT name##_Button;\
    extern type D4D_OBJECT name##_ListBox;\
    static D4D_COMBO_BOX_DATA name##_data = {-1};\
    static const D4D_OBJECT * type name##_relations[] = {pParent, &name##_EditBox, &name##_Button, &name##_ListBox, NULL};\
    static type D4D_COMBO_BOX name##_params = \
    { \
        cy_list,      \
        &(name##_data), \
        pOnEvent      \
    }; \
    \
    D4D_DECLARE_OBJECT(type, name, x, y, (cx), (D4D_COOR)((cy) + cy_list), radius, pMargin, name##_relations, pOnUsrMsg, &d4d_comboBoxSysFunc, &(name##_params), (flags/* & ~(D4D_OBJECT_F_BEVEL_MASK | D4D_OBJECT_F_FOCUSRECT)*/), pUser, pScheme)\
    \
    static const D4D_OBJECT* const name##_EditBoxRelations[] = {&name, NULL};\
    _D4D_DECLARE_EDIT_BOX(type, name##_EditBox, 0, 0, (D4D_COOR)((cx) - (cy)), (cy), radius, (D4D_MARGIN*)&d4d_marginDefault, name##_EditBoxRelations, D4D_COMBO_BOX_F_EDITBOX_DEFAULT, pScheme, NULL, itemsFontId, maxStrLen, (void*)&name, D4D_ComboBoxEditFeedBack, NULL) \
    static const D4D_OBJECT* const name##_ButtonsRelations[] = {&name, NULL};\
    _D4D_DECLARE_BUTTON(type, name##_Button, NULL, (D4D_COOR)((cx) - (cy)), 0, (cy), (cy), radius, NULL, name##_ButtonsRelations, D4D_COMBO_BOX_F_BTN_DEFAULT, &bmp_arrow, &bmp_arrow, pScheme, 0, (void*)&name, D4D_ComboBoxButtonFeedBack, D4D_ComboBoxButtonMsgFeedBack) \
    _D4D_DECLARE_LIST_BOX_BEGIN(type, name##_ListBox, 0, (cy), (cx), cy_list, radius, (D4D_MARGIN*)&d4d_marginDefault, &name, D4D_COMBO_BOX_F_LISTBOX_DEFAULT, pScheme, itemsFontId, posCnt, comboBoxItemsOff, (void*)&name, D4D_ComboBoxListFeedBack, D4D_ComboBoxListBoxMsgFeedBack)

/**************************************************************************/ 
#define D4D_DECLARE_COMBO_BOX_ITEM      D4D_DECLARE_LIST_BOX_ITEM

/**************************************************************************/ 
#define D4D_DECLARE_COMBO_BOX_END       D4D_DECLARE_LIST_BOX_END


/**************************************************************************/ 
#define D4D_DECLARE_COMBO_BOX_BEGIN(name, x, y, cx, cy, cy_list, flags, pParent, pScheme, itemsFontId, maxStrLen, posCnt, comboBoxItemsOff, pUser, pOnEvent, pOnUsrMsg) \
 _D4D_DECLARE_COMBO_BOX_BEGIN(D4D_CONST, name, x, y, cx, cy, cy_list, 0, (D4D_MARGIN*)&comboBox_marginDefault, pParent, flags, pScheme,\
    itemsFontId, maxStrLen, posCnt, comboBoxItemsOff, pUser, pOnEvent, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_COMBO_BOX_BEGIN(name, x, y, cx, cy, cy_list, pParent, itemsFontId, pOnEvent) \
    D4D_DECLARE_COMBO_BOX_BEGIN(name, x, y, cx, cy, cy_list, (D4D_COMBO_BOX_F_DEFAULT), pParent, NULL, itemsFontId, D4D_COMBO_BOX_STR_MAX_LEN, 0, 0, NULL, pOnEvent, NULL)

// Rounded comboBox definition
/**************************************************************************/ 
#define D4D_DECLARE_RCOMBO_BOX_BEGIN(name, x, y, cx, cy, cy_list, radius, flags, pParent, pScheme, itemsFontId, maxStrLen, posCnt, comboBoxItemsOff, pUser, pOnEvent, pOnUsrMsg) \
 _D4D_DECLARE_COMBO_BOX_BEGIN(D4D_CONST, name, x, y, cx, cy, cy_list, radius, (D4D_MARGIN*)&comboBox_marginDefault, pParent, flags, pScheme,\
    itemsFontId, maxStrLen, posCnt, comboBoxItemsOff, pUser, pOnEvent, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_RCOMBO_BOX_BEGIN(name, x, y, cx, cy, cy_list, radius, pParent, itemsFontId, pOnEvent) \
    D4D_DECLARE_RCOMBO_BOX_BEGIN(name, x, y, cx, cy, cy_list, radius, (D4D_COMBO_BOX_F_DEFAULT), pParent, NULL, itemsFontId, D4D_COMBO_BOX_STR_MAX_LEN, 0, 0, NULL, pOnEvent, NULL)


//IN RAM instantions macros
/**************************************************************************/ 
#define D4D_DECLARE_COMBO_BOX_BEGIN_INRAM(name, x, y, cx, cy, cy_list, flags, pParent, pScheme, itemsFontId, maxStrLen, posCnt, comboBoxItemsOff, pUser, pOnEvent, pOnUsrMsg) \
 _D4D_DECLARE_COMBO_BOX_BEGIN(D4D_NO_CONST, name, x, y, cx, cy, cy_list, 0, (D4D_MARGIN*)&comboBox_marginDefault, pParent, flags, pScheme,\
    itemsFontId, maxStrLen, posCnt, comboBoxItemsOff, pUser, pOnEvent, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_COMBO_BOX_BEGIN_INRAM(name, x, y, cx, cy, cy_list, pParent, itemsFontId, pOnEvent) \
    D4D_DECLARE_COMBO_BOX_BEGIN_INRAM(name, x, y, cx, cy, cy_list, (D4D_COMBO_BOX_F_DEFAULT), pParent, NULL, itemsFontId, D4D_COMBO_BOX_STR_MAX_LEN, 0, 0, NULL, pOnEvent, NULL)


// Rounded comboBox definition
/**************************************************************************/ 
#define D4D_DECLARE_RCOMBO_BOX_BEGIN_INRAM(name, x, y, cx, cy, cy_list, radius, flags, pParent, pScheme, itemsFontId, maxStrLen, posCnt, comboBoxItemsOff, pUser, pOnEvent, pOnUsrMsg) \
 _D4D_DECLARE_COMBO_BOX_BEGIN(D4D_NO_CONST, name, x, y, cx, cy, cy_list, radius, (D4D_MARGIN*)&comboBox_marginDefault, pParent, flags, pScheme,\
    itemsFontId, maxStrLen, posCnt, comboBoxItemsOff, pUser, pOnEvent, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_RCOMBO_BOX_BEGIN_INRAM(name, x, y, cx, cy, cy_list, radius, pParent, itemsFontId, pOnEvent) \
    D4D_DECLARE_RCOMBO_BOX_BEGIN_INRAM(name, x, y, cx, cy, cy_list, radius, (D4D_COMBO_BOX_F_DEFAULT), pParent, NULL, itemsFontId, D4D_COMBO_BOX_STR_MAX_LEN, 0, 0, NULL, pOnEvent, NULL)

/******************************************************************************
* Global variables
******************************************************************************/
extern const D4D_MARGIN comboBox_marginDefault;

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

/******************************************************************************
* Begin of D4D_COMBO_BOX public functions
*/
/**************************************************************************/ 
#define D4D_ComboBoxGetItemCount(pThis) D4D_ListBoxGetItemCount(D4D_GET_COMBO_BOX_LIST_BOX(pThis))

/**************************************************************************/ 
#define D4D_ComboBoxFindUserDataItem(pThis, pUser) D4D_ListBoxFindUserDataItem(D4D_GET_COMBO_BOX_LIST_BOX(pThis), pUser)

/**************************************************************************/ 
#define D4D_ComboBoxGetItemUserData(pThis) D4D_ListBoxGetItemUserData(D4D_GET_COMBO_BOX_LIST_BOX(pThis))

/**************************************************************************/ 
#define D4D_ComboBoxGetItemText(pThis) D4D_ListBoxGetItemText(D4D_GET_COMBO_BOX_LIST_BOX(pThis))

/**************************************************************************/ 
#define D4D_ComboBoxGetItemTextIx(pThis, ix) D4D_ListBoxGetItemTextIx(D4D_GET_COMBO_BOX_LIST_BOX(pThis), ix)

/**************************************************************************/ 
#define D4D_ComboBoxEnsureVisible(pThis) D4D_ListBoxEnsureVisible(D4D_GET_COMBO_BOX_LIST_BOX(pThis))

/**************************************************************************/ 
#define D4D_ComboBoxChangeItemList(pThis, pItems) D4D_ListBoxChangeItemList(D4D_GET_COMBO_BOX_LIST_BOX(pThis), pItems)

/**************************************************************************/ 
#define D4D_ComboBoxGetItemList(pThis) D4D_ListBoxGetItemList(D4D_GET_COMBO_BOX_LIST_BOX(pThis))

/******************************************************************************
*       End of public functions                                               */
/******************************************************************************/
#endif /* __D4D_COMBO_BOX_H  */