UiSurface Struct Reference

Opaque structure representing a drawable surface in the UI. More...

#include </usr/local/src/C-Menu/src/ui/ui_ncurses_internal.h>

Collaboration diagram for UiSurface:

Data Fields
int	cols
bool	hidden
PANEL *	pan
struct UiSurface *	parent
int	rows
struct UiRuntime *	runtime
WINDOW *	win
int	x
int	y

Detailed Description

Opaque structure representing a drawable surface in the UI.

Represents a surface in the ncurses UI backend. This structure represents a drawable surface in the ncurses UI, which may correspond to a window or panel. It holds references to the underlying ncurses WINDOW and PANEL, as well as its position, size, and visibility state.

The UiSurface structure represents a drawable area within the UI. It is created using the ui_surface_new function and should be destroyed using ui_surface_destroy to free any associated resources. A UiSurface can be thought of as a canvas on which you can draw text, lines, borders, and other UI elements. Surfaces can be nested, allowing for complex layouts and hierarchies. Each surface has its own position and size, and can be shown or hidden as needed.

See also

ui_surface_new

ui_surface_destroy

Definition at line 43 of file ui_ncurses_internal.h.

Field Documentation

cols

int UiSurface::cols

Definition at line 51 of file ui_ncurses_internal.h.

Referenced by ui_surface_new(), and ui_surface_resize().

hidden

bool UiSurface::hidden

Definition at line 52 of file ui_ncurses_internal.h.

Referenced by ui_surface_hide(), and ui_surface_show().

pan

PANEL* UiSurface::pan

Definition at line 45 of file ui_ncurses_internal.h.

Referenced by ui_surface_destroy(), ui_surface_hide(), ui_surface_move(), ui_surface_new(), and ui_surface_show().

parent

struct UiSurface* UiSurface::parent

Definition at line 47 of file ui_ncurses_internal.h.

Referenced by ui_surface_new().

rows

int UiSurface::rows

Definition at line 50 of file ui_ncurses_internal.h.

Referenced by ui_surface_new(), and ui_surface_resize().

runtime

struct UiRuntime* UiSurface::runtime

Definition at line 46 of file ui_ncurses_internal.h.

Referenced by ui_surface_new().

win

WINDOW* UiSurface::win

Definition at line 44 of file ui_ncurses_internal.h.

Referenced by ui_bkgrnd(), ui_bkgrnd_set(), ui_cursor_move(), ui_draw_border(), ui_draw_box_title(), ui_draw_hline(), ui_draw_text(), ui_draw_text_n(), ui_draw_vline(), ui_get_event(), ui_surface_clear(), ui_surface_destroy(), ui_surface_erase(), ui_surface_new(), ui_surface_resize(), ui_surface_set_base(), and ui_surface_set_style().

x

int UiSurface::x

Definition at line 49 of file ui_ncurses_internal.h.

Referenced by ui_surface_move(), and ui_surface_new().

y

int UiSurface::y

Definition at line 48 of file ui_ncurses_internal.h.

Referenced by ui_surface_move(), and ui_surface_new().

---

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

• ui/ui_ncurses_internal.h