.TH TICKIT_TERM_SETCTL_INT 3
.SH NAME
tickit_term_setctl_int, tickit_term_setctl_str \- set an integer or string terminal control
.SH SYNOPSIS
.EX
.B #include <tickit.h>
.sp
.BI "bool tickit_term_getctl_int(TickitTerm *" tt ", TickitTermCtl " ctl ", int *" value );
.BI "bool tickit_term_setctl_int(TickitTerm *" tt ", TickitTermCtl " ctl ", int " value );
.BI "bool tickit_term_setctl_str(TickitTerm *" tt ", TickitTermCtl " ctl ", const char *" value );
.EE
.sp
Link with \fI\-ltickit\fP.
.SH DESCRIPTION
\fBtickit_term_setctl_int\fP() performs a terminal control operation, setting the value of a numeric terminal control option. \fBtickit_term_setctl_str\fP() sets the value of a string terminal control option. \fBtickit_term_getctl_int\fP() obtains the value of a terminal control setting.
.PP
The options are given in an enumeration called \fBTickitTermCtl\fP. The following control values are recognised:
.in
.TP
.B TICKIT_TERMCTL_ALTSCREEN (int)
The value is a boolean indicating whether the terminal alternate buffer mode should be enabled. When enabled, a temporary buffer is used for drawing, preserving the original contents of the screen. This mode is usually used by full-screen applications to preserve the shell's scrollback state.
.TP
.B TICKIT_TERMCTL_CURSORVIS (int)
The value is a boolean indicating whether the terminal text cursor should be visible. When disabled the cursor position is not visible. Typically applications will hide the cursor while performing redrawing operations so as not to show a flickering effect as the cursor moves, and show it again when drawing is complete.
.TP
.B TICKIT_TERMCTL_CURSORBLINK (int)
The value is a boolean indicating whether the terminal text cursor should blink. When disabled, the cursor will appear in a steady state, if visible. When enabled, the cursor will appear blinking, if visible. If the cursor is invisible, this should not have any effect.
.TP
.B TICKIT_TERMCTL_CURSORSHAPE (int)
The value is an integer from the \fBTickitCursorShape\fP enumeration indicating what shape the terminal's text cursor should be. Values are \fBTICKIT_CURSORSHAPE_BLOCK\fP for a solid block filling the entire cell, \fBTICKIT_CURSORSHAPE_UNDER\fP for an underline below the character, or \fBTICKIT_CURSORSHAPE_LEFT_BAR\fP for a vertical bar to the left of the character. Note that not all terminals support setting it, nor to all of the possible values.
.TP
.B TICKIT_TERMCTL_ICON_TEXT (str)
The value is a string for the terminal to use as its minimised icon text.
.TP
.B TICKIT_TERMCTL_ICONTITLE_TEXT (str)
The value is a string for the terminal to use as its minimised icon text and main window title.
.TP
.B TICKIT_TERMCTL_KEYPAD_APP (int)
The value is a boolean controlling the terminal's keypad mode. When enabled, the terminal is in keypad application mode; in this mode the numerical keypad will send different sequences that can be detected as distinct from regular
.SM ASCII
text. When disabled, the keypad will send normal text.
.TP
.B TICKIT_TERMCTL_MOUSE (int)
The value is an integer from the \fBTickitTermMouseMode\fP enumeration indicating what mouse events should be sent. Values are \fBTICKIT_TERM_MOUSEMODE_CLICK\fP to report button press and release events, \fBTICKIT_TERM_MOUSEMODE_DRAG\fP to additionally report movement while a button is held, \fBTICKIT_TERM_MOUSEMODE_MOVE\fP to additionally report all movement even with no buttons held, or \fBTICKIT_TERM_MOUSEMODE_OFF\fP to disable it.
.TP
.B TICKIT_TERMCTL_TITLE_TEXT (str)
The value is a string for the terminal to use as its main window title.
.TP
.B TICKIT_TERMCTL_COLORS (int, read-only)
The value indicates how many colors are available. This value is read-only; it can be requested but not set.
.SH "RETURN VALUE"
\fBtickit_term_getctl_int\fP() returns a true value if it recognised the requested control and managed to return the current value of it; false if not. \fBtickit_term_setctl_int\fP() and \fBtickit_term_setctl_str\fP() return a true value if it recognised the requested control and managed to request the terminal to change it; false if not.
.SH "SEE ALSO"
.BR tickit_term_new (3),
.BR tickit_term (7),
.BR tickit (7)