host_api_ui_views.cpp File Reference

extern-C adapter that forwards plugin UI calls to PluginUiState. More...

#include "plugin_manager/PluginUiState.h"
#include "plugin_manager/host_api.h"

Go to the source code of this file.

Functions
int	host_ui_push_list (const char *title, const ui_item_t *items, uint16_t count, uint32_t select_action_id, uint32_t menu_action_id)
	Show a list view.
int	host_ui_replace_list (const char *title, const ui_item_t *items, uint16_t count, uint32_t select_action_id, uint32_t menu_action_id)
	Replace the plugin's top list view in place; falls back to push when none.
int	host_ui_set_view_footer (const char *hint)
	Override the footer hint of the plugin's current top view.
int	host_ui_set_view_empty (const char *text)
	Override the empty-state text shown by an empty list view.
int	host_ui_set_view_lifecycle (uint32_t hide_action_id, uint32_t show_action_id)
	Register hide/show callbacks for the plugin's current top view.
int	host_ui_update_list_item (uint16_t index, const ui_item_t *item)
	Update one list row in place (partial redraw).
int	host_ui_insert_list_item (uint16_t index, const ui_item_t *item)
	Insert a list row at index (partial redraw).
int	host_ui_remove_list_item (uint16_t index)
	Remove the list row at index (partial redraw).
int	host_ui_push_context_menu (const char *title, const ui_item_t *items, uint16_t count, uint32_t select_action_id)
	Show a context menu.
int	host_ui_push_confirm (const char *text, uint8_t icon, uint32_t action_id)
	Show a Y/N confirmation.
int	host_ui_push_t9_input (const char *title, const char *initial, uint16_t max_len, uint32_t action_id)
	Show a T9-style text entry.
int	host_ui_push_password (const char *title, const char *initial, uint16_t max_len, uint32_t action_id)
	Show a password entry (masked T9).
int	host_ui_push_pin_entry (const char *title, uint8_t max_len, uint8_t max_attempts, uint32_t action_id)
	Show a numeric PIN entry.
int	host_ui_push_slider (const char *title, int32_t min, int32_t max, int32_t init, int32_t step, const char *unit, uint32_t action_id)
	Show an integer slider.
int	host_ui_push_color_picker (uint8_t r, uint8_t g, uint8_t b, uint32_t action_id)
	Show an RGB color picker.
int	host_ui_push_date (const char *title, uint8_t d, uint8_t m, uint16_t y, uint32_t action_id)
	Show a date picker.
int	host_ui_push_time (const char *title, uint8_t h, uint8_t m, uint32_t action_id)
	Show a time-of-day picker.
int	host_ui_acquire_exclusive (void)
	Claim exclusive UI ownership (block other plugins from pushing views).
int	host_ui_release_exclusive (void)
	Release a previously acquired exclusive UI lock.
int	host_ui_set_inactivity (uint32_t timeout_ms, uint32_t action_id)
	Arm an inactivity timer for the plugin's current view.
int	host_ui_consume_input_text (char *out, size_t out_size)
	Read text input committed by the most recent input view.
int	host_ui_consume_input_int (int32_t *out)
	Read integer input committed by the most recent input view.

Detailed Description

extern-C adapter that forwards plugin UI calls to PluginUiState.

Push a view, register a forwarding callback, and the host dispatches plugin_on_action(action_id, ...) to the active plugin when the user acts. All state lives in PluginUiState - this TU only marshals C arguments into method calls on the singleton.

Definition in file host_api_ui_views.cpp.