d4d_text_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_TEXTBOX_H
#define __D4D_TEXTBOX_H

extern const D4D_OBJECT_SYS_FUNCTION d4d_textboxSysFunc;
void D4D_TextBoxScrollBarsFeedBack(D4D_OBJECT* pThis, D4D_INDEX old_position, D4D_INDEX new_position);

/******************************************************************************
* D4D TEXT BOX setting  constants
*
*/
#ifndef D4D_TXTBX_F_DEFAULT
  #define D4D_TXTBX_F_DEFAULT  (D4D_OBJECT_F_VISIBLE | D4D_OBJECT_F_ENABLED | D4D_OBJECT_F_FOCUSRECT | D4D_OBJECT_F_TOUCHENABLE | D4D_OBJECT_F_TABSTOP | D4D_OBJECT_F_MOUSE_NORMAL)
#endif

#ifndef D4D_TXTBX_F_SCRLBRS_DEFAULT
  #define D4D_TXTBX_F_SCRLBRS_DEFAULT  (D4D_OBJECT_F_ENABLED | D4D_OBJECT_F_TOUCHENABLE | D4D_OBJECT_F_FASTTOUCH | D4D_OBJECT_F_FOCUSRECT | D4D_OBJECT_F_MOUSE_NORMAL)
#endif

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

#ifndef D4D_TXTBX_FNT_PRTY_DEFAULT
  #define D4D_TXTBX_FNT_PRTY_DEFAULT  ( 0 )
#endif

#ifndef D4D_TXTBX_SCRLBR_WIDTH
  #define D4D_TXTBX_SCRLBR_WIDTH  ( 20 )
#endif

#ifndef D4D_TXTBX_SCRLBR_STEP
  #define D4D_TXTBX_SCRLBR_STEP  ( 2 )
#endif

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







typedef struct D4D_TXTBX_DATA_S
{
          D4D_INDEX firstShowedCharIx;
          D4D_TCHAR* pTxtArr;                      // Pointer on text array that will use TextBox to store all lines
          D4D_BOOL redrawText;
}D4D_TXTBX_DATA;

// label configuration (goes to ROM by default)

typedef struct
{
    D4D_COOR* pTabTable;
    D4D_FONT textFontId;                 // Used font for whole text
    D4D_TXTBX_DATA* pData;               // Run time data needed for TextBox
} D4D_TEXTBOX;


/******************************************************************************
* Macros
******************************************************************************/
#define D4D_TEXTBOX_CHILD_SCROLL_BAR_VER_IX 1


// getting the TEXTBOX structure from general OBJECT
#define D4D_GET_TEXTBOX(pObj) ((D4D_TEXTBOX*)((pObj)->pParam))
#define D4D_GET_TEXTBOX_DATA(pObj) (D4D_GET_TEXTBOX(pObj)->pData)

#define D4D_GET_TEXTBOX_SCROLL_BAR_HOR(pObj) ((D4D_OBJECT*)((pObj)->pRelations[D4D_TEXTBOX_CHILD_SCROLL_BAR_VER_IX]))

