Ui Backend

Collaboration diagram for Ui Backend:

Topics
	Ui_ncurses
	NCurses UI backend — lifecycle, surface management, and capabilities.

Files
file	ui_backend.h
	Backend API for terminal UI library.
file	ui_conformance_test.c
	Compile-time and smoke-test conformance test for the UALUI API.
file	ui_layout.c
	Backend-agnostic layout helpers.
file	ui_layout.h
	UI layout management.

Data Structures
struct	UiFramedSurface

Functions
void	ui_framed_surface_destroy (UiFramedSurface *fs)
	Destroys a framed surface and releases its resources.
UiFramedSurface	ui_framed_surface_new (UiSurface *parent, UiRect rect)
	Creates a new framed surface with the specified parent and rectangle.

Detailed Description

Function Documentation

ui_framed_surface_destroy()

void ui_framed_surface_destroy

(

UiFramedSurface *

fs

)

Destroys a framed surface and releases its resources.

Destroy a framed surface and release its resources.

Parameters

fs	The UiFramedSurface to destroy.
fs	Pointer to the UiFramedSurface to destroy.

Destroys a framed surface and releases its resources.

Parameters

fs	Pointer to the UiFramedSurface to destroy.

Definition at line 54 of file ui_layout.c.

                                                    {
    if (!fs)
        return;
    /* Destroy inner before outer (child before parent). */
    if (fs->inner)
        ui_surface_destroy(fs->inner);
    if (fs->outer)
        ui_surface_destroy(fs->outer);
    fs->inner = NULL;
    fs->outer = NULL;
}

References UiFramedSurface::inner, UiFramedSurface::outer, and ui_surface_destroy().

Here is the call graph for this function:

ui_framed_surface_new()

UiFramedSurface ui_framed_surface_new	(	UiSurface *	parent,
		UiRect	rect )

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

Create a framed surface (outer border + inner content area).

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.

The returned UiFramedSurface.outer is the frame panel; .inner is one row and one column smaller on each side (the drawable content area). The caller is responsible for destroying the framed surface with ui_framed_surface_destroy() when it is no longer needed.

Parameters

ui	The UiRuntime context.
parent	Parent surface, or NULL to make the frame a top-level panel.
rect	Position and size of the outer frame (including the border).

Returns

A UiFramedSurface; both fields are NULL on failure.

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

The returned UiFramedSurface.outer is the frame panel; .inner is one row and one column smaller on each side (the drawable content area). The caller is responsible for destroying the framed surface with ui_framed_surface_destroy() when it is no longer needed.

Parameters

ui	The UiRuntime context.
parent	Parent surface, or NULL to make the frame a top-level panel.
rect	Position and size of the outer frame (including the border).

Returns

A UiFramedSurface; both fields are NULL on failure.

Definition at line 26 of file ui_layout.c.

                                                                      {
    int w = 0;
    UiFramedSurface fs = {NULL, NULL};
 
    if (!ui || rect.lines < 3 || rect.cols < 3)
        return fs;
 
    // char title[64] = {};
    fs.outer = ui_surface_new(w, parent, 0, rect.lines, rect.cols, rect.y, rect.x);
    if (!fs.outer)
        return fs;
 
    rect.y = 1,
    rect.x = 1,
    rect.lines = rect.lines - 2,
    rect.cols = rect.cols - 2,
    fs.inner = ui_surface_new(w, fs.outer, 0, rect.lines, rect.cols, rect.y, rect.x);
    if (!fs.inner) {
        ui_surface_destroy(fs.outer);
        fs.outer = NULL;
    }
 
    return fs;
}

References UiRect::cols, UiFramedSurface::inner, UiRect::lines, UiFramedSurface::outer, ui, ui_surface_destroy(), ui_surface_new(), UiRect::x, and UiRect::y.

Here is the call graph for this function: