d4d_list_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_LIST_BOX_H
#define __D4D_LIST_BOX_H

extern const D4D_OBJECT_SYS_FUNCTION d4d_listBoxSysFunc;
void D4D_ListBoxScrollBarsFeedBack(D4D_OBJECT* pThis, D4D_INDEX old_position, D4D_INDEX new_position);
/******************************************************************************
* D4D LIST BOX setting  constants
*
*/
//********************* List Box flags for button specific flags *****************
#define D4D_LIST_BOX_F_SIDEBAR    (0x01 << D4D_OBJECT_F_OBJECT_SHIFT)   

#ifndef D4D_LIST_BOX_F_DEFAULT
  #define D4D_LIST_BOX_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_DENTED)
#endif

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

#ifndef D4D_LIST_BOX_SCRLBR_WIDTH
  #define D4D_LIST_BOX_SCRLBR_WIDTH  ( 20 )
#endif

#ifndef D4D_LIST_BOX_SCRLBR_STEP
  #define D4D_LIST_BOX_SCRLBR_STEP  ( 1 )
#endif

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

#ifndef D4D_LIST_BOX_ITEM_FNT_PRTY_DEFAULT
  #define D4D_LIST_BOX_ITEM_FNT_PRTY_DEFAULT  ( 0 )
#endif

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

typedef sByte D4D_LIST_BOX_INDEX;

typedef struct
{
  D4D_TCHAR* pText;     
  void* pUser;          
}D4D_LIST_BOX_ITEM;

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

typedef struct
{
   D4D_LIST_BOX_INDEX ix;
   D4D_LIST_BOX_INDEX page_ix;
   const D4D_LIST_BOX_ITEM*  pItems;
} D4D_LIST_BOX_DATA;

typedef struct
{
    D4D_FONT  itemsFontId;
    D4D_LIST_BOX_INDEX posCnt; // Number of visiable position
    D4D_COOR textOff; // text offset between individual item on screen
    D4D_LIST_BOX_DATA* pData;     // ListBox volatile data struct
    D4D_LSTBX_ON_EVENT OnEvent;
} D4D_LIST_BOX;


#define D4D_LIST_BOX_CHILD_SCROLL_BAR_IX 1

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

// getting the LIST_BOX structure from general OBJECT
#define D4D_GET_LIST_BOX(pObj) ((D4D_LIST_BOX*)((pObj)->pParam))

#define D4D_GET_LIST_BOX_SCROLL_BAR(pObj) ((D4D_OBJECT*)((pObj)->pRelations[D4D_LIST_BOX_CHILD_SCROLL_BAR_IX]))