/******************************************************************************
* D4D TEXT BOX setting  public macros
*
*/
/**************************************************************************/ 
#define _D4D_DECLARE_TEXTBOX(type, name, x, y, cx, cy, radius, pMargin, pParent, pTextArray, pTabTable, flags, pScheme, fontId, pUser, pOnUsrMsg) \
    static D4D_TXTBX_DATA name##_data = { 0, (D4D_TCHAR*)pTextArray, D4D_TRUE};\
    extern type D4D_OBJECT name##_scrollBarVer;\
    static const D4D_OBJECT * const name##_relations[] = {pParent, &name##_scrollBarVer, NULL};\
    static type D4D_TEXTBOX name##_params = \
    { \
        (D4D_COOR*)pTabTable, /* pTabTable */ \
        fontId,                         /* textFontId */ \
        &name##_data, /* pData */ \
    }; \
    \
    D4D_DECLARE_OBJECT(type, name, x, y, cx, cy, radius, pMargin, name##_relations, pOnUsrMsg, &d4d_textboxSysFunc, &(name##_params), flags, pUser, pScheme)\
    \
    static const D4D_OBJECT* const name##_scrollBarRelations[] = {&name, NULL};\
    \
    _D4D_DECLARE_SCROLL_BAR(type, name##_scrollBarVer, (D4D_COOR)(cx - D4D_BORDER_WIDTH(flags) - D4D_TXTBX_SCRLBR_WIDTH), D4D_BORDER_WIDTH(flags), D4D_TXTBX_SCRLBR_WIDTH, (D4D_COOR)(cy - 2*D4D_BORDER_WIDTH(flags)),\
      ((radius > D4D_TXTBX_SCRLBR_WIDTH / 2)? (D4D_COOR)(D4D_TXTBX_SCRLBR_WIDTH / 2) : radius), NULL, name##_scrollBarRelations, D4D_TXTBX_F_SCRLBRS_DEFAULT, pScheme, NULL, D4D_TextBoxScrollBarsFeedBack, NULL)


/**************************************************************************/ 
#define D4D_DECLARE_TEXTBOX(name, x, y, cx, cy, pTextArray, pTabTable, flags, pScheme, fontId, pUser, pOnUsrMsg) \
  _D4D_DECLARE_TEXTBOX(D4D_CONST, name, x, y, cx, cy, 0, NULL, NULL, pTextArray, pTabTable, flags, pScheme, fontId, pUser, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_TEXTBOX(name, x, y, cx, cy, pTextArray, pTabTable, fontId) \
  D4D_DECLARE_TEXTBOX(name, x, y, cx, cy, pTextArray, pTabTable, D4D_TXTBX_F_DEFAULT, NULL, fontId, NULL, NULL)

/**************************************************************************/ 
#define D4D_DECLARE_RTEXTBOX(name, x, y, cx, cy, radius, pTextArray, pTabTable, flags, pScheme, fontId, pUser, pOnUsrMsg) \
  _D4D_DECLARE_TEXTBOX(D4D_CONST, name, x, y, cx, cy, radius, NULL, NULL, pTextArray, pTabTable, flags, pScheme, fontId, pUser, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_RTEXTBOX(name, x, y, cx, cy, radius, pTextArray, pTabTable,  fontId) \
  D4D_DECLARE_RTEXTBOX(name, x, y, cx, cy, radius, pTextArray, pTabTable, D4D_TXTBX_F_DEFAULT, NULL, fontId, NULL, NULL)

//IN RAM instantions macros
/**************************************************************************/ 
#define D4D_DECLARE_TEXTBOX_INRAM(name, x, y, cx, cy, pTextArray, pTabTable, flags, pScheme, fontId, pUser, pOnUsrMsg) \
  _D4D_DECLARE_TEXTBOX(D4D_NO_CONST, name, x, y, cx, cy, 0, NULL, NULL, pTextArray, pTabTable, flags, pScheme, fontId, pUser, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_TEXTBOX_INRAM(name, x, y, cx, cy, pTextArray, pTabTable,  fontId) \
  D4D_DECLARE_TEXTBOX_INRAM(name, x, y, cx, cy, pTextArray, pTabTable, D4D_TXTBX_F_DEFAULT, NULL, fontId, NULL, NULL)

// Rounded text box definition
/**************************************************************************/ 
#define D4D_DECLARE_RTEXTBOX_INRAM(name, x, y, cx, cy, radius, pTextArray, pTabTable, flags, pScheme, fontId, pUser, pOnUsrMsg) \
  _D4D_DECLARE_TEXTBOX(D4D_NO_CONST, name, x, y, cx, cy, radius, NULL, NULL, pTextArray, pTabTable, flags, pScheme, fontId, pUser, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_RTEXTBOX_INRAM(name, x, y, cx, cy, radius, pTextArray, pTabTable,  fontId) \
  D4D_DECLARE_RTEXTBOX_INRAM(name, x, y, cx, cy, radius, pTextArray, pTabTable, D4D_TXTBX_F_DEFAULT, NULL, fontId, NULL, NULL)

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


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

/*********************************************************
*
* Object API
*
*********************************************************/
void D4D_TextBoxRefreshAll(D4D_OBJECT* pObject);
void D4D_TextBoxChangeText(D4D_OBJECT* pObject, D4D_TCHAR* pText);

#endif /* __D4D_TEXTBOX_H */