2020-02-20 04:00:52 +00:00
|
|
|
% notcurses_reel(3)
|
2020-01-04 07:37:55 +00:00
|
|
|
% nick black <nickblack@linux.com>
|
2020-08-16 14:06:33 +00:00
|
|
|
% v1.6.14
|
2020-01-04 07:37:55 +00:00
|
|
|
|
|
|
|
|
# NAME
|
|
|
|
|
|
2020-02-20 04:00:52 +00:00
|
|
|
notcurses_reel - high-level widget for hierarchical data
|
2020-01-04 07:37:55 +00:00
|
|
|
|
|
|
|
|
# SYNOPSIS
|
|
|
|
|
|
2020-04-19 22:46:32 +00:00
|
|
|
**#include <notcurses/notcurses.h>**
|
2020-01-04 07:37:55 +00:00
|
|
|
|
|
|
|
|
```c
|
2020-05-29 18:53:53 +00:00
|
|
|
#define NCREEL_OPTION_INFINITESCROLL 0x0001
|
|
|
|
|
#define NCREEL_OPTION_CIRCULAR 0x0002
|
2020-05-09 13:19:34 +00:00
|
|
|
|
2020-02-05 22:29:42 +00:00
|
|
|
typedef struct ncreel_options {
|
|
|
|
|
// notcurses can draw a border around the ncreel, and also
|
2020-01-04 07:37:55 +00:00
|
|
|
// around the component tablets. inhibit borders by setting all
|
|
|
|
|
// valid bits in the masks. partially inhibit borders by setting
|
|
|
|
|
// individual bits in the masks. the appropriate attr and pair
|
|
|
|
|
// values will be used to style the borders. focused and
|
|
|
|
|
// non-focused tablets can have different styles. you can instead
|
|
|
|
|
// draw your own borders, or forgo borders entirely.
|
|
|
|
|
unsigned bordermask; // bitfield; 1s will not be drawn
|
2020-02-05 22:29:42 +00:00
|
|
|
uint64_t borderchan; // attributes used for ncreel border
|
2020-01-04 07:37:55 +00:00
|
|
|
unsigned tabletmask; // bitfield for tablet borders
|
|
|
|
|
uint64_t tabletchan; // tablet border styling channel
|
|
|
|
|
uint64_t focusedchan;// focused tablet border styling channel
|
|
|
|
|
uint64_t bgchannel; // background colors
|
2020-05-29 18:53:53 +00:00
|
|
|
unsigned flags; // bitfield over NCREEL_OPTION_*
|
2020-02-05 22:29:42 +00:00
|
|
|
} ncreel_options;
|
2020-01-04 07:37:55 +00:00
|
|
|
```
|
|
|
|
|
|
Tons of work on ncreel (#776)
Tons of work on ncreel (#627, #749, #694)
Improve reel demo: get input wired up once more, avoid the FPS demo at bottom, print pointer and line count in each tablet, use new ncreel API. Improve notcurses-ncreel explorer: kill memory leaks (#694), draw tablets better, use new ncreel API. Fix bug in ncreel core where cruft could be left on the screen, via a very gross brute force algorithm. I'll likely come back and make this a bit less ghastly in the future #749. Remove weird one-off input system from ncreel, residue from outcurses. Make some of the normalizing changes speced out in #627
* ncreel: give each tablet an index, and print it #749
* reel: eliminate FIXME + param to insert_tabler() #749
* ncreel: label tablets with their adress to correlate against debugging logs #749
* more terminal environment variable notes
* TERMS.md: add Sakura, st
* ncreel: move legend out of reel proper
* ncreel_options: dump min/max_supported_rows/cols #627
* ncreel: remove weird one-off input layer #627
* ncreel: add ncreel_offer_input()
* reel demo: call demo_getc()
* reel demo: rig up input to demo main
* ncreel: drop ncreel_del_focused(), properly bind tablets
* reel demo: don't free up necessary plane
* ncreel: don't pull absolute locations of tablets
* ncreel: place tablets correctly in boundrel
* reel demo: add back support for left/right
* reel demo: restore thread movement
* ncreel: remove a great deal of complexity
* reel demo: stay out of FPS graph's way
* ncreel: give each tablet an index, and print it #749
* reel: eliminate FIXME + param to insert_tabler() #749
* ncreel: label tablets with their adress to correlate against debugging logs #749
* ncreel: move legend out of reel proper
* ncreel_options: dump min/max_supported_rows/cols #627
* ncreel: remove weird one-off input layer #627
* ncreel: add ncreel_offer_input()
* reel demo: call demo_getc()
* reel demo: rig up input to demo main
* ncreel: drop ncreel_del_focused(), properly bind tablets
* reel demo: don't free up necessary plane
* ncreel: don't pull absolute locations of tablets
* ncreel: place tablets correctly in boundrel
* reel demo: add back support for left/right
* reel demo: restore thread movement
* ncreel: remove a great deal of complexity
* reel demo: stay out of FPS graph's way
* reel: tighten up reel following redraw
* reel: fix upper-left corner of topless perimeter
* ncreel: print linecount, return clipped value
* reel: draw focused tablet relative to reel
* reel: brute force decruftification, how embarrassing #749
2020-07-09 06:02:23 +00:00
|
|
|
**struct ncreel* ncreel_create(struct ncplane* nc, const ncreel_options* popts);**
|
2020-01-04 07:37:55 +00:00
|
|
|
|
2020-02-05 22:29:42 +00:00
|
|
|
**struct ncplane* ncreel_plane(struct ncreel* nr);**
|
2020-01-04 07:37:55 +00:00
|
|
|
|
2020-08-16 13:06:09 +00:00
|
|
|
**typedef int (*tabletcb)(struct nctablet* t, bool cliptop);**
|
2020-01-04 07:37:55 +00:00
|
|
|
|
2020-02-06 01:04:56 +00:00
|
|
|
**struct nctablet* ncreel_add(struct ncreel* nr, struct nctablet* after, struct nctablet* before, tabletcb cb, void* opaque);**
|
2020-01-04 07:37:55 +00:00
|
|
|
|
2020-02-05 22:29:42 +00:00
|
|
|
**int ncreel_tabletcount(const struct ncreel* nr);**
|
2020-01-04 07:37:55 +00:00
|
|
|
|
2020-02-06 01:04:56 +00:00
|
|
|
**int ncreel_del(struct ncreel* nr, struct nctablet* t);**
|
2020-01-04 07:37:55 +00:00
|
|
|
|
2020-02-05 22:29:42 +00:00
|
|
|
**int ncreel_redraw(struct ncreel* nr);**
|
2020-01-04 07:37:55 +00:00
|
|
|
|
2020-02-06 01:04:56 +00:00
|
|
|
**struct nctablet* ncreel_focused(struct ncreel* nr);**
|
2020-01-04 07:37:55 +00:00
|
|
|
|
2020-02-06 01:04:56 +00:00
|
|
|
**struct nctablet* ncreel_next(struct ncreel* nr);**
|
2020-01-04 07:37:55 +00:00
|
|
|
|
2020-02-06 01:04:56 +00:00
|
|
|
**struct nctablet* ncreel_prev(struct ncreel* nr);**
|
2020-01-04 07:37:55 +00:00
|
|
|
|
2020-02-05 22:29:42 +00:00
|
|
|
**int ncreel_destroy(struct ncreel* nr);**
|
2020-01-04 07:37:55 +00:00
|
|
|
|
2020-02-06 01:04:56 +00:00
|
|
|
**void* nctablet_userptr(struct nctablet* t);**
|
2020-01-04 07:37:55 +00:00
|
|
|
|
2020-02-06 01:04:56 +00:00
|
|
|
**struct ncplane* nctablet_ncplane(struct nctablet* t);**
|
2020-01-04 07:37:55 +00:00
|
|
|
|
|
|
|
|
# DESCRIPTION
|
|
|
|
|
|
|
|
|
|
# RETURN VALUES
|
|
|
|
|
|
|
|
|
|
# SEE ALSO
|
|
|
|
|
|
2020-05-09 00:56:39 +00:00
|
|
|
**notcurses(3)**,
|
|
|
|
|
**notcurses_plane(3)**
|