gui_widget.h

/*
 * Copyright (c) 2019 Tilen MAJERLE
 *  
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without restriction,
 * including without limitation the rights to use, copy, modify, merge,
 * publish, distribute, sublicense, and/or sell copies of the Software, 
 * and to permit persons to whom the Software is furnished to do so, 
 * subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
 * AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 * This file is part of EasyGUI library.
 *
 * Author:          Tilen Majerle <tilen@majerle.eu>
 */
#ifndef GUI_HDR_WIDGET_H
#define GUI_HDR_WIDGET_H

/* C++ detection */
#ifdef __cplusplus
extern "C" {
#endif

#include "gui/gui.h"
#include "gui/gui_draw.h"

#define GUI_ID_WINDOW_BASE          ((gui_id_t)0x0000)                          
#define GUI_ID_KEYBOARD_BASE        ((gui_id_t)(GUI_ID_WINDOW_BASE + 0x1000))   
#define GUI_ID_USER                 ((gui_id_t)(0x10000))                       
#define GUI_WIDGET_ZINDEX_MAX       ((int32_t)(0x7FFFFFFF))                     
#define GUI_WIDGET_ZINDEX_MIN       ((int32_t)(0x80000000))                     
#define GUI_FLAG_WIDGET_CREATE_PARENT_DESKTOP       0x01    
#define GUI_FLAG_WIDGET_CREATE_NO_PARENT            0x02    
#define GUI_FLAG_WIDGET_CREATE_IGNORE_INVALIDATE    0x04    
#define GUI_WIDGET_FOOTPRINT                        0x00ACCE55
 
#define guii_widget_iswidget(h)                     (__GH(h) != NULL && __GH(h)->footprint == GUI_WIDGET_FOOTPRINT)

#define guii_widget_getrelativex(h)                 GUI_DIM((gui_widget_isexpanded(h) ? 0 : \
                                                        (guii_widget_getflag(__GH(h), GUI_FLAG_XPOS_PERCENT) ? (gui_dim_t)((float)GUI_ROUND(__GH(h)->x * guii_widget_getparentinnerwidth(__GH(h))) / 100.0f) : __GH(h)->x) \
                                                    ))

#define guii_widget_getrelativey(h)                 GUI_DIM(gui_widget_isexpanded(__GH(h)) ? 0 : \
                                                        (guii_widget_getflag(__GH(h), GUI_FLAG_YPOS_PERCENT) ? (gui_dim_t)((float)GUI_ROUND(__GH(h)->y * guii_widget_getparentinnerheight(__GH(h))) / 100.0f) : __GH(h)->y) \
                                                    )

#define guii_widget_getflag(h, flag)                (__GH(h)->flags & (flag))

#define guii_widget_getcoreflag(h, flag)            (__GH(h)->widget->flags & (flag))

#define guii_widget_setflag(h, flag)                (__GH(h)->flags |= (flag))

#define guii_widget_clrflag(h, flag)                (__GH(h)->flags &= ~(flag))

#define guii_widget_getparent(h)                    (__GH(h) != NULL ? __GH(h)->parent : NULL)

#define guii_widget_hasparent(h)                    (__GH(h) != NULL && __GH(h)->parent != NULL)

#define guii_widget_callback(h, cmd, param, result) (__GH(h)->callback != NULL ? __GH(h)->callback(h, cmd, param, result) : __GH(h)->widget->callback(h, cmd, param, result))

#define guii_widget_getcolor(h, index)              (__GH(h)->colors != NULL ? __GH(h)->colors[(uint8_t)(index)] : (__GH(h)->widget->colors != NULL ? __GH(h)->widget->colors[(uint8_t)(index)] : GUI_COLOR_BLACK))

#define guii_widget_getparentwidth(h)               GUI_DIM((guii_widget_hasparent(h) ? gui_widget_getwidth(guii_widget_getparent(h)) : GUI.lcd.width))

