d4d_slider.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_SLIDER_H
#define __D4D_SLIDER_H

extern const D4D_OBJECT_SYS_FUNCTION d4d_sliderSysFunc;

/******************************************************************************
* D4D SLIDER setting  constants
*
*/
//********************* Slider flags for its specific flags *****************
#define D4D_SLDR_F_BAR_AUTOCOLOR  (0x01 << D4D_OBJECT_F_OBJECT_SHIFT)   
#define D4D_SLDR_F_TEXT_AUTOCOLOR (0x02 << D4D_OBJECT_F_OBJECT_SHIFT)   
#define D4D_SLDR_F_BAR_SCALECOLOR (0x04 << D4D_OBJECT_F_OBJECT_SHIFT)   
#define D4D_SLDR_F_AUTOTOUCH_OFF  (0x08 << D4D_OBJECT_F_OBJECT_SHIFT)   

#define D4D_SLDR_F_AUTOCOLOR      (D4D_SLDR_F_BAR_AUTOCOLOR | D4D_SLDR_F_TEXT_AUTOCOLOR)   

#ifndef D4D_SLDR_F_DEFAULT
  #define D4D_SLDR_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)
#endif

#ifndef D4D_SLDR_TXT_PRTY_DEFAULT
  #define D4D_SLDR_TXT_PRTY_DEFAULT  (D4D_ALIGN_H_CENTER_MASK | D4D_ALIGN_V_CENTER_MASK)
#endif

#ifndef D4D_SLDR_FNT_PRTY_DEFAULT
  #define D4D_SLDR_FNT_PRTY_DEFAULT  ( D4D_FNT_PRTY_TRANSPARENT_YES_MASK )
#endif

#ifndef D4D_SLDR_BAR_OFF_LENGTH
  #define D4D_SLDR_BAR_OFF_LENGTH  2
#endif

#ifndef D4D_SLDR_BAR_OFF_WIDTH
  #define D4D_SLDR_BAR_OFF_WIDTH  4
#endif

#ifndef D4D_SLDR_AUTOTOUCHTICKS
  #define D4D_SLDR_AUTOTOUCHTICKS  10
#endif


#ifndef D4D_COLOR_SLDR_BAR_FORE
  #define D4D_COLOR_SLDR_BAR_FORE        D4D_COLOR_DARK_BLUE
#endif

#ifndef D4D_COLOR_SLDR_BAR_BCKG
  #define D4D_COLOR_SLDR_BAR_BCKG   D4D_COLOR_BRIGHT_GREY
#endif

#ifndef D4D_COLOR_SLDR_BAR_START
  #define D4D_COLOR_SLDR_BAR_START  D4D_COLOR_GREEN
#endif

#ifndef D4D_COLOR_SLDR_BAR_END
  #define D4D_COLOR_SLDR_BAR_END  D4D_COLOR_RED
#endif

/******************************************************************************
* D4D SLIDER setting  public types
*
*/
typedef sByte D4D_SLIDER_VALUE;

typedef struct
{
  D4D_SLIDER_VALUE valueMin;   
  D4D_SLIDER_VALUE valueMax;   
  D4D_SLIDER_VALUE step;       
  D4D_SLIDER_VALUE valueOrg;   
} D4D_SLIDER_LIMITS;

/**************************************************************************/ 
typedef void (*D4D_SLDR_ON_CHANGE)(D4D_OBJECT* pThis);

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

// slider runtime data (always in RAM)
typedef struct
{
  D4D_SLIDER_VALUE value;      // current value
  D4D_SLIDER_LIMITS limits;    // slider runtime configuration
  D4D_COLOR colorBar;          // Color v Bar - can be changed
} D4D_SLIDER_DATA;

// slider configuration (in ROM by default)

typedef struct
{
    D4D_STRING textBuff;       // slider text
    D4D_POINT txtOff;           // text coordinates as offset from scrPos
    D4D_POINT barOff;           // hub coordinates as offset from scrPos
    D4D_SIZE  barSize;          // value bar size (if cx>cy, then bar is horizontal, otherwise vertical)
    const D4D_BMP*  pBmpBkgd;         // slider background bitmap
    D4D_SLDR_ON_CHANGE OnValueChanged;  // pointer to on change call back function
    D4D_SLIDER_DATA* pData;
} D4D_SLIDER;


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

