legato_widget_window.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_window.h

  Summary:
    Window Widget

  Description:
    This module implements window container widget functions.
*******************************************************************************/

#ifndef LEGATO_WINDOW_H
#define LEGATO_WINDOW_H

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

#if LE_WINDOW_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"

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

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

#define LE_WINDOWWIDGET_VTABLE(THIS_TYPE) \
    LE_WIDGET_VTABLE(THIS_TYPE) \
    uint32_t  (*getTitleHeight)(const THIS_TYPE* _this); \
    leResult  (*setTitleHeight)(THIS_TYPE* _this, uint32_t ht); \
    leString* (*getString)(const THIS_TYPE* _this); \
    leResult  (*setString)(THIS_TYPE* _this, const leString* str); \
    leImage*  (*getIcon)(const THIS_TYPE* _this); \
    leResult  (*setIcon)(THIS_TYPE* _this, const leImage* img); \
    uint32_t  (*getIconMargin)(const THIS_TYPE* _this); \
    leResult  (*setIconMargin)(THIS_TYPE* _this, uint32_t mg); \
    
typedef struct leWindowWidgetVTable
{
    LE_WINDOWWIDGET_VTABLE(leWindowWidget)
} leWindowWidgetVTable; 

// *****************************************************************************
/* Structure:
    leWindowWidget

  Summary:
    Implementation of a window widget struct

  Description:
    A window widget is an extension of a basic panel.  It adds a title bar
    with text and an icon.

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

    const leWindowWidgetVTable* fn;

    uint32_t titleHeight; // title height
    const leString* title; // title text

    const leImage* icon; // title icon
    uint32_t iconMargin; // title icon margin
} leWindowWidget;


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

leWindowWidget* leWindowWidget_New(void);

void leWindowWidget_Constructor(leWindowWidget* wgt);

#ifdef _DOXYGEN_
#define THIS_TYPE struct leWidget

// *****************************************************************************
virtual uint32_t getTitleHeight(const leWindowWidget* _this);

// *****************************************************************************
virtual leResult setTitleHeight(leWindowWidget* _this,
                        uint32_t ht);

// *****************************************************************************
virtual leString* getString(const leWindowWidget* _this);

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


// *****************************************************************************
virtual leImage* getIcon(const leWindowWidget* _this);

// *****************************************************************************
virtual leResult setIcon(leWindowWidget* _this,
                         const leImage* img);

// *****************************************************************************
virtual uint32_t getIconMargin(const leWindowWidget* _this);

// *****************************************************************************
virtual leResult setIconMargin(const leWindowWidget* this, uint32_t mg);


#undef THIS_TYPE
#endif

#ifdef __cplusplus
}
#endif

#endif // LE_WINDOW_WIDGET_ENABLED
#endif /* LEGATO_WINDOW_H */