EasyGUI  Version v1.0
Structures and enumerations

List of core structures and enumerations. More...

Modules

 Fonts
 Font description structures and flags.
 

Data Structures

struct  gui_linkedlist_t
 Linked list structure. More...
 
struct  gui_linkedlistmulti_t
 Structure used for dynamic struct allocation. More...
 
struct  gui_linkedlistroot_t
 Linked list root structure for start and end widget in structure. More...
 
struct  gui_timer_core_t
 Core timer structure for GUI timers. More...
 
struct  gui_gradient_t
 Color gradient definition. More...
 
struct  gui_touch_data_t
 Single touch data structure. More...
 
struct  guii_touch_data_t
 Internal touch structure used for widget callbacks. More...
 
struct  gui_keyboard_data_t
 Single key data structure. More...
 
struct  guii_keyboard_data_t
 Internal single key data structure. More...
 
struct  gui_display_t
 GUI clipping management. More...
 
struct  gui_layer_t
 LCD layer structure. More...
 
struct  gui_lcd_t
 GUI LCD structure. More...
 
struct  gui_image_desc_t
 Image descriptor structure. More...
 
struct  gui_ll_t
 GUI Low-Level structure for drawing operations. More...
 

Macros

#define _GT(x)   (gui_char *)(x)
 
#define gui_const   const
 
#define GUI_DIM_MIN   ((gui_dim_t)0x8000)
 
#define GUI_DIM_MAX   ((gui_dim_t)0x7FFF)
 
#define GUI_ARRAYSIZE(x)
 Get size of statically declared array. More...
 
#define GUI_COUNT_OF(x)   GUI_ARRAYSIZE(x)
 
#define gui_containerof(ptr, type, memb)   (type *)((char *)(ptr) - (char *)offsetof(type, memb))
 Get container object from member. More...
 

Typedefs

typedef uint32_t gui_id_t
 
typedef uint32_t gui_color_t
 
typedef int16_t gui_dim_t
 
typedef uint8_t gui_char
 
typedef void(* gui_eventcallback_t) (void)
 Global event callback function declaration.
 

Enumerations

enum  guir_t { guiOK = 0x00, guiERROR = 0x01 }
 Results enumeration. More...
 
enum  gui_touch_state_t { GUI_TOUCH_STATE_RELEASED = 0x00, GUI_TOUCH_STATE_PRESSED = 0x01 }
 Touch state on widget. More...
 
enum  guii_touch_status_t { touchHANDLED = 0x00, touchHANDLEDNOFOCUS, touchCONTINUE }
 Touch internal processing enumeration. More...
 
enum  guii_keyboard_status_t { keyHANDLED = 0x00, keyCONTINUE }
 Keyboard internal processing enumeration. More...
 
enum  GUI_LL_Command_t { GUI_LL_Command_Init = 0x00, GUI_LL_Command_SetActiveLayer }
 Low-level LCD command enumeration. More...
 

GUI_CAST Casting macros

Helpers to cast result to different type

#define GUI_U8(x)   ((uint8_t)(x))
 
#define GUI_I8(x)   ((int8_t)(x))
 
#define GUI_U16(x)   ((uint16_t)(x))
 
#define GUI_I16(x)   ((int16_t)(x))
 
#define GUI_U32(x)   ((uint32_t)(x))
 
#define GUI_I32(x)   ((int32_t)(x
 
#define GUI_VP(x)   ((void *)(x))
 
#define GUI_FLOAT(x)   ((float)(x))
 
#define GUI_DIM(x)   ((gui_dim_t)(x))
 

Detailed Description

List of core structures and enumerations.

Macro Definition Documentation

◆ _GT

#define _GT (   x)    (gui_char *)(x)

Macro to force strings to right format for processing

◆ GUI_ARRAYSIZE

#define GUI_ARRAYSIZE (   x)

Get size of statically declared array.

Parameters
[in]xInput array
Returns
Number of array elements

◆ gui_const

#define gui_const   const

Macro for constant keyword

◆ gui_containerof

#define gui_containerof (   ptr,
  type,
  memb 
)    (type *)((char *)(ptr) - (char *)offsetof(type, memb))

Get container object from member.

◆ GUI_DIM

#define GUI_DIM (   x)    ((gui_dim_t)(x))

Result casted to gui_dim_t

◆ GUI_FLOAT

#define GUI_FLOAT (   x)    ((float)(x))

Result casted to float

◆ GUI_I16

#define GUI_I16 (   x)    ((int16_t)(x))

Result casted to int16_t

◆ GUI_I32

#define GUI_I32 (   x)    ((int32_t)(x

Result casted to int32_t

◆ GUI_I8

#define GUI_I8 (   x)    ((int8_t)(x))

Result casted to int8_t

◆ GUI_U16

#define GUI_U16 (   x)    ((uint16_t)(x))

Result casted to uint16_t

◆ GUI_U32

#define GUI_U32 (   x)    ((uint32_t)(x))

Result casted to uint32_t

◆ GUI_U8

#define GUI_U8 (   x)    ((uint8_t)(x))

Result casted to uint8_t

◆ GUI_VP

#define GUI_VP (   x)    ((void *)(x))

Result casted to void *

Typedef Documentation

◆ gui_char

typedef uint8_t gui_char

GUI char data type for all string operations

◆ gui_color_t

typedef uint32_t gui_color_t

Color definition

◆ gui_dim_t

typedef int16_t gui_dim_t

GUI dimensions in units of pixels

◆ gui_id_t

typedef uint32_t gui_id_t

GUI object ID

Enumeration Type Documentation

◆ GUI_LL_Command_t

Low-level LCD command enumeration.

Enumerator
GUI_LL_Command_Init 

Initialize low-level part of GUI.

Parameters
[in]*paramPointer to gui_ll_t structure to fill data to
[out]*resultPointer to uint8_t variable to save result: 0 = OK otherwise ERRORSet new layer as active layer
GUI_LL_Command_SetActiveLayer 

Initialize low-level part of GUI.

Parameters
[in]*paramPointer to gui_ll_t structure to fill data to
[out]*resultPointer to uint8_t variable to save result: 0 = OK otherwise ERRORSet new layer as active layer

◆ gui_touch_state_t

Touch state on widget.

Enumerator
GUI_TOUCH_STATE_RELEASED 

Touch released

GUI_TOUCH_STATE_PRESSED 

Touch detected

◆ guii_keyboard_status_t

Keyboard internal processing enumeration.

Enumerator
keyHANDLED 

Key has been handled

keyCONTINUE 

Key has not been handled and further checking can be done

◆ guii_touch_status_t

Touch internal processing enumeration.

Enumerator
touchHANDLED 

Touch has been handled

touchHANDLEDNOFOCUS 

Touch has been handled but widget is not in focus state (used for widget who don't have touch events)

touchCONTINUE 

Touch has not been handled and further checking can be done

◆ guir_t

enum guir_t

Results enumeration.

Enumerator
guiOK 

GUI status is OK

guiERROR 

There was an error in processing