ui_ncurses_compat.h File Reference

Non-portable escape hatch for the NCurses backend. More...

#include "ui_backend.h"
#include <ncursesw/ncurses.h>
#include <ncursesw/panel.h>

Include dependency graph for ui_ncurses_compat.h:

Go to the source code of this file.

Functions
PANEL *	ui_ncurses_surface_get_panel (const UiSurface *s, uint w)
	Return the raw NCurses PANEL* underlying a surface.
WINDOW *	ui_ncurses_surface_get_win (const UiSurface *s, uint w)
	Return the raw NCurses WINDOW* underlying a surface.

Detailed Description

Non-portable escape hatch for the NCurses backend.

Warning

Including this header couples application code to the NCurses backend. Use only when NCurses-specific functionality is required and portability to other backends (e.g., NotCurses) is not needed. These functions are intentionally not declared in ui_backend.h.

Definition in file ui_ncurses_compat.h.

Function Documentation

ui_ncurses_surface_get_panel()

PANEL * ui_ncurses_surface_get_panel	(	const UiSurface *	s,
		uint	w )

Return the raw NCurses PANEL* underlying a surface.

Parameters

s	The UiSurface to inspect.
w	UiSurface window

Returns

The PANEL pointer, or NULL if s is NULL.

Definition at line 833 of file ui_ncurses.c.

                                                                {
    if (!s)
        return NULL;
    return s->mpan[w];
}

ui_ncurses_surface_get_win()

WINDOW * ui_ncurses_surface_get_win	(	const UiSurface *	s,
		uint	w )

Return the raw NCurses WINDOW* underlying a surface.

Parameters

s	The UiSurface to inspect.

Returns

The WINDOW pointer, or NULL if s is NULL.

Definition at line 827 of file ui_ncurses.c.

                                                               {
    if (!s)
        return NULL;
    return s->mwin[w];
}