UI Backend

Backend API for terminal UI library. More...

Files
file	ui_backend.h
	Backend API for terminal UI library.
file	ui_layout.h
	UI layout management.
file	ui_ncurses_internal.h
	Internal header for ncurses UI backend. This header defines internal structures and functions used by the ncurses implementation of the UI backend. It should not be included directly by external code.
file	ui_theme.h
	UI theme definitions.

Data Structures
struct	UiColor
	Structure representing a color in the UI. More...
struct	UiConfig
	Structure representing the configuration options for the UI runtime. More...
struct	UiEvent
	Structure representing an input event in the UI. More...
struct	UiFramedSurface
struct	UiRect
	Structure representing a rectangular area in the UI. More...
struct	UiRuntime
	Opaque structure representing the UI runtime environment. More...
struct	UiStyle
	Structure representing the style attributes for UI elements. More...
struct	UiSurface
	Opaque structure representing a drawable surface in the UI. More...

Enumerations
enum	UiBorderKind { UI_BORDER_NONE = 0 , UI_BORDER_ASCII , UI_BORDER_LIGHT , UI_BORDER_ROUNDED }
	Enumeration of possible border styles for UI surfaces. More...
enum	UiKey {   UI_KEY_NONE = 0 , UI_KEY_CHAR , UI_KEY_ENTER , UI_KEY_ESCAPE ,   UI_KEY_BACKSPACE , UI_KEY_TAB , UI_KEY_BTAB , UI_KEY_UP ,   UI_KEY_DOWN , UI_KEY_LEFT , UI_KEY_RIGHT , UI_KEY_HOME ,   UI_KEY_END , UI_KEY_PGUP , UI_KEY_PGDN , UI_KEY_INSERT ,   UI_KEY_DELETE , UI_KEY_RESIZE , UI_KEY_MOUSE , UI_KEY_F1 ,   UI_KEY_F2 , UI_KEY_F3 , UI_KEY_F4 , UI_KEY_F5 ,   UI_KEY_F6 , UI_KEY_F7 , UI_KEY_F8 , UI_KEY_F9 ,   UI_KEY_F10 , UI_KEY_F11 , UI_KEY_F12 }
	Enumeration of possible key events in the UI. More...
enum	UiMouseAction {   UI_MOUSE_NONE = 0 , UI_MOUSE_PRESS , UI_MOUSE_RELEASE , UI_MOUSE_DRAG ,   UI_MOUSE_SCROLL_UP , UI_MOUSE_SCROLL_DOWN }
	Enumeration of possible mouse actions in the UI. More...
enum	UiRole {   UI_ROLE_DEFAULT = 0 , UI_ROLE_NORMAL , UI_ROLE_NORMAL_REVERSE , UI_ROLE_NORMAL_HIGHLIGHT ,   UI_ROLE_NORMAL_HIGHLIGHT_REVERSE , UI_ROLE_BOX , UI_ROLE_TITLE , UI_ROLE_LINENO ,   UI_ROLE_CMDLINE , UI_ROLE_BOLD , UI_ROLE_FILL , UI_ROLE_BRACKET }
	UI role definitions.These are used to identify the purpose of a UI element, and can be used to apply different styles to different elements. The default theme will use these roles to apply different colors and styles to different elements. More...

Functions
void	ui_framed_surface_destroy (UiFramedSurface *fs)
	Destroys a framed surface and releases its resources.
UiFramedSurface	ui_framed_surface_new (UiRuntime *ui, UiSurface *parent, UiRect rect)
	Creates a new framed surface with the specified parent and rectangle.
const UiStyle *	ui_theme_style (const UiTheme *theme, UiRole role)
	Get the style for a given UI role.

Detailed Description

Backend API for terminal UI library.

This module defines the API for implementing a backend for the terminal UI library. It includes types and functions for managing the UI runtime, surfaces, drawing operations, input handling, and cursor control.

The backend is responsible for rendering the UI to the terminal, handling user input events, and managing the lifecycle of the UI runtime and surfaces.

To implement a backend, you need to define the functions declared in this header file according to the specifications provided in the function comments.

See also

ui_backend.h

Enumeration Type Documentation

UiBorderKind

enum UiBorderKind

Enumeration of possible border styles for UI surfaces.

The UiBorderKind enumeration defines the various border styles that can be applied to UI surfaces. This includes no border, ASCII borders, light borders, and rounded borders. Each border style is represented by a unique value in the enumeration, allowing for easy selection and application of borders when drawing UI elements. The chosen border style will affect the appearance of the surface's edges when rendered.

See also

ui_draw_border

Enumerator
UI_BORDER_NONE
UI_BORDER_ASCII
UI_BORDER_LIGHT
UI_BORDER_ROUNDED

Definition at line 115 of file ui_backend.h.

             {
    UI_BORDER_NONE = 0,
    UI_BORDER_ASCII,
    UI_BORDER_LIGHT,
    UI_BORDER_ROUNDED
} UiBorderKind;

UiKey

enum UiKey

Enumeration of possible key events in the UI.

The UiKey enumeration defines the various key events that can be captured in the UI. This includes character input, special keys (like Enter, Escape, Arrow keys), function keys (F1-F12), and mouse events. Each key event is represented by a unique value in the enumeration, allowing for easy identification and handling of user input. When a key event occurs, it is captured in a UiEvent structure, which includes additional information such as modifier keys (Alt, Ctrl, Shift) and mouse actions.

