tickit_term_bind_event - Man Page

add or remove event handlers


#include <tickit.h>

typedef int TickitTermEventFn(TickitTerm *tt, TickitEventFlags flags,
    void *info, void *user);

int tickit_term_bind_event(TickitTerm *tt, TickitTermEvent ev,
    TickitBindFlags flags,
    TickitTermEventFn *fn, void *user);
void tickit_term_unbind_event_id(TickitTerm *tt, int id);

Link with -ltickit.


tickit_term_bind_event() adds a new event handler to the list of handlers stored by the terminal, and returns an integer to identify this handler. This handler will be invoked for occurrences of the event given by the ev argument. When invoked, func will be passed the terminal instance, a flags bitmask, a pointer to an event information structure whose type depends on the event, and the user data pointer it was installed with.

tickit_term_unbind_event_id() removes an event handler previously added, by the identifier returned when it was added, invoking it with the TICKIT_EV_UNBIND flag if it was installed with TICKIT_BIND_UNBIND.

Return Value

tickit_term_bind_event() returns an identifier integer. tickit_term_unbind_event_id() returns no value.

See Also

tickit_term_build(3), tickit_term(7), tickit(7)

Referenced By

tickit_term(7), tickit_term_build(3), tickit_term_emit_key(3), tickit_term_get_size(3), tickit_term_input_check_timeout_msec(3), tickit_term_input_push_bytes(3), tickit_term_input_readable(3), tickit_term_input_wait_msec(3), tickit_term_observe_sigwinch(3), tickit_term_open_stdio(3), tickit_term_set_input_fd(3).

The man page tickit_term_unbind_event_id(3) is an alias of tickit_term_bind_event(3).