legato_widget_imagerotate.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_imagerotate.h

  Summary:


  Description:
    This module implements a rotatable image widget.
*******************************************************************************/

#ifndef LEGATO_IMAGEROTATE_H
#define LEGATO_IMAGEROTATE_H

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

#if LE_IMAGEROTATE_WIDGET_ENABLED == 1

#ifdef __cplusplus
extern "C" {
#endif

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

typedef struct leImageRotateWidget leImageRotateWidget;

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

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

#define LE_IMAGEROTATEWIDGET_VTABLE(THIS_TYPE) \
    LE_WIDGET_VTABLE(THIS_TYPE) \
    \
    leImage*          (*getImage)(const THIS_TYPE* _this); \
    leResult          (*setImage)(THIS_TYPE* _this, const leImage* img); \
    int32_t           (*getAngle)(const THIS_TYPE* _this); \
    leResult          (*setAngle)(THIS_TYPE* _this, int32_t a); \
    leImageFilterMode (*getFilter)(const THIS_TYPE* _this); \
    leResult          (*setFilter)(THIS_TYPE* _this, leImageFilterMode filter); \

typedef struct leImageRotateWidgetVTable
{
    LE_IMAGEROTATEWIDGET_VTABLE(leImageRotateWidget)
} leImageRotateWidgetVTable;

// DOM-IGNORE-END

// *****************************************************************************
/* Enumeration:
    leImageRotateWidget

  Summary:
    Image rotate widget struct definition

  Description:
    An image rotate widget displays an image asset and can translate and resize that image.

  Remarks:
    None.
*/

typedef struct leImageRotateWidget
{
    leWidget widget; // widget base class

    const leImageRotateWidgetVTable* fn;

    const leImage* image; // pointer to image asset

    int32_t angle;

    leImageFilterMode filter;
} leImageRotateWidget;

/* internal use only */
void _leImageRotateWidget_Destructor(leImageRotateWidget* img);

void _leImageRotateWidget_Paint(leImageRotateWidget* img);
// *****************************************************************************
// *****************************************************************************
// Section: Routines
// *****************************************************************************
// *****************************************************************************

leImageRotateWidget* leImageRotateWidget_New(void);

void leImageRotateWidget_Constructor(leImageRotateWidget* wgt);

#ifdef _DOXYGEN_
#define THIS_TYPE struct leWidget

virtual leImage* getImage(const leImageRotateWidget* _this);


virtual leResult setImage(leImageRotateWidget* _this,
                          leImage* img);


virtual lePoint getOrigin(const leImageRotateWidget* _this);


virtual leResult setOrigin(leImageRotateWidget* _this,
                           lePoint origin);

// *****************************************************************************
virtual int32_t getAngle(const leImageRotateWidget* _this);


// *****************************************************************************
virtual leResult setAngle(leImageRotateWidget* _this,
                          int32_t angle);


// *****************************************************************************
virtual leImageFilter getFilter(const leImageRotateWidget* _this);


// *****************************************************************************
virtual leResult setFilter(leImageRotateWidget* _this,
                           leImageFilter filter);

#undef THIS_TYPE
#endif

#ifdef __cplusplus
}
#endif

#endif // LE_IMAGEROTATE_WIDGET_ENABLED
#endif /* LEGATO_IMAGEROTATE_H */