legato_widget_arc.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_arc.h

  Summary:


  Description:
    This module implements arc drawing widget functions.
*******************************************************************************/
#ifndef LEGATO_WIDGET_ARC_H
#define LEGATO_WIDGET_ARC_H

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

#if LE_ARC_WIDGET_ENABLED == 1

#ifdef __cplusplus
extern "C" {
#endif

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

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

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

#define LE_ARCWIDGET_VTABLE(THIS_TYPE) \
    LE_WIDGET_VTABLE(THIS_TYPE) \
    \
    uint32_t    (*getRadius)(const THIS_TYPE* _this); \
    leResult    (*setRadius)(THIS_TYPE* _this, uint32_t rad); \
    int32_t     (*getStartAngle)(const THIS_TYPE* _this); \
    leResult    (*setStartAngle)(THIS_TYPE* _this, int32_t ang); \
    uint32_t    (*getThickness)(const THIS_TYPE* _this); \
    leResult    (*setThickness)(THIS_TYPE* _this, uint32_t val); \
    int32_t     (*getCenterAngle)(const THIS_TYPE* _this); \
    leResult    (*setCenterAngle)(THIS_TYPE* _this, int32_t ang); \
    leBool      (*getRoundEdge)(const THIS_TYPE* _this); \
    leResult    (*setRoundEdge)(THIS_TYPE* _this, leBool rnd); \

typedef struct leArcWidgetVTable
{
    LE_ARCWIDGET_VTABLE(leArcWidget)
} leArcWidgetVTable;
typedef struct leArcWidget
{
    leWidget widget;            
    const leArcWidgetVTable* fn; 
    uint32_t radius;            
    int32_t startAngle;         
    int32_t centerAngle;        
    uint32_t endAngle;          
    uint32_t thickness;         
    leBool roundEdge;           
} leArcWidget;

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

leArcWidget* leArcWidget_New(void);

void leArcWidget_Constructor(leArcWidget* wgt);

#ifdef _DOXYGEN_
#define THIS_TYPE struct leWidget

virtual uint32_t getRadius(const leArcWidget* _this);

virtual leResult setRadius(leArcWidget* _this,
                          uint32_t rad);

virtual int32_t getStartAngle(const leArcWidget* _this);

virtual leResult setStartAngle(leArcWidget* _this,
                              int32_t angle);

virtual uint32_t getThickness(const leArcWidget* _this);

virtual leResult setThickness(leArcWidget* _this,
                             uint32_t thickness);

virtual int32_t getCenterAngle(const leArcWidget* _this);

virtual leResult setCenterAngle(THIS_TYPE* _this,
                                int32_t angle);

virtual leBool getRoundEdge(const THIS_TYPE* _this);

virtual leResult setRoundEdge(THIS_TYPE* _this,
                             leBool round);


#undef THIS_TYPE
#endif

#ifdef __cplusplus
}
#endif

#endif // LE_ARC_WIDGET_ENABLED
#endif /* LEGATO_WIDGET_ARC_H */