#define guii_widget_getparentheight(h)              GUI_DIM((guii_widget_hasparent(h) ? gui_widget_getheight(guii_widget_getparent(h)) : GUI.lcd.height))

#define guii_widget_getparentinnerwidth(h)          GUI_DIM((guii_widget_hasparent(h) ? gui_widget_getinnerwidth(guii_widget_getparent(h)) : GUI.lcd.width))

#define guii_widget_getparentinnerheight(h)         GUI_DIM((guii_widget_hasparent(h) ? gui_widget_getinnerheight(guii_widget_getparent(h)) : GUI.lcd.height))

#if GUI_CFG_USE_ALPHA
#define guii_widget_isvisible(h)                    (!guii_widget_getflag(__GH(h), GUI_FLAG_HIDDEN) && __GH(h)->alpha)
#else /* GUI_CFG_USE_ALPHA */
#define guii_widget_isvisible(h)                    (!guii_widget_getflag(h, GUI_FLAG_HIDDEN))
#endif /* !GUI_CFG_USE_ALPHA */

#define guii_widget_ishidden(h)                     (!guii_widget_isvisible(__GH(h)))

#define guii_widget_allowchildren(h)                (!!guii_widget_getcoreflag(h, GUI_FLAG_WIDGET_ALLOW_CHILDREN))

#define guii_widget_haschildren(h)                  (guii_widget_allowchildren(h) && gui_linkedlist_hasentries(&h->root_list))

#define guii_widget_isdialogbase(h)                 (!!(guii_widget_getcoreflag(h, GUI_FLAG_WIDGET_DIALOG_BASE) || guii_widget_getflag(h, GUI_FLAG_WIDGET_DIALOG_BASE)))

#define guii_widget_isfocused(h)                    (!!guii_widget_getflag(h, GUI_FLAG_FOCUS))

#define guii_widget_isactive(h)                     (!!guii_widget_getflag(h, GUI_FLAG_ACTIVE))

#define guii_widget_hasalpha(h)                     (guii_widget_isvisible(h) && gui_widget_getalpha(h) < 0xFF)

uint8_t         guii_widget_processtextkey(gui_handle_p h, guii_keyboard_data_t* key);

uint8_t         guii_widget_setparam(gui_handle_p h, uint16_t cfg, const void* data, uint8_t invalidate, uint8_t invalidateparent);
uint8_t         guii_widget_getparam(gui_handle_p h, uint16_t cfg, void* data);
gui_dim_t       guii_widget_getparentabsolutex(gui_handle_p h);
gui_dim_t       guii_widget_getparentabsolutey(gui_handle_p h);

void*           gui_widget_create(const gui_widget_t* widget, gui_id_t id, float x, float y, float width, float height, gui_handle_p parent, gui_widget_evt_fn evt_fn, uint16_t flags);
uint8_t         gui_widget_setcolor(gui_handle_p h, uint8_t index, gui_color_t color);
uint8_t         gui_widget_setstyle(gui_handle_p h, const gui_style_p style);

uint32_t            gui_widget_alloctextmemory(gui_handle_p h, uint32_t size);
uint8_t             gui_widget_freetextmemory(gui_handle_p h);
uint8_t             gui_widget_settext(gui_handle_p h, const gui_char* text);
const gui_char *    gui_widget_gettext(gui_handle_p h);
const gui_char *    gui_widget_gettextcopy(gui_handle_p h, gui_char* dst, uint32_t len);
uint8_t             gui_widget_setfont(gui_handle_p h, const gui_font_t* font);
const gui_font_t *  gui_widget_getfont(gui_handle_p h);
uint8_t             gui_widget_setfontdefault(const gui_font_t* font);
uint8_t             gui_widget_isfontandtextset(gui_handle_p h);