// getting the SLIDER structure from general OBJECT
#define D4D_GET_SLIDER(pObj) ((D4D_SLIDER*)((pObj)->pParam))

/******************************************************************************
* D4D SLIDER setting  public macros
*
*/
/**************************************************************************/ 
#define _D4D_DECLARE_SLIDER(type, name, text, x, y, cx, cy, radius, pMargin, pRelations, tx, ty, bx, by, bcx, bcy, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg) \
    static D4D_SLIDER_DATA name##_data = { 0, 0, 100, 1, 0, D4D_COLOR_SLDR_BAR_FORE}; \
    static D4D_STR_PROPERTIES name##_strPrties = { D4D_SLDR_FNT_PRTY_DEFAULT, D4D_SLDR_TXT_PRTY_DEFAULT}; \
    static type D4D_SLIDER name##_params = \
    { \
        { text, D4D_TEXT_LEN(text), fontId, &name##_strPrties, D4D_OBJECT_MAX_TEXT_LEN(text), 0}, /* textBuff */ \
        { tx, ty },  /* txtOff     */ \
        { bx, by },  /* barOff     */ \
        { bcx, bcy }, /* barSize    */ \
        pBmp,        /* pBmpBkgd   */ \
        onvalch,     /* OnValueCanged */ \
        &(name##_data) /* RAM-based data */ \
    }; \
    \
    D4D_DECLARE_OBJECT(type, name, x, y, cx, cy, radius, pMargin, pRelations, pOnUsrMsg, &d4d_sliderSysFunc, &(name##_params), flags, pUser, pScheme)


/**************************************************************************/ 
#define D4D_DECLARE_SLIDER(name, text, x, y, cx, cy, tx, ty, bx, by, bcx, bcy, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg) \
  _D4D_DECLARE_SLIDER(D4D_CONST, name, text, x, y, cx, cy, 0, NULL, NULL, tx, ty, bx, by, bcx, bcy, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_SLIDER(name, text, x, y, cx, cy, tx, ty, bx, by, bcx, bcy, pBmp, fontId, onvalch) \
    D4D_DECLARE_SLIDER(name, text, x, y, cx, cy, tx, ty, bx, by, bcx, bcy, (D4D_SLDR_F_DEFAULT), pBmp, NULL, fontId, NULL, onvalch, NULL)

/**************************************************************************/ 
#define D4D_DECLARE_SLIDER_AUTOSIZE(name, text, x, y, cx, cy, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg) \
    D4D_DECLARE_SLIDER(name, text, x, y, cx, cy, 0, 0, 0, 0, 0, 0, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_SLIDER_AUTOSIZE(name, text, x, y, cx, cy, pBmp, fontId, onvalch) \
    D4D_DECLARE_STD_SLIDER(name, text, x, y, cx, cy, 0, 0, 0, 0, 0, 0, pBmp, fontId, onvalch)


/**************************************************************************/ 
#define D4D_DECLARE_RSLIDER(name, text, x, y, cx, cy, radius, tx, ty, bx, by, bcx, bcy, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg) \
  _D4D_DECLARE_SLIDER(D4D_CONST, name, text, x, y, cx, cy, radius, NULL, NULL, tx, ty, bx, by, bcx, bcy, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_RSLIDER(name, text, x, y, cx, cy, radius, tx, ty, bx, by, bcx, bcy, pBmp, fontId, onvalch) \
    D4D_DECLARE_RSLIDER(name, text, x, y, cx, cy, radius, tx, ty, bx, by, bcx, bcy, (D4D_SLDR_F_DEFAULT), pBmp, NULL, fontId, NULL, onvalch, NULL)

/**************************************************************************/ 
#define D4D_DECLARE_RSLIDER_AUTOSIZE(name, text, x, y, cx, cy, radius, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg) \
    D4D_DECLARE_RSLIDER(name, text, x, y, cx, cy, radius, 0, 0, 0, 0, 0, 0, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_RSLIDER_AUTOSIZE(name, text, x, y, cx, cy, radius, pBmp, fontId, onvalch) \
    D4D_DECLARE_STD_RSLIDER(name, text, x, y, cx, cy, radius, 0, 0, 0, 0, 0, 0, pBmp, fontId, onvalch)


// IN RAM instantions macros
/**************************************************************************/ 
#define D4D_DECLARE_SLIDER_INRAM(name, text, x, y, cx, cy, tx, ty, bx, by, bcx, bcy, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg) \
  _D4D_DECLARE_SLIDER( D4D_NO_CONST, name, text, x, y, cx, cy, 0, NULL, NULL, tx, ty, bx, by, bcx, bcy, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_SLIDER_INRAM(name, text, x, y, cx, cy, tx, ty, bx, by, bcx, bcy, pBmp, fontId, onvalch) \
    D4D_DECLARE_SLIDER_INRAM(name, text, x, y, cx, cy, tx, ty, bx, by, bcx, bcy, (D4D_SLDR_F_DEFAULT), pBmp, NULL, fontId, NULL, onvalch, NULL)

/**************************************************************************/ 
#define D4D_DECLARE_SLIDER_AUTOSIZE_INRAM(name, text, x, y, cx, cy, flags, pBmp, pScheme, font, pUser, onvalch, pOnUsrMsg) \
    D4D_DECLARE_SLIDER_INRAM(name, text, x, y, cx, cy, 0, 0, 0, 0, 0, 0, flags, pBmp, pScheme, font, pUser, onvalch, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_SLIDER_AUTOSIZE_INRAM(name, text, x, y, cx, cy, pBmp, font, onvalch) \
    D4D_DECLARE_STD_SLIDER_INRAM(name, text, x, y, cx, cy, 0, 0, 0, 0, 0, 0, pBmp, font, onvalch)

// Rounded slider definition
/**************************************************************************/ 
#define D4D_DECLARE_RSLIDER_INRAM(name, text, x, y, cx, cy, radius, tx, ty, bx, by, bcx, bcy, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg) \
  _D4D_DECLARE_SLIDER(D4D_NO_CONST, name, text, x, y, cx, cy, radius, NULL, NULL, tx, ty, bx, by, bcx, bcy, flags, pBmp, pScheme, fontId, pUser, onvalch, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_RSLIDER_INRAM(name, text, x, y, cx, cy, radius, tx, ty, bx, by, bcx, bcy, pBmp, fontId, onvalch) \
    D4D_DECLARE_RSLIDER_INRAM(name, text, x, y, cx, cy, radius, tx, ty, bx, by, bcx, bcy, (D4D_SLDR_F_DEFAULT), pBmp, NULL, fontId, NULL, onvalch, NULL)

/**************************************************************************/ 
#define D4D_DECLARE_RSLIDER_AUTOSIZE_INRAM(name, text, x, y, cx, cy, radius, flags, pBmp, pScheme, font, pUser, onvalch, pOnUsrMsg) \
    D4D_DECLARE_RSLIDER_INRAM(name, text, x, y, cx, cy, radius, 0, 0, 0, 0, 0, 0, flags, pBmp, pScheme, font, pUser, onvalch, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_RSLIDER_AUTOSIZE_INRAM(name, text, x, y, cx, cy, radius, pBmp, font, onvalch) \
    D4D_DECLARE_STD_RSLIDER_INRAM(name, text, x, y, cx, cy, radius, 0, 0, 0, 0, 0, 0, pBmp, font, onvalch)

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

/*********************************************************
*
* global functions
*
*********************************************************/

void D4D_SldrSetValue(D4D_OBJECT_PTR pThis, D4D_SLIDER_VALUE value);
D4D_SLIDER_VALUE D4D_SldrGetValue(D4D_OBJECT_PTR pThis);
void D4D_SldrChangeValue(D4D_OBJECT_PTR pThis, D4D_SLIDER_VALUE incr);

void D4D_SldrSetLimits(D4D_OBJECT_PTR pThis, const D4D_SLIDER_LIMITS* pLimits);
void D4D_SldrGetLimits(D4D_OBJECT_PTR pThis, D4D_SLIDER_LIMITS* pLimits);

void D4D_SldrSetBarColor(D4D_OBJECT_PTR pThis, D4D_COLOR color);
D4D_COLOR D4D_SldrGetBarColor(D4D_OBJECT_PTR pThis);


// Obsolete functions, replaced by any general
#define D4D_SldrSetText D4D_SetText


#endif /* __D4D_SLIDER_H */