legato_widget_checkbox.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:


  Description:
    This module implements button widget functions.
*******************************************************************************/

#ifndef LEGATO_CHECKBOX_H
#define LEGATO_CHECKBOX_H

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

#if LE_CHECKBOX_WIDGET_ENABLED == 1

#ifdef __cplusplus
extern "C" {
#endif

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

typedef struct leCheckBoxWidget leCheckBoxWidget;

// *****************************************************************************
/* Function Pointer:
    leCheckBoxWidget_CheckedEvent

  Summary:
    Checkbox checked event function callback type
*/
typedef void (*leCheckBoxWidget_CheckedEvent)(leCheckBoxWidget*);

// *****************************************************************************
/* Function Pointer:
    leCheckBoxWidget_UncheckedEvent

  Summary:
    Checkbox unchecked event function callback type
*/
typedef void (*leCheckBoxWidget_UncheckedEvent)(leCheckBoxWidget*);

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

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

#define LE_CHECKBOXWIDGET_VTABLE(THIS_TYPE) \
    LE_WIDGET_VTABLE(THIS_TYPE) \
    \
    leBool           (*getChecked)(const THIS_TYPE* _this); \
    leResult         (*setChecked)(THIS_TYPE* _this, leBool toggleable); \
    leImage*         (*getCheckedImage)(const THIS_TYPE* _this); \
    leResult         (*setCheckedImage)(THIS_TYPE* _this, leImage* img); \
    leImage*         (*getUncheckedImage)(const THIS_TYPE* _this); \
    leResult         (*setUncheckedImage)(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); \
    leString*        (*getString)(const THIS_TYPE* _this); \
    leResult         (*setString)(THIS_TYPE* _this, const leString* str); \
    leCheckBoxWidget_CheckedEvent   (*getCheckedEventCallback)(const THIS_TYPE* _this); \
    leResult         (*setCheckedEventCallback)(THIS_TYPE* _this, leCheckBoxWidget_CheckedEvent cb); \
    leCheckBoxWidget_UncheckedEvent (*getUncheckedEventCallback)(const THIS_TYPE* _this); \
    leResult         (*setUncheckedEventCallback)(THIS_TYPE* _this, leCheckBoxWidget_UncheckedEvent cb); \
    
    
typedef struct leCheckBoxWidgetVTable
{
    LE_CHECKBOXWIDGET_VTABLE(leCheckBoxWidget)
} leCheckBoxWidgetVTable; 

// *****************************************************************************
/* Structure:
    leCheckBoxWidget

  Summary:
    Implementation of a checkbox widget.

  Description:
    A check box widget contains an interactive two-state box indicating on or
    off.  The check box may also contain descriptive text.  Custom images for
    the check box may be used in place of the default box graphic.

  Remarks:
    None.
*/
typedef struct leCheckBoxWidget
{
    leWidget widget; // base class properties

    const leCheckBoxWidgetVTable* fn;

    leBool checked; // the state of the box

    const leString* string; // the text of the box

    const leImage* checkedImage; // pointer to a custom image to use for the
                                 // checked image
    const leImage* uncheckedImage; // pointer to a custom image to use for the
                                   // unchecked image

    leRelativePosition imagePosition; // postition of the image relative to the text
                                      // of the box
    uint32_t imageMargin; // the distance between the image and the text

    leCheckBoxWidget_CheckedEvent checkedEvent; // callback for checked events
    leCheckBoxWidget_CheckedEvent uncheckedEvent; // callback for unchecked events
} leCheckBoxWidget;

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

leCheckBoxWidget* leCheckBoxWidget_New(void);

void leCheckBoxWidget_Constructor(leCheckBoxWidget* _this);

#ifdef _DOXYGEN_
#define THIS_TYPE struct leWidget

// *****************************************************************************
virtual leBool getChecked(const leCheckBoxWidget* _this);


// *****************************************************************************
virtual leResult setChecked(leCheckBoxWidget* _this,
                            leBool toggleable);


// *****************************************************************************
virtual leImage* getCheckedImage(const leCheckBoxWidget* _this);

// *****************************************************************************
virtual leResult setCheckedImage(leCheckBoxWidget* _this,
                                 leImage* img);


// *****************************************************************************
virtual leImage* getUncheckedImage(const leCheckBoxWidget* _this);


// *****************************************************************************
virtual leResult setUncheckedImage(leCheckBoxWidget* _this,
                                 leImage* img);


// *****************************************************************************
virtual leRelativePosition getImagePosition(const leCheckBoxWidget* _this);


// *****************************************************************************
virtual setImagePosition(leCheckBoxWidget* _this,
                         leRelativePosition pos);


// *****************************************************************************
virtual uint32_t getImageMargin(const leCheckBoxWidget* _this);


// *****************************************************************************
virtual leResult setImageMargin(leCheckBoxWidget* _this,
                                uint32_t mg));


virtual leString* getString(const leCheckBoxWidget* _this);


// *****************************************************************************
virtual setString(leCheckBoxWidget* _this,
                  const leString* str);


virtual leCheckBoxWidget_CheckedEvent getCheckedEventCallback(const leCheckBoxWidget* _this);


virtual leResult setCheckedEventCallback(leCheckBoxWidget* _this,
                                         leCheckBoxWidget_CheckedEvent cb);


virtual leCheckBoxWidget_UncheckedEvent getUncheckedEventCallback
                                                (const leCheckBoxWidget* _this);

virtual leResult setUncheckedEventCallback(leCheckBoxWidget* _this,
                                           leCheckBoxWidget_UncheckedEvent cb);

#undef THIS_TYPE
#endif

#ifdef __cplusplus
}
#endif

#endif // LE_CHECKBOX_WIDGET_ENABLED
#endif /* LEGATO_BUTTON_H */