framework.h

Go to the documentation of this file.

/*
 * Copyright 2024-2026 dogtopus
 * SPDX-License-Identifier: MIT
 */

#ifndef __MUTEKI_UI_TYPES_FRAMEWORK_H__
#define __MUTEKI_UI_TYPES_FRAMEWORK_H__
 
#include "../../draw/types/primitives.h"
#include "event.h"
 
#ifdef __cplusplus
extern "C" {
#endif

enum ui_component_flag_e {
    UI_COMPONENT_FLAG_SELECTABLE = 0x0001,
    UI_COMPONENT_FLAG_FOCUS_TERMINAL = 0x0002,
    UI_COMPONENT_FLAG_FOCUS_SKIP = 0x0004,
    UI_COMPONENT_FLAG_DESKBOX_ALLOW_HOME_KEY = 0x0100,
    UI_COMPONENT_FLAG_DESKBOX_ALLOW_SYSTEM_EVENTS = 0x0400,
    UI_COMPONENT_FLAG_GROUP_ALLOW_EXIT_WORD = 0x0400,
    UI_COMPONENT_FLAG_DESKBOX_ALLOW_SEARCH_KEYS = 0x0800,
    UI_COMPONENT_FLAG_DESKBOX_ALLOW_INLINE_SEARCH = 0x2000,
    UI_COMPONENT_FLAG_GROUP_NO_AUTO_DRAW = 0x8000,
    UI_COMPONENT_FLAG_DESKBOX_ALLOW_APP_KEYS = 0x8000,
};

typedef struct ui_component_s ui_component_t;
typedef struct ui_event_std_s ui_event_std_t;
typedef struct ui_event_prime_s ui_event_prime_t;
typedef struct ui_event_ext_s ui_event_ext_t;
typedef struct ui_event_ext_prime_s ui_event_ext_prime_t;
typedef struct ui_event_sys_s ui_event_sys_t;
typedef struct ui_event_state_change_s ui_event_state_change_t;
typedef struct ui_multipress_event_s ui_multipress_event_t;
typedef struct ui_group_s ui_group_t;
 
#if defined(MUTEKI_HAS_PRIME_UI_EVENT) && MUTEKI_HAS_PRIME_UI_EVENT == 1
#define ui_event_s ui_event_prime_s
typedef struct ui_event_prime_s ui_event_t;
#else
#define ui_event_s ui_event_std_s
typedef struct ui_event_std_s ui_event_t;
#endif

struct ui_component_s {
    ui_component_t *next; // 0x0:0x4
    ui_component_t *parent; // 0x4:0x8
    unsigned short state; // 0x8:0xa
    unsigned short flags; // 0xa:0xc
    lcd_rect_t footprint; // 0xc:0x14
    void (*on_set_state)(ui_component_t *self, unsigned short mask, bool value); // 0x14:0x18
    void (*on_erase_bg)(ui_component_t *self); // 0x18:0x1c
    void (*on_draw)(ui_component_t *self); // 0x1c:0x20
    void (*on_event)(ui_component_t *self, ui_event_t *event); // 0x20:0x24
    void *user_data; // 0x24:0x2a
    unsigned short tag;
    unsigned short runtime_type; // 0x2a:0x2c
    int unk_0x2c; // 0x2c:0x30
    unsigned short unk_0x30; // 0x30:0x32
    short unk_0x32; // 0x32:0x34
};


struct ui_group_s {
     * @brief @x_term{superc}
     */
    ui_component_t component;  // 0x0:0x34
    ui_component_t *current;  // 0x34:0x38
    int (*on_exec)(ui_group_t *self);  // 0x38:0x3c
    void (*on_redraw)(ui_group_t *self);  // 0x3c:0x40
    ui_component_t *(*on_find_previous)(ui_group_t *self);  // 0x40:0x44
    ui_component_t *(*on_set_current)(ui_group_t *self, ui_component_t *child);  // 0x44:0x48
    void (*on_insert)(ui_group_t *self, ui_component_t *child);  // 0x48:0x4c
    int execution_result;  // 0x4c:0x50
};
 


struct ui_multipress_event_s {
     * @see ui_event_type_e List of event types.
     */
    unsigned int type;
    unsigned short finger_id;
    union {
        struct {
             * @brief Keycode for the first pressed key.
             */
            unsigned short key_code0;
            unsigned short key_code1;
        };
        struct {

             * @details Only available when ui_multipress_event_s::type is
             * ::UI_EVENT_TYPE_TOUCH_BEGIN,
             * ::UI_EVENT_TYPE_TOUCH_MOVE, or ::UI_EVENT_TYPE_TOUCH_END.
             */
            unsigned short touch_x;
            unsigned short touch_y;
        };
    };

    unsigned short unk_0xb;
};


struct ui_event_ext_s {
    union {
        * @brief Extra user data.
        * @details Format is event-specific. Usually unused.
        */
        void *user_data2; // 12-16 pointer that only shows up on USB insertion event.
        unsigned int user_data2_scalar;
    };

    unsigned short event_source; // 20-22
    unsigned short unk22; // 22-24
};
 
struct ui_event_ext_prime_s {

    unsigned short available_multipress_events; // 24-26
    unsigned short unk_0x1a; // 26-28
    ui_multipress_event_t multipress_events[8]; // 28-124
};


struct ui_event_sys_s {
     * widget's ui_component_t::on_event callback will be called with this event.
     * @note Unused in system events.
     */
    ui_component_t *recipient; // 0-4
    int event_type;
    union {
        unsigned int value;
        struct {
             */
            unsigned short key_code0;
            unsigned short key_code1;
        };
        struct {

             * ::UI_EVENT_TYPE_TOUCH_MOVE, or ::UI_EVENT_TYPE_TOUCH_END.
             */
            unsigned short touch_x;
            unsigned short touch_y;
        };
    };
    union {


        */
        void *user_data; // 12-16 pointer that only shows up on USB insertion event.
        unsigned int user_data_scalar;
        unsigned int scroll_wheel;
    };
};



struct ui_event_std_s {
    ui_event_sys_t body;
    ui_event_ext_t ext;
};


struct ui_event_prime_s {
    ui_event_sys_t body;
    ui_event_ext_t ext;
    ui_event_ext_prime_t ext_prime;
};

struct ui_event_state_change_s {
    ui_event_t event; // 0x0:0x18
    unsigned int state_change; // 0x18:0x1c
}; // 0x1c bytes
 
#ifdef __cplusplus
} // extern "C"
#endif
 
#endif  // __MUTEKI_UI_TYPES_FRAMEWORK_H__