legato_widget_textfield.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_textfield.h

  Summary:


  Description:
    This module implements text field widget functions.
*******************************************************************************/

#ifndef LEGATO_TEXTFIELD_H
#define LEGATO_TEXTFIELD_H

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

#if LE_TEXTFIELD_WIDGET_ENABLED == 1

#ifdef __cplusplus
extern "C" {
#endif

#include "gfx/legato/widget/legato_editwidget.h"
#include "gfx/legato/string/legato_dynamicstring.h"

typedef struct leTextFieldWidget leTextFieldWidget;

// *****************************************************************************
/* Function Pointer:
    leTextFieldWidget_TextChangedCallback

  Summary:
    Text changed event function callback type
*/
typedef void (* leTextFieldWidget_TextChangedCallback)(leTextFieldWidget*);

// *****************************************************************************
/* Function Pointer:
    leTextFieldWidget_FocusChangedCallback

  Summary:
    Focus changed event function callback type
*/
typedef void (* leTextFieldWidget_FocusChangedCallback)(leTextFieldWidget*, leBool);

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

#define LE_TEXTFIELDWIDGET_VTABLE(THIS_TYPE) \
    LE_EDITWIDGET_VTABLE(THIS_TYPE) \
    \
    uint32_t   (*getCursorDelay)(const THIS_TYPE* _this); \
    leResult   (*setCursorDelay)(THIS_TYPE* _this, uint32_t dt); \
    leBool     (*getCursorEnabled)(const THIS_TYPE* _this); \
    leResult   (*setCursorEnabled)(THIS_TYPE* _this, leBool en); \
    uint32_t   (*getCursorPosition)(const THIS_TYPE* _this); \
    leResult   (*setCursorPosition)(THIS_TYPE* _this, uint32_t pos); \
    const leString* (*getString)(const THIS_TYPE* txt); \
    leResult   (*setString)(THIS_TYPE* _this, const leString* str); \
    leFont*    (*getFont)(const THIS_TYPE* _this); \
    leResult   (*setFont)(THIS_TYPE* _this, const leFont* fnt); \
    leString*  (*getHintString)(const THIS_TYPE* txt); \
    leResult   (*setHintString)(THIS_TYPE* _this, const leString* str); \
    leResult   (*setClearValueOnFirstEdit)(THIS_TYPE* _this, leBool clr); \
    leTextFieldWidget_TextChangedCallback (*getTextChangedEventCallback)(const THIS_TYPE* _this); \
    leResult   (*setTextChangedEventCallback)(THIS_TYPE* _this, leTextFieldWidget_TextChangedCallback cb); \
    leTextFieldWidget_FocusChangedCallback (*getFocusChangedEventCallback)(const THIS_TYPE* _this); \
    leResult   (*setFocusChangedEventCallback)(THIS_TYPE* _this, leTextFieldWidget_FocusChangedCallback cb); \

typedef struct leTextFieldWidgetVTable
{
    LE_TEXTFIELDWIDGET_VTABLE(leTextFieldWidget)
} leTextFieldWidgetVTable;

// DOM-IGNORE-END

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

// *****************************************************************************
typedef struct leTextFieldWidget
{
    leEditWidget editWidget; // edit widget base class

    const leTextFieldWidgetVTable* fn;

    const leString* hintText;
    leDynamicString text; // the text to edit

    uint32_t cursorPos; // current cursor position
    uint32_t cursorDelay; // cursor blink delay
    uint32_t cursorTime; // current cursor tick counter
    leBool cursorEnable; // cursor enabled flag
    leBool cursorVisible; // cursor visbility flag
    leBool clearOnFirstEdit; // needs clear on first edit

    leTextFieldWidget_TextChangedCallback textChangedEvent; // text changed event
    leTextFieldWidget_FocusChangedCallback focusChangedEvent; // focus changed event
} leTextFieldWidget;

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

leTextFieldWidget* leTextFieldWidget_New(void);

void leTextFieldWidget_Constructor(leTextFieldWidget* wgt);

#ifdef _DOXYGEN_
#define THIS_TYPE struct leWidget


// *****************************************************************************
virtual uint32_t getCursorDelay(const leTextFieldWidget* _this);


// *****************************************************************************
virtual leResult setCursorDelay(leTextFieldWidget* _this,
                                uint32_t dt);

// *****************************************************************************
virtual leBool getCursorEnabled(const leTextFieldWidget* _this);

// *****************************************************************************
virtual leResult setCursorEnabled(leTextFieldWidget* _this,
                                  leBool en);


// *****************************************************************************
virtual uint32_t getCursorPosition(const leTextFieldWidget* _this);


// *****************************************************************************
virtual leResult setCursorPosition(leTextFieldWidget* _this,
                                   uint32_t pos);


// *****************************************************************************
virtual const leString* getString(const leTextFieldWidget* txt);


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

// *****************************************************************************
virtual leFont* getFont(const leTextFieldWidget* _this);


// *****************************************************************************
virtual leResult setFont(leTextFieldWidget* _this,
                         const leFont* fnt);


// *****************************************************************************
virtual leString* getHintString(const leTextFieldWidget* _this);


// *****************************************************************************
virtual leResult setHintString(leTextFieldWidget* _this,
                               const leString* str);

// *****************************************************************************
virtual leResult setClearValueOnFirstEdit(leTextFieldWidget* _this,
                                          leBool clr);


virtual leTextFieldWidget_TextChangedCallback getTextChangedEventCallback
                                            (const leTextFieldWidget* _this);

virtual leResult setTextChangedEventCallback(leTextFieldWidget* _this,
                                             leTextFieldWidget_TextChangedCallback cb);

virtual leTextFieldWidget_FocusChangedCallback getFocusChangedEventCallback
                                                (const leTextFieldWidget* _this);

virtual leResult setFocusChangedEventCallback(leTextFieldWidget* _this,
                                              leTextFieldWidget_FocusChangedCallback cb);

#undef THIS_TYPE
#endif

#ifdef __cplusplus
}
#endif

#endif // LE_TEXTFIELD_WIDGET_ENABLED
#endif /* LEGATO_TEXTFIELD_H */