legato_widget_button.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_button.h

  Summary:
    Defines a button widget
*******************************************************************************/

#ifndef LEGATO_BUTTON_H
#define LEGATO_BUTTON_H

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

#if LE_BUTTON_WIDGET_ENABLED == 1

#ifdef __cplusplus
extern "C" {
#endif

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

#include "gfx/legato/image/legato_image.h"
#include "gfx/legato/string/legato_string.h"

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

// *****************************************************************************
/* Enumeration:
    leButtonState

  Summary:
    Controls the button pressed state
*/
typedef enum leButtonState
{
    LE_BUTTON_STATE_UP,
    LE_BUTTON_STATE_DOWN,
    LE_BUTTON_STATE_TOGGLED
} leButtonState;

typedef struct leButtonWidget leButtonWidget;

// *****************************************************************************
/* Function Pointer:
    leButtonWidget_PressedEvent

  Summary:
    Button pressed event function callback type
*/
typedef void (*leButtonWidget_PressedEvent)(leButtonWidget*);

// *****************************************************************************
/* Function Pointer:
    leButtonWidget_ReleasedEvent

  Summary:
    Button released event function callback type
*/
typedef void (*leButtonWidget_ReleasedEvent)(leButtonWidget*);


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

#define LE_BUTTONWIDGET_VTABLE(THIS_TYPE) \
    LE_WIDGET_VTABLE(THIS_TYPE) \
    \
    leBool                       (*getToggleable)(const THIS_TYPE* _this); \
    leResult                     (*setToggleable)(THIS_TYPE* _this, leBool toggleable); \
    leBool                       (*getPressed)(const THIS_TYPE* _this); \
    leResult                     (*setPressed)(THIS_TYPE* _this, leBool pressed); \
    leString*                    (*getString)(const THIS_TYPE* _this); \
    leResult                     (*setString)(THIS_TYPE* _this, const leString* str); \
    leImage*                     (*getPressedImage)(const THIS_TYPE* _this); \
    leResult                     (*setPressedImage)(THIS_TYPE* _this, leImage* img); \
    leImage*                     (*getReleasedImage)(const THIS_TYPE* _this); \
    leResult                     (*setReleasedImage)(THIS_TYPE* _this, leImage* img); \
    leRelativePosition           (*getImagePosition)(const THIS_TYPE* _this); \
    leResult                     (*setImagePosition)(THIS_TYPE* _this, leRelativePosition pos); \
    uint32_t                     (*getImageMargin)(const THIS_TYPE* _this); \
    leResult                     (*setImageMargin)(THIS_TYPE* _this, uint32_t mg); \
    int32_t                      (*getPressedOffset)(const THIS_TYPE* _this); \
    leResult                     (*setPressedOffset)(THIS_TYPE* _this, int32_t offs); \
    leButtonWidget_PressedEvent  (*getPressedEventCallback)(const THIS_TYPE* _this); \
    leResult                     (*setPressedEventCallback)(THIS_TYPE* _this, leButtonWidget_PressedEvent cb); \
    leButtonWidget_ReleasedEvent (*getReleasedEventCallback)(const THIS_TYPE* _this); \
    leResult                     (*setReleasedEventCallback)(THIS_TYPE* _this, leButtonWidget_ReleasedEvent cb); \
    
    
typedef struct leButtonWidgetVTable
{
    LE_BUTTONWIDGET_VTABLE(leButtonWidget)
} leButtonWidgetVTable; 

// *****************************************************************************
/* Structure:
    leButtonWidget

  Summary:
    Implementation of a button widget.  A button is an interactive element
    that simulates a typical button with a pressed an released state.

  Description:


  Remarks:
    None.
*/
typedef struct leButtonWidget
{
    leWidget widget;  // base widget header

    const leButtonWidgetVTable* fn;

    leButtonState state; // button state
    uint8_t toggleable; // indicates if the button is toggleable

    const leString* string; // the string that holds the button text

    const leImage* pressedImage; // button pressed icon image
    const leImage* releasedImage; // button released icon image

    leRelativePosition imagePosition; // icon position in relation to text
    uint32_t imageMargin; // distance between text and icon
    int32_t pressedOffset; // pressed text offset distance

    leButtonWidget_PressedEvent pressedEvent; // pressed event callback
    leButtonWidget_ReleasedEvent releasedEvent; // released event callback
} leButtonWidget;

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

leButtonWidget* leButtonWidget_New(void);

void leButtonWidget_Constructor(leButtonWidget* wgt);

#ifdef _DOXYGEN_
#define THIS_TYPE struct leWidget

virtual leBool getToggleable(const leButtonWidget* _this);

virtual leResult setToggleable(leButtonWidget* _this,
                               leBool toggleable);

virtual leBool getPressed(const leButtonWidget* _this);

virtual leResult setPressed(leButtonWidget* _this,
                            leBool pressed);


virtual leString* getString(const leButtonWidget* _this);


virtual leResult setString(leButtonWidget* _this,
                           const leString* str);

virtual leImage* getPressedImage(const leButtonWidget* _this);


virtual leResult setPressedImage(leButtonWidget* _this,
                                 leImage* img);


virtual leImage* getReleasedImage(const leButtonWidget* _this);

virtual leResult setReleasedImage(leButtonWidget* _this,
                                  leImage* img);


virtual leRelativePosition getImagePosition(const leButtonWidget* _this);

virtual leResult setImagePosition(leButtonWidget* _this,
                                  leRelativePosition pos);

virtual uint32_t getImageMargin(const leButtonWidget* _this);

virtual leResult setImageMargin(leButtonWidget* _this,
                                  uint32_t mg);


virtual int32_t getPressedOffset(const leButtonWidget* _this);


virtual leResult setPressedOffset(leButtonWidget* _this,
                                  int32_t offs);

virtual leButtonWidget_PressedEvent getPressedEventCallback(const leButtonWidget* _this);

virtual leResult setPressedEventCallback(leButtonWidget* _this,
                                         leButtonWidget_PressedEvent cb);

virtual leButtonWidget_ReleasedEvent getReleasedEventCallback(const leButtonWidget* _this);


virtual leResult setReleasedEventCallback(leButtonWidget* _this,
                                          leButtonWidget_ReleasedEvent cb);

#undef THIS_TYPE
#endif

#ifdef __cplusplus
}
#endif


#endif /* LE_BUTTON_WIDGET_ENABLED */
#endif /* LEGATO_BUTTON_H */