See also

UiEvent

Enumerator
UI_KEY_NONE
UI_KEY_CHAR
UI_KEY_ENTER
UI_KEY_ESCAPE
UI_KEY_BACKSPACE
UI_KEY_TAB
UI_KEY_BTAB
UI_KEY_UP
UI_KEY_DOWN
UI_KEY_LEFT
UI_KEY_RIGHT
UI_KEY_HOME
UI_KEY_END
UI_KEY_PGUP
UI_KEY_PGDN
UI_KEY_INSERT
UI_KEY_DELETE
UI_KEY_RESIZE
UI_KEY_MOUSE
UI_KEY_F1
UI_KEY_F2
UI_KEY_F3
UI_KEY_F4
UI_KEY_F5
UI_KEY_F6
UI_KEY_F7
UI_KEY_F8
UI_KEY_F9
UI_KEY_F10
UI_KEY_F11
UI_KEY_F12

Definition at line 58 of file ui_backend.h.

             {
    UI_KEY_NONE = 0,
    UI_KEY_CHAR,
    UI_KEY_ENTER,
    UI_KEY_ESCAPE,
    UI_KEY_BACKSPACE,
    UI_KEY_TAB,
    UI_KEY_BTAB,
    UI_KEY_UP,
    UI_KEY_DOWN,
    UI_KEY_LEFT,
    UI_KEY_RIGHT,
    UI_KEY_HOME,
    UI_KEY_END,
    UI_KEY_PGUP,
    UI_KEY_PGDN,
    UI_KEY_INSERT,
    UI_KEY_DELETE,
    UI_KEY_RESIZE,
    UI_KEY_MOUSE,
    UI_KEY_F1,
    UI_KEY_F2,
    UI_KEY_F3,
    UI_KEY_F4,
    UI_KEY_F5,
    UI_KEY_F6,
    UI_KEY_F7,
    UI_KEY_F8,
    UI_KEY_F9,
    UI_KEY_F10,
    UI_KEY_F11,
    UI_KEY_F12
} UiKey;

UiMouseAction

enum UiMouseAction

Enumeration of possible mouse actions in the UI.

The UiMouseAction enumeration defines the various mouse actions that can be captured in the UI. This includes mouse button presses, releases, drags, and scroll events. Each mouse action is represented by a unique value in the enumeration, allowing for easy identification and handling of mouse input. When a mouse event occurs, it is captured in a UiEvent structure, which includes additional information such as the position of the mouse and any modifier keys (Alt, Ctrl, Shift) that were active at the time of the event.

See also

UiEvent

Enumerator
UI_MOUSE_NONE
UI_MOUSE_PRESS
UI_MOUSE_RELEASE
UI_MOUSE_DRAG
UI_MOUSE_SCROLL_UP
UI_MOUSE_SCROLL_DOWN

Definition at line 99 of file ui_backend.h.

             {
    UI_MOUSE_NONE = 0,
    UI_MOUSE_PRESS,
    UI_MOUSE_RELEASE,
    UI_MOUSE_DRAG,
    UI_MOUSE_SCROLL_UP,
    UI_MOUSE_SCROLL_DOWN
} UiMouseAction;

UiRole

enum UiRole

UI role definitions.These are used to identify the purpose of a UI element, and can be used to apply different styles to different elements. The default theme will use these roles to apply different colors and styles to different elements.

Enumerator
UI_ROLE_DEFAULT
UI_ROLE_NORMAL
UI_ROLE_NORMAL_REVERSE
UI_ROLE_NORMAL_HIGHLIGHT
UI_ROLE_NORMAL_HIGHLIGHT_REVERSE
UI_ROLE_BOX
UI_ROLE_TITLE
UI_ROLE_LINENO
UI_ROLE_CMDLINE
UI_ROLE_BOLD
UI_ROLE_FILL
UI_ROLE_BRACKET

Definition at line 16 of file ui_theme.h.

             {
    UI_ROLE_DEFAULT = 0,
    UI_ROLE_NORMAL,
    UI_ROLE_NORMAL_REVERSE,
    UI_ROLE_NORMAL_HIGHLIGHT,
    UI_ROLE_NORMAL_HIGHLIGHT_REVERSE,
    UI_ROLE_BOX,
    UI_ROLE_TITLE,
    UI_ROLE_LINENO,
    UI_ROLE_CMDLINE,
    UI_ROLE_BOLD,
    UI_ROLE_FILL,
    UI_ROLE_BRACKET
} UiRole;

Function Documentation

ui_framed_surface_destroy()

void ui_framed_surface_destroy

(

UiFramedSurface *

fs

)

Destroys a framed surface and releases its resources.

Parameters

fs	The UiFramedSurface to destroy.

ui_framed_surface_new()

UiFramedSurface ui_framed_surface_new	(	UiRuntime *	ui,
		UiSurface *	parent,
		UiRect	rect )

Creates a new framed surface with the specified parent and rectangle.

Parameters

ui	The UI runtime context.
parent	The parent surface to which the framed surface will be attached.
rect	The rectangle defining the position and size of the framed surface.

Returns

A new UiFramedSurface instance, or NULL on failure.

ui_theme_style()

const UiStyle * ui_theme_style	(	const UiTheme *	theme,
		UiRole	role )

Get the style for a given UI role.

Parameters

theme	The UI theme to get the style from.
role	The UI role to get the style for.

Returns

The style for the given UI role.