Archives/notcurses
2
0
Fork 0
mirror of https://github.com/dankamongmen/notcurses.git synced 2024-11-02 09:40:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

nctree API cut 1 #1164

Browse Source
This commit is contained in:
nick black 2021-02-12 00:09:00 -05:00 committed by Nick Black
parent e88875c4a7
commit 2348546932
1 changed files with 35 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
include/notcurses/notcurses.h
View File

@ -2662,7 +2662,7 @@ API ALLOC struct ncreel* ncreel_create(struct ncplane* n, const ncreel_options*
__attribute__ ((nonnull (1))); __attribute__ ((nonnull (1)));
// Returns the ncplane on which this ncreel lives. // Returns the ncplane on which this ncreel lives.
API struct ncplane* ncreel_plane(struct ncreel* pr) API struct ncplane* ncreel_plane(struct ncreel* nr)
__attribute__ ((nonnull (1))); __attribute__ ((nonnull (1)));
// Tablet draw callback, provided a tablet (from which the ncplane and userptr // Tablet draw callback, provided a tablet (from which the ncplane and userptr
@ -3022,6 +3022,40 @@ typedef struct nctree_options {
API ALLOC struct nctree* nctree_create(struct ncplane* n, const nctree_options* opts) API ALLOC struct nctree* nctree_create(struct ncplane* n, const nctree_options* opts)
__attribute__ ((nonnull (1))); __attribute__ ((nonnull (1)));
// Returns the ncplane on which this nctree lives.
API struct ncplane* nctree_plane(struct nctree* n)
__attribute__ ((nonnull (1)));
// Redraw the nctree 'n' in its entirety. The tree will be cleared, and items
// will be lain out, using the focused item as a fulcrum. Item-drawing
// callbacks will be invoked for each visible item.
API int nctree_redraw(struct nctree* n)
__attribute__ ((nonnull (1)));
// Offer input 'ni' to the nctree 'n'. If it's relevant, this function returns
// true, and the input ought not be processed further. If it's irrelevant to
// the tree, false is returned. Relevant inputs include:
// * a mouse click on an item (focuses item)
// * a mouse scrollwheel event (srolls tree)
// * up, down, pgup, or pgdown (navigates among items)
API bool nctree_offer_input(struct nctree* n, const struct ncinput* ni)
__attribute__ ((nonnull (1)));
/*
// Return the focused item, if any items are present. This is not a copy;
// be careful to use it only for the duration of a critical section.
API struct nctablet* nctree_focused(struct nctree* n)
__attribute__ ((nonnull (1)));
// Change focus to the next item, if one exists
API struct nctablet* nctree_next(struct nctree* n)
__attribute__ ((nonnull (1)));
// Change focus to the previous item, if one exists
API struct nctablet* nctree_prev(struct nctree* n)
__attribute__ ((nonnull (1)));
*/
// Destroy the nctree. // Destroy the nctree.
API void nctree_destroy(struct nctree* n); API void nctree_destroy(struct nctree* n);