blackbeard420/notcurses
1
0
Fork 0
mirror of https://github.com/dankamongmen/notcurses synced 2025-03-09 17:19:03 -04:00
Code Issues Projects Releases Wiki Activity

USAGE/python/man: update ncplane_options #1115

Browse Source
This commit is contained in:
nick black 2020-11-15 03:02:44 -05:00 committed by Nick Black
parent a92e5d97e0
commit 1e6f8e4901
3 changed files with 6 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
USAGE.md
View File

@ -650,10 +650,7 @@ When an `ncplane` is no longer needed, free it with
typedef struct ncplane_options {
int y; // vertical placement relative to parent plane
union {
int x;
ncalign_e align;
} horiz; // horizontal placement relative to parent plane
int x; // horizontal placement relative to parent plane
int rows; // number of rows, must be positive
int cols; // number of columns, must be positive
void* userptr; // user curry, may be NULL

11
doc/man/man3/notcurses_plane.3.md
View File

@ -14,11 +14,8 @@ notcurses_plane - operations on ncplanes
#define NCPLANE_OPTION_HORALIGNED 0x0001ull
typedef struct ncplane_options {
int y; // placement relative to parent plane
union {
int x;
ncalign_e align;
} horiz; // placement relative to parent plane
int y; // vertical placement relative to parent plane
int x; // horizontal placement relative to parent plane
int rows; // number of rows, must be positive
int cols; // number of columns, must be positive
void* userptr; // user curry, may be NULL
@ -259,8 +256,8 @@ plane when scrolling is enabled).
# RETURN VALUES
**ncplane_new**, **ncplane_bound**, **ncplane_aligned**, and **ncplane_dup**
all return a new **struct ncplane** on success, or **NULL** on failure.
**ncplane_create** and **ncplane_dup** return a new **struct ncplane** on
success, or **NULL** on failure.
**ncplane_userptr** returns the configured user pointer for the ncplane, and
cannot fail.

5
python/src/notcurses/build_notcurses.py
View File

@ -75,10 +75,7 @@ typedef enum {
} ncalign_e;
typedef struct ncplane_options {
int y; // vertical placement relative to parent plane
union {
int x;
ncalign_e align;
} horiz; // horizontal placement relative to parent plane
int x; // horizontal placement relative to parent plane
int rows; // number of rows, must be positive
int cols; // number of columns, must be positive
void* userptr; // user curry, may be NULL