Package libtermkey-devel

Development files needed for libtermkey

http://www.leonerd.org.uk/code/libtermkey/

Library Functions (Section 3)
termkey_advisereadable
termkey_advisereadable() informs the termkey(7) instance that new input may be available on the underlying file descriptor and so it should call read(2) to...
termkey_canonicalise
termkey_canonicalise(3) modifies the key event structure given by key according to the canonicalisation flags set on the given termkey instance. This operation...
termkey_get_buffer_remaining
termkey_get_buffer_remaining() returns the number of bytes of buffer space currently free in the termkey(7) instance. These bytes are free to use by...
termkey_get_fd
termkey_get_fd() returns the file descriptor that the termkey(7) instance is using to read bytes from.
termkey_getkey
termkey_getkey() attempts to retrieve a single keypress event from the termkey(7) instance buffer, and put it in the structure referred to by key.
termkey_get_keyname
termkey_get_keyname() returns a human-readable string name for the symbolic key value given by sym. The returned string is owned by the termkey(7) instance tk...
termkey_interpret_csi
termkey_interpret_csi() fills in variables in the passed pointers according to the unrecognised CSI sequence event found in key. It should be called if...
termkey_interpret_modereport
termkey_interpret_modereport() fills in variables in the passed pointers according to the mode report event found in key. It should be called if...
termkey_interpret_mouse
termkey_interpret_mouse() fills in variables in the passed pointers according to the mouse event found in key. It should be called if termkey_getkey(3) or...
termkey_interpret_position
termkey_interpret_position() fills in variables in the passed pointers according to the cursor position report event found in key. It should be called if...
termkey_keycmp
termkey_keycmp() compares two key structures and applies a total ordering, returning a value that is negative, zero, or positive, to indicate if the given...
termkey_keyname2sym
termkey_keyname2sym() looks up the symbolic key value represented by the given string name. This is a case-sensitive comparison. If the given name is not found...
termkey_lookup_keyname
termkey_lookup_keyname() looks up the symbolic key value represented by the given string name. This is a case-sensitive comparison. The symbolic value is...
termkey_new
termkey_new() creates a new termkey(7) instance connected to the file handle opened by fd using the flags. The TermKey structure should be considered opaque...
termkey_push_bytes
termkey_push_bytes() allows more bytes of input to be supplied directly into the input buffer of the termkey(7) instance. If there was no buffer space remaining...
termkey_set_buffer_size
termkey_set_buffer_size() changes the size of the buffer space in the termkey(7) instance to that given by size. Any bytes pending in the buffer will be...
termkey_set_canonflags
termkey_set_canonflags() changes the set of canonicalisation flags in the termkey(7) instance to those given by newflags. For detail on the available flags and...
termkey_set_flags
termkey_set_flags() changes the set of operation flags in the termkey(7) instance to those given by newflags. termkey_get_flags() returns the value set by the...
termkey_set_waittime
termkey_set_waittime() sets the number of miliseconds that termkey_waitkey(3) will wait for the remaining bytes of a multibyte sequence if it detects the start...
termkey_start
termkey_start() enables the terminal IO operations of the given termkey(7) instance, including sending a terminal control sequence and setting the termios(3)...
termkey_strfkey
termkey_strfkey() formats a string buffer to contain a human-readable representation of a key event. It fills the buffer in a way analogous to the snprintf(3)...
termkey_strpkey
termkey_strpkey(3) parses a string buffer containing a human-readable representation of a key event. It fills the key structure from the results of this...
termkey_waitkey
termkey_waitkey() attempts to retrieve a single keypress event from the termkey(7) instance buffer, and put it in the structure referred to by key. If...
Miscellanea (Section 7)
termkey
termkey is a library that allows programs to read and interpret keypress and other events from a terminal. It understands encoding schemes used by terminals to...