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

notcurses_input.3: document NCKEY_SIGNAL

Browse Source
This commit is contained in:
nick black 2021-11-17 03:07:47 -05:00
parent 5730925b7d
commit da4efcf905
No known key found for this signature in database
GPG Key ID: 5F43400C21CBFACC
2 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -127,13 +127,22 @@ found in **<notcurses/notcurses.h>**. For more details, consult **terminfo(5)**.
## **NCKEY_RESIZE** ## **NCKEY_RESIZE**
Unless the **SIGWINCH** handler has been inhibited (see **notcurses_init**), Unless the **SIGWINCH** handler has been inhibited (see **notcurses_init**),
notcurses will automatically catch screen resizes, and synthesize an Notcurses will automatically catch screen resizes, and synthesize an
**NCKEY_RESIZE** event. Upon receiving this event, the user may call **NCKEY_RESIZE** event. Upon receiving this event, the user may call
**notcurses_refresh** to force an immediate reflow, or just wait until the **notcurses_refresh** to force an immediate reflow, or just wait until the
next call to **notcurses_render**, when notcurses will pick up the resize next call to **notcurses_render**, when notcurses will pick up the resize
itself. If the **SIGWINCH** handler is inhibited, **NCKEY_RESIZE** is never itself. If the **SIGWINCH** handler is inhibited, **NCKEY_RESIZE** is never
generated. generated.
## **NCKEY_SIGNAL**
Unless the **SIGWINCH** handler has been inhibited (see **notcurses_init**),
Notcurses will catch **SIGCONT**, and synthesize an **NCKEY_SIGNAL** event.
This typically indicates that the program has been restarted after being
paused or placed in the background. The next rasterization will be a full
rebuild of the screen, as if **notcurses_refresh** had been called; the user
might wish to immediately call **notcurses_refresh** themselves.
## **NCKEY_EOF** ## **NCKEY_EOF**
Upon reaching the end of input, **NCKEY_EOF** will be returned. At this point, Upon reaching the end of input, **NCKEY_EOF** will be returned. At this point,

1
src/compat/compat.h
View File

@ -39,6 +39,7 @@ extern "C" {
#define SIGQUIT 0 #define SIGQUIT 0
#define SIGCONT 0 #define SIGCONT 0
#define SIGWINCH 0 #define SIGWINCH 0
#define SIGSTOP 0
#define gettimeofday mingw_gettimeofday #define gettimeofday mingw_gettimeofday
#define sigaddset(x, y) #define sigaddset(x, y)
typedef struct siginfo_t { typedef struct siginfo_t {