legato_widget_progressbar.h

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2020 Microchip Technology Inc. and its subsidiaries.
*
* Subject to your compliance with these terms, you may use Microchip software
* and any derivatives exclusively with Microchip products. It is your
* responsibility to comply with third party license terms applicable to your
* use of third party software (including open source software) that may
* accompany Microchip software.
*
* THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, WHETHER
* EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED
* WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A
* PARTICULAR PURPOSE.
*
* IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE,
* INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND
* WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS
* BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO THE
* FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN
* ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY,
* THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.
*******************************************************************************/

/*******************************************************************************
 Module for Microchip Graphics Library - Legato User Interface Library

  Company:
    Microchip Technology Inc.

  File Name:
    legato_widget_progressbar.h

  Summary:


  Description:
    This module implements progress bar widget functions.
*******************************************************************************/
#ifndef LEGATO_PROGRESSBAR_H
#define LEGATO_PROGRESSBAR_H

#include "gfx/legato/common/legato_common.h"

#if LE_PROGRESSBAR_WIDGET_ENABLED == 1

#ifdef __cplusplus
extern "C" {
#endif

#include "gfx/legato/widget/legato_widget.h"

// *****************************************************************************
// *****************************************************************************
// Section: Data Types and Constants
// *****************************************************************************
// *****************************************************************************

// *****************************************************************************
/* Enumeration:
    leProgressBarDirection

  Summary:
    Defines the valid values for the progress bar widget fill directions.

  Description:


  Remarks:
    None.
*/
typedef enum leProgressBarDirection
{
    LE_PROGRESSBAR_DIRECTION_RIGHT,
    LE_PROGRESSBAR_DIRECTION_UP,
    LE_PROGRESSBAR_DIRECTION_LEFT,
    LE_PROGRESSBAR_DIRECTION_DOWN
} leProgressBarDirection;

/* internal use only */typedef struct leProgressBarWidget leProgressBar;
// DOM-IGNORE-END

// *****************************************************************************
/* Function Pointer:
    leProgressBar_ValueChangedEventCallback

  Summary:
    Value changed event function callback type
*/
typedef void (* leProgressBar_ValueChangedEventCallback)(leProgressBar*, uint32_t);

/* internal use only */typedef struct leProgressBarWidget leProgressBarWidget;

#define LE_PROGRESSBARWIDGET_VTABLE(THIS_TYPE) \
    LE_WIDGET_VTABLE(THIS_TYPE) \
    \
    leProgressBarDirection (*getDirection)(const THIS_TYPE* _this); \
    leResult               (*setDirection)(THIS_TYPE* _this, leProgressBarDirection dir); \
    uint32_t               (*getValue)(const THIS_TYPE* _this); \
    leResult               (*setValue)(THIS_TYPE* _this, uint32_t value); \
    leProgressBar_ValueChangedEventCallback (*getValueChangedEventCallback)(const THIS_TYPE* _this); \
    leResult               (*setValueChangedCallback)(THIS_TYPE* _this, leProgressBar_ValueChangedEventCallback cb); \

typedef struct leProgressBarWidgetVTable
{
    LE_PROGRESSBARWIDGET_VTABLE(leProgressBarWidget)
} leProgressBarWidgetVTable;

// *****************************************************************************
typedef struct leProgressBarWidget
{
    leWidget widget; // base widget class

    const leProgressBarWidgetVTable* fn;

    leProgressBarDirection direction; // the fill direction of the bar

    uint32_t value; // fill percentage

    leProgressBar_ValueChangedEventCallback cb; // value changed callback
} leProgressBarWidget;


// *****************************************************************************
// *****************************************************************************
// Section: Routines
// *****************************************************************************
// *****************************************************************************

leProgressBarWidget* leProgressBarWidget_New(void);

void leProgressBarWidget_Constructor(leProgressBarWidget* wgt);

#ifdef _DOXYGEN_
#define THIS_TYPE struct leWidget

// *****************************************************************************
virtual leProgressBarDirection getDirection(const leProgressBarWidget* _this);


// *****************************************************************************
virtual leResult setDirection(leProgressBarWidget* _this,
                              leProgressBarDirection dir);




// *****************************************************************************
virtual int32_t getValue(const leProgressBarWidget* _this);


// *****************************************************************************
virtual leResult setValue(leProgressBarWidget* _this,
                          uint32_t value);


virtual leProgressBar_ValueChangedEventCallback getValueChangedEventCallback
                                        (const leProgressBarWidget* _this);

virtual leResult setValueChangedCallback(leProgressBarWidget* _this,
                                         leProgressBar_ValueChangedEventCallback cb);

#undef THIS_TYPE
#endif

#ifdef __cplusplus
}
#endif

#endif // LE_PROGRESSBAR_WIDGET_ENABLED
#endif /* LEGATO_PROGRESSBAR_H */