d4d_edit_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_EDIT_BOX_H
#define __D4D_EDIT_BOX_H

extern const D4D_OBJECT_SYS_FUNCTION d4d_editBoxSysFunc;
/******************************************************************************
* D4D EDIT BOX setting  constants
*
*/
#ifndef D4D_EDIT_BOX_F_DEFAULT
  #define D4D_EDIT_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_DENTED)
#endif

#ifndef D4D_EDIT_BOX_FNT_PRTY_DEFAULT
  #define D4D_EDIT_BOX_FNT_PRTY_DEFAULT  ( 0 )
#endif

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

#ifndef D4D_EDIT_BOX_CURSOR_BLINK_TICK_COUNTER
  #define D4D_EDIT_BOX_CURSOR_BLINK_TICK_COUNTER  ( 10 )
#endif

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

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

typedef sByte D4D_EDIT_BOX_INDEX;

typedef Byte D4D_EDIT_BOX_FLAGS;

#define D4D_EDIT_BOX_FLAGS_REDRAWTEXT     (0x04)
#define D4D_EDIT_BOX_FLAGS_MOVECURSOR     (0x08)
#define D4D_EDIT_BOX_FLAGS_REDRAWCURSOR   (0x10)
#define D4D_EDIT_BOX_FLAGS_CURSORSTATE    (0x20)
#define D4D_EDIT_BOX_FLAGS_FULL           (0x40)
#define D4D_EDIT_BOX_FLAGS_CHANGETEXT     (0x80)




typedef struct
{
   D4D_STRING string;
   D4D_INDEX curPos;
   D4D_INDEX tickCounter;
   D4D_EDIT_BOX_FLAGS flags;
} D4D_EDIT_BOX_DATA;

// EditBox configuration (goes to ROM by default)
typedef struct
{
   D4D_TCHAR* pInitText;
   D4D_EDIT_BOX_DATA* pData;     // EditBox volatile data struct
   D4D_EDIT_BOX_ON_EVENT pOnEvent;
} D4D_EDIT_BOX;

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

// getting the EDIT_BOX structure from general OBJECT
#define D4D_GET_EDIT_BOX(pObj) ((D4D_EDIT_BOX*)((pObj)->pParam))
#define D4D_GET_EDIT_BOX_DATA(pEditBox) ((pEditBox)->pData)

