d4d_progress_bar.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_PROGRESS_BAR_H
#define __D4D_PROGRESS_BAR_H

extern const D4D_OBJECT_SYS_FUNCTION d4d_progress_barSysFunc;
/******************************************************************************
* D4D PROGRESS BAR setting  constants
*
*/
//********************* Progress Bar flags for button specific flags *****************
  #define D4D_PRGRS_BAR_F_BAR_AUTOCOLOR 0x0100          
  #define D4D_PRGRS_BAR_F_TEXT_AUTOCOLOR 0x0200         
  #define D4D_PRGRS_BAR_F_BAR_SCALECOLOR 0x0400         

  #define D4D_PRGRS_BAR_F_AUTOCOLOR                     (D4D_PRGRS_BAR_F_BAR_AUTOCOLOR | D4D_PRGRS_BAR_F_TEXT_AUTOCOLOR) 

#ifndef D4D_PRGRS_BAR_F_DEFAULT
  #define D4D_PRGRS_BAR_F_DEFAULT  (D4D_OBJECT_F_VISIBLE | D4D_OBJECT_F_ENABLED | D4D_PRGRS_BAR_F_BAR_AUTOCOLOR | D4D_PRGRS_BAR_F_BAR_SCALECOLOR)
#endif

#ifndef D4D_PRGRS_BAR_BAR_OFF
  #define D4D_PRGRS_BAR_BAR_OFF  3
#endif

#ifndef D4D_COLOR_PRGRS_BAR_BAR_FORE
  #define D4D_COLOR_PRGRS_BAR_BAR_FORE    D4D_COLOR_DARK_GREEN
#endif

#ifndef D4D_COLOR_PRGRS_BAR_BAR_END
  #define D4D_COLOR_PRGRS_BAR_BAR_END  D4D_COLOR_YELLOW
#endif

#ifndef D4D_COLOR_PRGRS_BAR_BAR_BCKG
  #define D4D_COLOR_PRGRS_BAR_BAR_BCKG   D4D_COLOR_BRIGHT_GREY
#endif

#ifndef D4D_COLOR_PRGRS_BAR_MAX_VAL
  #define D4D_COLOR_PRGRS_BAR_MAX_VAL  100
#endif

/******************************************************************************
* D4D PROGRESS_BAR setting  public types
*
*/
typedef Byte D4D_PROGRESS_BAR_VALUE;

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


// progress_bar runtime data (always in RAM)

typedef struct
{
    D4D_PROGRESS_BAR_VALUE value;       // current value
    D4D_BOOL drawActiveOnly;    // old Value
    D4D_COLOR colorBar;                 // Color v Bar - can be changed
} D4D_PROGRESS_BAR_DATA;

// progress_bar configuration (in ROM by default)

typedef struct
{
    D4D_PROGRESS_BAR_DATA* pData;
} D4D_PROGRESS_BAR;


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

// getting the PROGRESS_BAR structure from general OBJECT
#define D4D_GET_PROGRESS_BAR(pObj) ((D4D_PROGRESS_BAR*)((pObj)->pParam))

/******************************************************************************
* D4D PROGRESS BAR setting  public macros
*
*/
/**************************************************************************/ 
#define _D4D_DECLARE_PROGRESS_BAR(type, name, x, y, cx, cy, radius, pMargin, pRelations, flags, pScheme, pUser, pOnUsrMsg) \
    static D4D_PROGRESS_BAR_DATA name##_data = { 0, 0, D4D_COLOR_PRGRS_BAR_BAR_FORE}; \
    static type D4D_PROGRESS_BAR name##_params = \
    { \
        &(name##_data) /* RAM-based data */ \
    }; \
    \
    D4D_DECLARE_OBJECT(type, name, x, y, cx, cy, radius, pMargin, pRelations, pOnUsrMsg, &d4d_progress_barSysFunc, &(name##_params), flags, pUser, pScheme)


/**************************************************************************/ 
#define D4D_DECLARE_PROGRESS_BAR(name, x, y, cx, cy, radius, flags, pScheme, pUser, pOnUsrMsg) \
  _D4D_DECLARE_PROGRESS_BAR(D4D_CONST, name, x, y, cx, cy, radius, NULL, NULL, flags, pScheme, pUser, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_PROGRESS_BAR(name, x, y, cx, cy, radius) \
    D4D_DECLARE_PROGRESS_BAR(name, x, y, cx, cy, radius, (D4D_PRGRS_BAR_F_DEFAULT), NULL, NULL, NULL)


// IN RAM instantions macros
/**************************************************************************/ 
#define D4D_DECLARE_PROGRESS_BAR_INRAM(name, x, y, cx, cy, radius, flags, pScheme, pUser, pOnUsrMsg) \
  _D4D_DECLARE_PROGRESS_BAR( D4D_NO_CONST, name, x, y, cx, cy, radius, NULL, NULL, flags, pScheme, pUser, pOnUsrMsg)

/**************************************************************************/ 
#define D4D_DECLARE_STD_PROGRESS_BAR_INRAM(name, x, y, cx, cy, radius) \
    D4D_DECLARE_PROGRESS_BAR_INRAM(name, x, y, cx, cy, radius, (D4D_PRGRS_BAR_F_DEFAULT), NULL, NULL, NULL)

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

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

void D4D_PrgrsBarSetValue(D4D_OBJECT_PTR pThis, D4D_PROGRESS_BAR_VALUE value);
D4D_PROGRESS_BAR_VALUE D4D_PrgrsBarGetValue(D4D_OBJECT_PTR pThis);
void D4D_PrgrsBarChangeValue(D4D_OBJECT_PTR pThis, D4D_PROGRESS_BAR_VALUE incr);

void D4D_PrgrsBarSetBarColor(D4D_OBJECT_PTR pThis, D4D_COLOR color);
D4D_COLOR D4D_PrgrsBarGetBarColor(D4D_OBJECT_PTR pThis);



#endif /* __D4D_PROGRESS_BAR_H */