notcurses_progbar - high level widget for progress bars
Contents
Bugs
Whether progression is to the left or right by default probably ought be an aspect of the current locale.
Description
These functions draw progress bars in any of four directions. The progress measure is a double between
zero and one, inclusive, provided to ncprogbar_set_progress. This will be scaled to the size of the pro‐
vided ncplane n. The axis of progression is the longer element of the plane's geometry. Horizontal bars
proceed to the right by default, and vertical bars proceed up. This can be changed with NCPROGBAR_OP‐TION_RETROGRADE.
Name
notcurses_progbar - high level widget for progress bars
Notes
ncprogbar_create takes ownership of n in all cases. On failure, n will be destroyed immediately. It is
otherwise destroyed by ncprogbar_destroy.
Return Values
ncprogbar_plane returns the ncplane on which the progress bar is drawn. ncprogbar_progress returns the
current progress, a value between zero and one, inclusive. They cannot fail.
ncprogbar_set_progress returns -1 if p is less than zero or greater than one, or if there is an internal
error redrawing the progress bar. It returns 0 otherwise.
See Also
notcurses(3), notcurses_plane(3), notcurses_visual(3)
Synopsis
#include<notcurses/notcurses.h>
struct ncprogbar;
#define NCPROGBAR_OPTION_RETROGRADE 0x0001u // proceed left/down
typedef struct ncprogbar_options {
uint64_t maxchannels;
uint64_t minchannels;
uint64_t flags;
} ncprogbar_options;
structncprogbar*ncprogbar_create(structncplane*n,constncprogbar_options*opts)structncplane*ncprogbar_plane(structncprogbar*n)intncprogbar_set_progress(structncprogbar*n,doublep)doublencprogbar_progress(conststructncprogbar*n)voidncprogbar_destroy(structncprogbar*n)