uint8_t         gui_widget_setsize(gui_handle_p h, gui_dim_t width, gui_dim_t height);
uint8_t         gui_widget_setsizepercent(gui_handle_p h, float width, float height);
uint8_t         gui_widget_setsizeoriginal(gui_handle_p h, float width, float height);
uint8_t         gui_widget_setwidth(gui_handle_p h, gui_dim_t width);
uint8_t         gui_widget_setwidthpercent(gui_handle_p h, float width);
uint8_t         gui_widget_setwidthoriginal(gui_handle_p h, float width);
uint8_t         gui_widget_setheight(gui_handle_p h, gui_dim_t height);
uint8_t         gui_widget_setheightpercent(gui_handle_p h, float height);
uint8_t         gui_widget_setheightoriginal(gui_handle_p h, float height);

gui_dim_t       gui_widget_getwidth(gui_handle_p h);
gui_dim_t       gui_widget_getheight(gui_handle_p h);
gui_dim_t       gui_widget_getinnerwidth(gui_handle_p h);
gui_dim_t       gui_widget_getinnerheight(gui_handle_p h);
float           gui_widget_getwidthpercent(gui_handle_p h);
float           gui_widget_getheightpercent(gui_handle_p h);
float           gui_widget_getwidthoriginal(gui_handle_p h, uint8_t* is_percent);
float           gui_widget_getheightoriginal(gui_handle_p h, uint8_t* is_percent);

static inline float
gui_widget_getwidthex(gui_handle_p h, uint8_t in_percent) {
    return GUI_FLOAT(in_percent ? gui_widget_getwidthpercent(h) : gui_widget_getwidth(h));
}

static inline float
gui_widget_getheightex(gui_handle_p h, uint8_t in_percent) {
    return GUI_FLOAT(in_percent ? gui_widget_getheightpercent(h) : gui_widget_getheight(h));
}

uint8_t         gui_widget_setexpanded(gui_handle_p h, uint8_t state);
uint8_t         gui_widget_toggleexpanded(gui_handle_p h);
uint8_t         gui_widget_isexpanded(gui_handle_p h);

gui_dim_t       gui_widget_getabsolutex(gui_handle_p h);
gui_dim_t       gui_widget_getabsolutey(gui_handle_p h);

float           gui_widget_getxpositionoriginal(gui_handle_p h, uint8_t* is_percent);
float           gui_widget_getypositionoriginal(gui_handle_p h, uint8_t* is_percent);

uint8_t         gui_widget_setposition(gui_handle_p h, gui_dim_t x, gui_dim_t y);
uint8_t         gui_widget_setpositionpercent(gui_handle_p h, float x, float y);
uint8_t         gui_widget_setpositionoriginal(gui_handle_p h, float x, float y);
uint8_t         gui_widget_setxposition(gui_handle_p h, gui_dim_t x);
uint8_t         gui_widget_setxpositionpercent(gui_handle_p h, float x);
uint8_t         gui_widget_setxpositionoriginal(gui_handle_p h, float x);
uint8_t         gui_widget_setyposition(gui_handle_p h, gui_dim_t y);
uint8_t         gui_widget_setypositionpercent(gui_handle_p h, float y);
uint8_t         gui_widget_setypositionoriginal(gui_handle_p h, float y);

gui_dim_t       gui_widget_getxposition(gui_handle_p h);
gui_dim_t       gui_widget_getyposition(gui_handle_p h);

uint8_t         gui_widget_setscrollx(gui_handle_p h, gui_dim_t scroll);
uint8_t         gui_widget_setscrolly(gui_handle_p h, gui_dim_t scroll);
uint8_t         gui_widget_incscrollx(gui_handle_p h, gui_dim_t scroll);
uint8_t         gui_widget_incscrolly(gui_handle_p h, gui_dim_t scroll);
gui_dim_t       gui_widget_getscrollx(gui_handle_p h);
gui_dim_t       gui_widget_getscrolly(gui_handle_p h);

