UiConfig Struct Reference

Structure representing the configuration options for the UI runtime. More...

#include <ui_backend.h>

Collaboration diagram for UiConfig:

Data Fields
char	border_style
bool	cursor_visible
bool	enable_alt_screen
bool	enable_mouse
FILE *	tty_fp
const char *	tty_path

Detailed Description

Structure representing the configuration options for the UI runtime.

The UiConfig structure encapsulates the configuration options that can be set when initializing the UI runtime. This includes enabling mouse support, using an alternate screen buffer, and controlling cursor visibility. The enable_mouse field allows you to specify whether mouse input should be captured and processed by the UI. The enable_alt_screen field determines whether the UI should use an alternate screen buffer, which can help prevent cluttering the main terminal screen. The cursor_visible field controls whether the cursor is visible while the UI is active, which can enhance the user experience in certain applications. The tty_path field, if non-NULL, specifies the terminal device to use; if NULL, the backend auto-detects the terminal (typically via stderr). By configuring these options appropriately, you can tailor the behavior of the UI runtime to suit your application's needs.

See also

ui_init

Definition at line 142 of file ui_backend.h.

Field Documentation

border_style

char UiConfig::border_style

Definition at line 146 of file ui_backend.h.

Referenced by main(), ui_init(), and ui_init().

cursor_visible

bool UiConfig::cursor_visible

Definition at line 145 of file ui_backend.h.

Referenced by main(), ui_init(), and ui_init().

enable_alt_screen

bool UiConfig::enable_alt_screen

Definition at line 144 of file ui_backend.h.

Referenced by main(), ui_init(), and ui_init().

enable_mouse

bool UiConfig::enable_mouse

Definition at line 143 of file ui_backend.h.

Referenced by main(), ui_init(), and ui_init().

tty_fp

FILE* UiConfig::tty_fp

optional TTY FILE pointer; NULL = auto-detect

Definition at line 148 of file ui_backend.h.

tty_path

const char* UiConfig::tty_path

optional TTY device path; NULL = auto-detect

Definition at line 147 of file ui_backend.h.

Referenced by ui_init(), and ui_init().

---

The documentation for this struct was generated from the following file:

• include/ui_backend.h