framework.h File Reference

UI framework type (component, group, event) definitions. More...

#include "../../draw/types/primitives.h"
#include "event.h"

Go to the source code of this file.

Data Structures
struct	ui_component_s
	Common part of all widgets and modals. More...
struct	ui_group_s
	UI component group/container struct. More...
struct	ui_multipress_event_s
	Multipress/multitouch event. More...
struct	ui_event_ext_s
	Main event struct extension. More...
struct	ui_event_ext_prime_s
struct	ui_event_sys_s
	Common struct subset shared across system and main events. More...
struct	ui_event_std_s
	Structure for UI events. More...
struct	ui_event_prime_s
	Structure for low level UI events (Prime G1 extension). More...
struct	ui_event_state_change_s
	Event struct used by SendMessage(). More...

Macros
#define	ui_event_s   ui_event_std_s

Typedefs
typedef struct ui_component_s	ui_component_t
	ui_component_s
typedef struct ui_event_std_s	ui_event_std_t
	ui_event_std_s
typedef struct ui_event_prime_s	ui_event_prime_t
	ui_event_prime_s
typedef struct ui_event_ext_s	ui_event_ext_t
	ui_event_ext_s
typedef struct ui_event_ext_prime_s	ui_event_ext_prime_t
	ui_event_ext_prime_s
typedef struct ui_event_sys_s	ui_event_sys_t
	ui_event_sys_s
typedef struct ui_event_state_change_s	ui_event_state_change_t
	ui_event_state_change_s
typedef struct ui_multipress_event_s	ui_multipress_event_t
	ui_multipress_event_s
typedef struct ui_group_s	ui_group_t
	ui_group_s
typedef struct ui_event_std_s	ui_event_t
	ui_event_std_s

Enumerations
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 }
	Component behavior flag. Usually set by the component constructors but can sometimes change over time. More...

Detailed Description

UI framework type (component, group, event) definitions.

Enumeration Type Documentation

ui_component_flag_e

enum ui_component_flag_e

Component behavior flag. Usually set by the component constructors but can sometimes change over time.

Todo

Still need to verify these on the real machine.

Enumerator
UI_COMPONENT_FLAG_SELECTABLE	Component is selectable. Affects the group child selection through PGROUP_setCurrent() and input event processing. Setting this bit to 0 blocks the above 2.
UI_COMPONENT_FLAG_FOCUS_TERMINAL	Component is a terminal node when resolving focusable items in a container. When a container is finding a component that will gain focus, stop the search immediately and select this component.
UI_COMPONENT_FLAG_FOCUS_SKIP	Skip this component when searching for the next component to gain focus.
UI_COMPONENT_FLAG_DESKBOX_ALLOW_HOME_KEY	Deskbox-specific: Bubble KEY_HOME presses to system. Requires ::UI_DESKBOX_FLAG_ALLOW_SYSTEM_EVENTS to properly work.
UI_COMPONENT_FLAG_DESKBOX_ALLOW_SYSTEM_EVENTS	Deskbox-specific: Handle system events and exit word.
UI_COMPONENT_FLAG_GROUP_ALLOW_EXIT_WORD	Group-specific: Handle exit word.
UI_COMPONENT_FLAG_DESKBOX_ALLOW_SEARCH_KEYS	Deskbox-specific: Bubble translator and search key presses to system.
UI_COMPONENT_FLAG_DESKBOX_ALLOW_INLINE_SEARCH	Deskbox-specific: Invoke the inline search modal with the selected text instead of the normal search modal on KEY_SEARCH key presses.
UI_COMPONENT_FLAG_GROUP_NO_AUTO_DRAW	Group-specific: Do not periodically draw this group.
UI_COMPONENT_FLAG_DESKBOX_ALLOW_APP_KEYS	Deskbox-specific: Bubble app key presses to system.