#include <cm.h>

Collaboration diagram for Chyron:

Data Fields
UiCell	cmplx_buf [MAXLEN]
ChyronKey *	key [CHYRON_KEYS]
uint	l
char	s [MAXLEN]
UiSurface *	sfc
uint	win
uint	y

Detailed Description

The Chyron structure represents a key binding for a command in the chyron, which is a status line or message area in the terminal interface. The ChyronKey structure includes fields for displayable text, the key code, and the end position of the command text in the chyron. This structure allows xwgetch to map mouse clicks to key codes as defined by NCursesw and the C-Menu program. The text field holds the displayable text associated with the command. xwgetch() translates a mouse click on the chyron with a particular key code stored in this table. The use case is when the developer wants a dynamic chyron that can be easily changed depending on the context of the program without having to worry about translating mouse click positions to key codes. While many key codes are defined by NCursesw, the developer is free to define their own key codes for custom commands in the chyron. However, xwgetch() will translate mouse clicks to the key codes defined in this table, even if they interfere with standard NCurses key codes, Unicode code points, or ASCII characters. Just use common sense. In addition to returning the key code associated with mouse clicks on the chyron, xwgetch() also returns the key codes for standard keyboard input, and sets the global variables cliek_y and click_x to the coordinates of the mouse click.

Definition at line 386 of file cm.h.