legato_widget_circle.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_circle.h

  Summary:


  Description:
    This module implements circle drawing widget functions.
*******************************************************************************/

#ifndef LEGATO_CIRCLE_H
#define LEGATO_CIRCLE_H

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

#if LE_CIRCLE_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 leCircleWidget leCircleWidget;

#define LE_CIRCLEWIDGET_VTABLE(THIS_TYPE) \
    LE_WIDGET_VTABLE(THIS_TYPE) \
    \
    leResult         (*getOrigin)(const THIS_TYPE* _this, lePoint* pnt); \
    leResult         (*setOrigin)(THIS_TYPE* _this, const lePoint org); \
    int32_t          (*getOriginX)(const THIS_TYPE* _this); \
    leResult         (*setOriginX)(THIS_TYPE* _this, const int32_t x); \
    int32_t          (*getOriginY)(const THIS_TYPE* _this); \
    leResult         (*setOriginY)(THIS_TYPE* _this, const int32_t y); \
    uint32_t         (*getRadius)(const THIS_TYPE* _this); \
    leResult         (*setRadius)(THIS_TYPE* _this, uint32_t rad); \
    uint32_t         (*getThickness)(const THIS_TYPE* _this); \
    leResult         (*setThickness)(THIS_TYPE* _this, uint32_t thk); \
    leBool           (*getFilled)(const THIS_TYPE* _this); \
    leResult         (*setFilled)(THIS_TYPE* _this, leBool fill); \

typedef struct leCircleWidgetVTable
{
    LE_CIRCLEWIDGET_VTABLE(leCircleWidget)
} leCircleWidgetVTable;

// *****************************************************************************
/* Structure:
    leCircleWidget

  Summary:
    Implementation of a circle widget.

  Description:
    A circle widget draws a circle of the specified origin and radius inside
    the widget bounds.  All coordinates are expressed in local widget space.

    The color of the circle is determined by the widget scheme's 'foreground'
    color.

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

    const leCircleWidgetVTable* fn;

    int32_t x; // the origin x cooridnate
    int32_t y; // the origin y coordinate
    uint32_t radius; // the radius of the circle
    uint32_t thickness; // the thickness of the circle outline
    leBool filled; // fills the circle area
} leCircleWidget;

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

leCircleWidget* leCircleWidget_New(void);

void leCircleWidget_Constructor(leCircleWidget* cir);

#ifdef _DOXYGEN_
#define THIS_TYPE struct leWidget


// *****************************************************************************
virtual lePoint getOrigin(const leCheckBoxWidget* _this);


// *****************************************************************************
virtual leResult setOrigin(leCircleWidget* _this,
                           const lePoint org);


// *****************************************************************************
virtual int32_t getOriginX(const leCheckBoxWidget* _this);


// *****************************************************************************
virtual leResult setOriginY(leCircleWidget* _this,
                            const int32_t x);


// *****************************************************************************
virtual int32_t getOriginY(const leCircleWidget* _this);

// *****************************************************************************
virtual leResult setOriginY(leCircleWidget* _this,
                            const int32_t y);


// *****************************************************************************
virtual uint32_t getRadius(const leCircleWidget* _this);


// *****************************************************************************
virtual leResult setRadius(leCircleWidget* _this,
                           uint32_t rad);


// *****************************************************************************
virtual uint32_t getThickness(const leCircleWidget* _this);


// *****************************************************************************
virtual leResult setThickness(leCircleWidget* _this,
                              uint32_t thk);


// *****************************************************************************
virtual leBool getFilled(const leCircleWidget* _this);

// *****************************************************************************
virtual leResult setFilled(leCircleWidget* _this,
                           leBool fill);


#undef THIS_TYPE
#endif

#ifdef __cplusplus
}
#endif

#endif // LE_CIRCLE_WIDGET_ENABLED
#endif /* LEGATO_CIRCLE_H */