uint8_t         gui_widget_show(gui_handle_p h);
uint8_t         gui_widget_hide(gui_handle_p h);
uint8_t         gui_widget_hidechildren(gui_handle_p h);
uint8_t         gui_widget_putonfront(gui_handle_p h, uint8_t focus);
uint8_t         gui_widget_getalpha(gui_handle_p h);
uint8_t         gui_widget_setalpha(gui_handle_p h, uint8_t alpha);
 
uint8_t         gui_widget_invalidate(gui_handle_p h);
uint8_t         gui_widget_force_invalidate(gui_handle_p h);
uint8_t         gui_widget_invalidatewithparent(gui_handle_p h);
uint8_t         gui_widget_setignoreinvalidate(gui_handle_p h, uint8_t en, uint8_t invalidate);
uint8_t         gui_widget_setinvalidatewithparent(gui_handle_p h, uint8_t value);
uint8_t         gui_widget_setuserdata(gui_handle_p h, void* const data);
void *          gui_widget_getuserdata(gui_handle_p h);
uint8_t         gui_widget_ischildof(gui_handle_p h, gui_handle_p parent);
uint8_t         gui_widget_incselection(gui_handle_p h, int16_t dir);
uint8_t         gui_widget_setfocus(gui_handle_p h);
uint8_t         gui_widget_setzindex(gui_handle_p h, int32_t zindex);
int32_t         gui_widget_getzindex(gui_handle_p h);
gui_handle_p    gui_widget_getparent(gui_handle_p h);
gui_id_t        gui_widget_getid(gui_handle_p h);
gui_handle_p    gui_widget_getbyid(gui_id_t id);
gui_handle_p    gui_widget_getbyid_ex(gui_id_t id, gui_handle_p parent, uint8_t deep);
uint8_t         gui_widget_remove(gui_handle_p* h);

uint8_t         gui_widget_setpaddingtop(gui_handle_p h, gui_dim_t x);
uint8_t         gui_widget_setpaddingright(gui_handle_p h, gui_dim_t x);
uint8_t         gui_widget_setpaddingbottom(gui_handle_p h, gui_dim_t x);
uint8_t         gui_widget_setpaddingleft(gui_handle_p h, gui_dim_t x);
uint8_t         gui_widget_setpaddingtopbottom(gui_handle_p h, gui_dim_t x);
uint8_t         gui_widget_setpaddingleftright(gui_handle_p h, gui_dim_t x);
uint8_t         gui_widget_setpadding(gui_handle_p h, gui_dim_t x);

gui_dim_t       gui_widget_getpaddingtop(gui_handle_p h);
gui_dim_t       gui_widget_getpaddingright(gui_handle_p h);
gui_dim_t       gui_widget_getpaddingbottom(gui_handle_p h);
gui_dim_t       gui_widget_getpaddingleft(gui_handle_p h);

uint8_t         gui_widget_processdefaultcallback(gui_handle_p h, gui_widget_evt_t evt, gui_evt_param_t* const param, gui_evt_result_t* const result);
uint8_t         gui_widget_setcallback(gui_handle_p h, gui_widget_evt_fn callback);
uint8_t         gui_widget_callback(gui_handle_p h, gui_widget_evt_t evt, gui_evt_param_t* const param, gui_evt_result_t* const result);

#if defined(GUI_INTERNAL) && !__DOXYGEN__
//Strictly private functions by GUI
//Widget initialization purpose
void guii_widget_init(void);

//Clipping regions
uint8_t guii_widget_isinsideclippingregion(gui_handle_p h, uint8_t check_sib_cover);

//Move widget down and all its parents with it
void guii_widget_movedowntree(gui_handle_p h);

void guii_widget_focus_clear(void);
void guii_widget_focus_set(gui_handle_p h);
void guii_widget_active_clear(void);
void guii_widget_active_set(gui_handle_p h);

//Execute actual widget remove process
uint8_t guii_widget_executeremove(void);
#endif /* !__DOXYGEN__ */

/* C++ detection */
#ifdef __cplusplus
}
#endif

#endif /* GUI_HDR_WIDGET_H */