/******************************************************************************
* D4D LIST BOX setting  public macros
*
*/
/**************************************************************************/ 
#define _D4D_DECLARE_LIST_BOX_BEGIN(type, name, x, y, cx, cy, radius, pMargin, pParent, flags, pScheme,\
    itemsFontId, posCnt, listBoxItemsOff, pUser, pOnEvent, pOnUsrMsg) \
    extern type D4D_LIST_BOX_ITEM name##_items[];\
    extern type D4D_OBJECT name##_scrollBarVer;\
    static D4D_LIST_BOX_DATA name##_data = { 0, 0, (const D4D_LIST_BOX_ITEM*)&(name##_items[0])};\
    static const D4D_OBJECT * const name##_relations[] = {pParent, &name##_scrollBarVer, NULL};\
    static type D4D_LIST_BOX name##_params = \
    { \
        itemsFontId,        \
        posCnt, \
        listBoxItemsOff, \
        &(name##_data), \
        pOnEvent \
    }; \
    \
    D4D_DECLARE_OBJECT(type, name, x, y, cx, cy, radius, pMargin, name##_relations, pOnUsrMsg, &d4d_listBoxSysFunc, &(name##_params), flags, pUser, pScheme)\
    \
    static const D4D_OBJECT* const name##_scrollBarVerRelations[] = {&name, NULL};\
    _D4D_DECLARE_SCROLL_BAR(type, name##_scrollBarVer,  (D4D_COOR)(cx - D4D_LIST_BOX_SCRLBR_WIDTH - 2*D4D_BEVEL_WIDTH), 0, D4D_LIST_BOX_SCRLBR_WIDTH, (D4D_COOR)(cy - 2*D4D_BEVEL_WIDTH),\
     radius, NULL, name##_scrollBarVerRelations, D4D_LIST_BOX_F_SCRLBRS_DEFAULT, pScheme, (void*)&name, D4D_ListBoxScrollBarsFeedBack, NULL) \
    \
    type D4D_LIST_BOX_ITEM name##_items[] = { \


/**************************************************************************/ 
#define D4D_DECLARE_LIST_BOX_ITEM(pText, pUser) { pText, (void*)pUser},

/**************************************************************************/ 
#define D4D_DECLARE_LIST_BOX_END() { NULL, NULL} };

/**************************************************************************/ 
#define D4D_DECLARE_LIST_BOX_BEGIN(name, x, y, cx, cy, flags, pParent, pScheme, itemsFontId, posCnt, listBoxItemsOff, pUser, pOnEvent, pOnUsrMsg) \
 _D4D_DECLARE_LIST_BOX_BEGIN(D4D_CONST, name, x, y, cx, cy, 0, (D4D_MARGIN*)&listBox_marginDefault, pParent, flags, pScheme,\
    itemsFontId, posCnt, listBoxItemsOff, pUser, pOnEvent, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_LIST_BOX_BEGIN(name, x, y, cx, cy, pParent, itemsFontId, pOnEvent) \
    D4D_DECLARE_LIST_BOX_BEGIN(name, x, y, cx, cy, (D4D_LIST_BOX_F_DEFAULT), pParent, NULL, itemsFontId, 0, 0, NULL, pOnEvent, NULL)

// Rounded listBox definition
/**************************************************************************/ 
#define D4D_DECLARE_RLIST_BOX_BEGIN(name, x, y, cx, cy, radius, flags, pParent, pScheme, itemsFontId, posCnt, listBoxItemsOff, pUser, pOnEvent, pOnUsrMsg) \
 _D4D_DECLARE_LIST_BOX_BEGIN(D4D_CONST, name, x, y, cx, cy, radius, (D4D_MARGIN*)&listBox_marginDefault, pParent, flags, pScheme,\
    itemsFontId, posCnt, listBoxItemsOff, pUser, pOnEvent, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_RLIST_BOX_BEGIN(name, x, y, cx, cy, radius, pParent, itemsFontId, pOnEvent) \
    D4D_DECLARE_RLIST_BOX_BEGIN(name, x, y, cx, cy, radius, (D4D_LIST_BOX_F_DEFAULT), pParent, NULL, itemsFontId, 0, 0, NULL, pOnEvent, NULL)


//IN RAM instantions macros
/**************************************************************************/ 
#define D4D_DECLARE_LIST_BOX_BEGIN_INRAM(name, x, y, cx, cy, flags, pParent, pScheme, itemsFontId, posCnt, listBoxItemsOff, pUser, pOnEvent, pOnUsrMsg) \
 _D4D_DECLARE_LIST_BOX_BEGIN(D4D_NO_CONST, name, x, y, cx, cy, 0, (D4D_MARGIN*)&listBox_marginDefault, pParent, flags, pScheme,\
    itemsFontId, posCnt, listBoxItemsOff, pUser, pOnEvent, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_LIST_BOX_BEGIN_INRAM(name, x, y, cx, cy, pParent, itemsFontId, pOnEvent) \
    D4D_DECLARE_LIST_BOX_BEGIN_INRAM(name, x, y, cx, cy, (D4D_LIST_BOX_F_DEFAULT), pParent, NULL, itemsFontId, 0, 0, NULL, pOnEvent, NULL)


// Rounded listBox definition
/**************************************************************************/ 
#define D4D_DECLARE_RLIST_BOX_BEGIN_INRAM(name, x, y, cx, cy, radius, flags, pParent, pScheme, itemsFontId, posCnt, listBoxItemsOff, pUser, pOnEvent, pOnUsrMsg) \
 _D4D_DECLARE_LIST_BOX_BEGIN(D4D_NO_CONST, name, x, y, cx, cy, radius, (D4D_MARGIN*)&listBox_marginDefault, pParent, flags, pScheme,\
    itemsFontId, posCnt, listBoxItemsOff, pUser, pOnEvent, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_RLIST_BOX_BEGIN_INRAM(name, x, y, cx, cy, radius, pParent, itemsFontId, pOnEvent) \
    D4D_DECLARE_RLIST_BOX_BEGIN_INRAM(name, x, y, cx, cy, radius, (D4D_LIST_BOX_F_DEFAULT), pParent, NULL, itemsFontId, 0, 0, NULL, pOnEvent, NULL)

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

/******************************************************************************
* Global functions
******************************************************************************/
D4D_LIST_BOX_INDEX D4D_ListBoxGetIndex(D4D_OBJECT* pThis);

void  D4D_ListBoxSetIndex(D4D_OBJECT* pThis, D4D_LIST_BOX_INDEX ix);
D4D_LIST_BOX_INDEX D4D_ListBoxGetItemCount(D4D_OBJECT_PTR pThis);
D4D_LIST_BOX_INDEX D4D_ListBoxFindUserDataItem(D4D_OBJECT_PTR pThis, void* pUser);
void* D4D_ListBoxGetItemUserData(D4D_OBJECT_PTR pThis);
D4D_TCHAR* D4D_ListBoxGetItemText(D4D_OBJECT_PTR pThis);
D4D_TCHAR* D4D_ListBoxGetItemTextIx(D4D_OBJECT_PTR pThis, D4D_LIST_BOX_INDEX ix);
void D4D_ListBoxEnsureVisible(D4D_OBJECT* pThis);

void D4D_ListBoxChangeItemList(D4D_OBJECT_PTR pThis, const D4D_LIST_BOX_ITEM* pItems);
D4D_LIST_BOX_ITEM* D4D_ListBoxGetItemList(D4D_OBJECT_PTR pThis);
#endif /* __D4D_LIST_BOX_H  */