/******************************************************************************
* D4D EDIT BOX setting  public macros
*
*/
/**************************************************************************/ 
#define _D4D_DECLARE_EDIT_BOX(type, name, x, y, cx, cy, radius, pMargin, pRelations, flags, pScheme, pInitText, fontId, maxStr, pUser, pOnEvent, pOnUsrMsg) \
    static D4D_STR_PROPERTIES name##_strPrties = {D4D_EDIT_BOX_FNT_PRTY_DEFAULT, D4D_EDIT_BOX_TXT_PRTY_DEFAULT};\
    static D4D_TCHAR name##_txtArray[maxStr + 1];\
    static D4D_EDIT_BOX_DATA name##_data = { {name##_txtArray, maxStr, fontId, &name##_strPrties, 0, 0}, 0, 0, 0};\
    static type D4D_EDIT_BOX name##_params = \
    { \
        pInitText,\
        &(name##_data), \
        pOnEvent \
    }; \
    \
    D4D_DECLARE_OBJECT(type, name, x, y, cx, cy, radius, pMargin, pRelations, pOnUsrMsg, &d4d_editBoxSysFunc, &(name##_params), flags, pUser, pScheme)


/**************************************************************************/ 
#define D4D_DECLARE_EDIT_BOX(name, x, y, cx, cy, pRelations, flags, pScheme, pInitText, fontId, maxStr, pUser, pOnEvent, pOnUsrMsg) \
 _D4D_DECLARE_EDIT_BOX(D4D_CONST, name, x, y, cx, cy, 0, (D4D_MARGIN*)&d4d_marginDefault, pRelations, flags, pScheme, pInitText,\
    fontId, maxStr, pUser, pOnEvent, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_EDIT_BOX(name, x, y, cx, cy, pRelations, pInitText, fontId, maxStr, pOnEvent) \
    D4D_DECLARE_EDIT_BOX(name, x, y, cx, cy, pRelations, (D4D_EDIT_BOX_F_DEFAULT), NULL, pInitText, fontId, maxStr, NULL, pOnEvent, NULL)

// Rounded editBox definition
/**************************************************************************/ 
#define D4D_DECLARE_REDIT_BOX(name, x, y, cx, cy, radius, pRelations, flags, pScheme, pInitText, fontId, maxStr, pUser, pOnEvent, pOnUsrMsg) \
 _D4D_DECLARE_EDIT_BOX(D4D_CONST, name, x, y, cx, cy, radius, (D4D_MARGIN*)&d4d_marginDefault, pRelations, flags, pScheme, pInitText,\
    fontId, maxStr, pUser, pOnEvent, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_REDIT_BOX(name, x, y, cx, cy, radius, pRelations, pInitText, fontId, maxStr, pOnEvent) \
    D4D_DECLARE_REDIT_BOX(name, x, y, cx, cy, radius, pRelations, (D4D_EDIT_BOX_F_DEFAULT), NULL, pInitText, fontId, maxStr, NULL, pOnEvent, NULL)


//IN RAM instantions macros
/**************************************************************************/ 
#define D4D_DECLARE_EDIT_BOX_INRAM(name, x, y, cx, cy, pRelations, flags, pScheme, pInitText, fontId, maxStr, pUser, pOnEvent, pOnUsrMsg) \
 _D4D_DECLARE_EDIT_BOX(D4D_NO_CONST, name, x, y, cx, cy, 0, (D4D_MARGIN*)&d4d_marginDefault, pRelations, flags, pScheme, pInitText,\
    fontId, maxStr, pUser, pOnEvent, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_EDIT_BOX_INRAM(name, x, y, cx, cy, pRelations, pInitText, fontId, maxStr, pOnEvent) \
    D4D_DECLARE_EDIT_BOX_INRAM(name, x, y, cx, cy, pRelations, (D4D_EDIT_BOX_F_DEFAULT), NULL, pInitText, fontId, maxStr, NULL, pOnEvent, NULL)

// Rounded editBox definition
/**************************************************************************/ 
#define D4D_DECLARE_REDIT_BOX_INRAM(name, x, y, cx, cy, radius, pRelations, flags, pScheme, pInitText, fontId, maxStr, pUser, pOnEvent, pOnUsrMsg) \
 _D4D_DECLARE_EDIT_BOX(D4D_NO_CONST, name, x, y, cx, cy, radius, (D4D_MARGIN*)&d4d_marginDefault, pRelations, flags, pScheme, pInitText,\
    fontId, maxStr, pUser, pOnEvent, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_REDIT_BOX_INRAM(name, x, y, cx, cy, radius, pRelations, pInitText, fontId, maxStr, pOnEvent) \
    D4D_DECLARE_REDIT_BOX_INRAM(name, x, y, cx, cy, radius, pRelations, (D4D_EDIT_BOX_F_DEFAULT), NULL, pInitText, fontId, maxStr, NULL, pOnEvent, NULL)

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

/******************************************************************************
* Global functions
******************************************************************************/
D4D_BOOL D4D_EditBoxPutChar(D4D_OBJECT_PTR pObj, D4D_TCHAR ch);
D4D_BOOL D4D_EditBoxPutString(D4D_OBJECT_PTR pObj, D4D_TCHAR* pText);
D4D_INDEX D4D_EditBoxSetCursor(D4D_OBJECT_PTR pObj, D4D_INDEX newPos);
D4D_INDEX D4D_EditBoxGetCursor(D4D_OBJECT_PTR pObj);
void D4D_EditBoxClearAll(D4D_OBJECT_PTR pObj);
D4D_TCHAR* D4D_EditBoxGetText(D4D_OBJECT_PTR pObj);

#endif /* __D4D_EDIT_BOX_H  */