NAME¶

tickit_windowctl_name - return the name of a window control

SYNOPSIS¶

#include <tickit.h>

const char * tickit_windowctl_name(TickitWindowCtl ctl);
TickitWindowCtl tickit_windowctl_lookup(const char * name);

TickitType tickit_windowctl_type(TickitWindowCtl ctl);

Link with -ltickit.

DESCRIPTION¶

tickit_windowctl_name() returns the name of the given window control. These names are the lowercase strings given in tickit_window(7).

tickit_windowctl_lookup() returns the control constant for a given name. If the name is not recognised then -1 is returned.

tickit_windowctl_type() returns the type of the given window control, as one of the following constants:

TICKIT_TYPE_BOOL

The value is an integer representing a simple boolean choice, where any nonzero value is true. Use tickit_window_setctl_int(3) and tickit_window_getctl_int(3).

TICKIT_TYPE_INT

The value is an integer representing a quantity, or a value in some particular enumeration. Use tickit_window_setctl_int(3) and tickit_window_getctl_int(3).

For unrecognised control types, the function returns 0.

RETURN VALUE¶

tickit_windowctl_name() returns a constant string pointer. tickit_windowctl_lookup() returns an control constant or -1. tickit_windowctl_type() returns a control type constant or 0.

SEE ALSO¶

tickit_window(7), tickit(7)