legato_widget_line.h

/*******************************************************************************
* 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_line.h

  Summary:


  Description:
    This module implements line draw widget functions.
*******************************************************************************/

#ifndef LEGATO_LINE_H
#define LEGATO_LINE_H

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

#if LE_LINE_WIDGET_ENABLED == 1

#ifdef __cplusplus
extern "C" {
#endif

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

typedef struct leLineWidget leLineWidget;

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

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

#define LE_LINEWIDGET_VTABLE(THIS_TYPE) \
    LE_WIDGET_VTABLE(THIS_TYPE) \
    \
    leResult  (*getStartPoint)(const THIS_TYPE* _this, lePoint* pnt); \
    leResult  (*setStartPoint)(THIS_TYPE* _this, int32_t x, int32_t y); \
    leResult  (*getEndPoint)(const THIS_TYPE* _this, lePoint* pnt); \
    leResult  (*setEndPoint)(THIS_TYPE* _this, int32_t x, int32_t y); \
    
typedef struct leLineWidgetVTable
{
    LE_LINEWIDGET_VTABLE(leLineWidget)
} leLineWidgetVTable; 

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

    const leLineWidgetVTable* fn;

    int32_t x1; // point 1 x
    int32_t y1; // point 1 y
    int32_t x2; // point 2 x
    int32_t y2; // point 2 y
} leLineWidget;

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

leLineWidget* leLineWidget_New(void);

void leLineWidget_Constructor(leLineWidget* wgt);

#ifdef _DOXYGEN_
#define THIS_TYPE struct leWidget

virtual lePoint getStartPoint(const leLineWidget* _this);


virtual leResult setStartPoint(leLineWidget* _this,
                               int32_t x,
                               int32_t y);


virtual lePoint getEndPoint(const leLineWidget* _this);


virtual leResult setEndPoint(leLineWidget* _this,
                               int32_t x,
                               int32_t y);

#undef THIS_TYPE
#endif

#ifdef __cplusplus
}
#endif

#endif // LE_LINE_WIDGET_ENABLED
#endif /* LEGATO_LINE_H */