.TH "caca_attr" 3caca "Mon Mar 25 2024 04:02:10" "Version 0.99.beta20" "libcaca" \" -*- nroff -*-
.ad l
.nh
.SH NAME
caca_attr \- libcaca attribute definitions
.SH SYNOPSIS
.br
.PP
.SS "Modules"

.in +1c
.ti -1c
.RI "\fBlibcaca basic functions\fP"
.br
.in -1c
.SS "Data Structures"

.in +1c
.ti -1c
.RI "struct \fBcaca_event\fP"
.br
.RI "Handling of user events\&. "
.ti -1c
.RI "struct \fBcaca_option\fP"
.br
.RI "Option parsing\&. "
.in -1c
.SS "Enumerations"

.in +1c
.ti -1c
.RI "enum \fBcaca_color\fP { \fBCACA_BLACK\fP = 0x00, \fBCACA_BLUE\fP = 0x01, \fBCACA_GREEN\fP = 0x02, \fBCACA_CYAN\fP = 0x03, \fBCACA_RED\fP = 0x04, \fBCACA_MAGENTA\fP = 0x05, \fBCACA_BROWN\fP = 0x06, \fBCACA_LIGHTGRAY\fP = 0x07, \fBCACA_DARKGRAY\fP = 0x08, \fBCACA_LIGHTBLUE\fP = 0x09, \fBCACA_LIGHTGREEN\fP = 0x0a, \fBCACA_LIGHTCYAN\fP = 0x0b, \fBCACA_LIGHTRED\fP = 0x0c, \fBCACA_LIGHTMAGENTA\fP = 0x0d, \fBCACA_YELLOW\fP = 0x0e, \fBCACA_WHITE\fP = 0x0f, \fBCACA_DEFAULT\fP = 0x10, \fBCACA_TRANSPARENT\fP = 0x20 }"
.br
.ti -1c
.RI "enum \fBcaca_style\fP { \fBCACA_BOLD\fP = 0x01, \fBCACA_ITALICS\fP = 0x02, \fBCACA_UNDERLINE\fP = 0x04, \fBCACA_BLINK\fP = 0x08 }"
.br
.ti -1c
.RI "enum \fBcaca_event_type\fP { \fBCACA_EVENT_NONE\fP = 0x0000, \fBCACA_EVENT_KEY_PRESS\fP = 0x0001, \fBCACA_EVENT_KEY_RELEASE\fP = 0x0002, \fBCACA_EVENT_MOUSE_PRESS\fP = 0x0004, \fBCACA_EVENT_MOUSE_RELEASE\fP = 0x0008, \fBCACA_EVENT_MOUSE_MOTION\fP = 0x0010, \fBCACA_EVENT_RESIZE\fP = 0x0020, \fBCACA_EVENT_QUIT\fP = 0x0040, \fBCACA_EVENT_ANY\fP = 0xffff }"
.br
.RI "User event type enumeration\&. "
.ti -1c
.RI "enum \fBcaca_key\fP { \fBCACA_KEY_UNKNOWN\fP = 0x00, \fBCACA_KEY_CTRL_A\fP = 0x01, \fBCACA_KEY_CTRL_B\fP = 0x02, \fBCACA_KEY_CTRL_C\fP = 0x03, \fBCACA_KEY_CTRL_D\fP = 0x04, \fBCACA_KEY_CTRL_E\fP = 0x05, \fBCACA_KEY_CTRL_F\fP = 0x06, \fBCACA_KEY_CTRL_G\fP = 0x07, \fBCACA_KEY_BACKSPACE\fP = 0x08, \fBCACA_KEY_TAB\fP = 0x09, \fBCACA_KEY_CTRL_J\fP = 0x0a, \fBCACA_KEY_CTRL_K\fP = 0x0b, \fBCACA_KEY_CTRL_L\fP = 0x0c, \fBCACA_KEY_RETURN\fP = 0x0d, \fBCACA_KEY_CTRL_N\fP = 0x0e, \fBCACA_KEY_CTRL_O\fP = 0x0f, \fBCACA_KEY_CTRL_P\fP = 0x10, \fBCACA_KEY_CTRL_Q\fP = 0x11, \fBCACA_KEY_CTRL_R\fP = 0x12, \fBCACA_KEY_PAUSE\fP = 0x13, \fBCACA_KEY_CTRL_T\fP = 0x14, \fBCACA_KEY_CTRL_U\fP = 0x15, \fBCACA_KEY_CTRL_V\fP = 0x16, \fBCACA_KEY_CTRL_W\fP = 0x17, \fBCACA_KEY_CTRL_X\fP = 0x18, \fBCACA_KEY_CTRL_Y\fP = 0x19, \fBCACA_KEY_CTRL_Z\fP = 0x1a, \fBCACA_KEY_ESCAPE\fP = 0x1b, \fBCACA_KEY_DELETE\fP = 0x7f, \fBCACA_KEY_UP\fP = 0x111, \fBCACA_KEY_DOWN\fP = 0x112, \fBCACA_KEY_LEFT\fP = 0x113, \fBCACA_KEY_RIGHT\fP = 0x114, \fBCACA_KEY_INSERT\fP = 0x115, \fBCACA_KEY_HOME\fP = 0x116, \fBCACA_KEY_END\fP = 0x117, \fBCACA_KEY_PAGEUP\fP = 0x118, \fBCACA_KEY_PAGEDOWN\fP = 0x119, \fBCACA_KEY_F1\fP = 0x11a, \fBCACA_KEY_F2\fP = 0x11b, \fBCACA_KEY_F3\fP = 0x11c, \fBCACA_KEY_F4\fP = 0x11d, \fBCACA_KEY_F5\fP = 0x11e, \fBCACA_KEY_F6\fP = 0x11f, \fBCACA_KEY_F7\fP = 0x120, \fBCACA_KEY_F8\fP = 0x121, \fBCACA_KEY_F9\fP = 0x122, \fBCACA_KEY_F10\fP = 0x123, \fBCACA_KEY_F11\fP = 0x124, \fBCACA_KEY_F12\fP = 0x125, \fBCACA_KEY_F13\fP = 0x126, \fBCACA_KEY_F14\fP = 0x127, \fBCACA_KEY_F15\fP = 0x128 }"
.br
.RI "Special key values\&. "
.in -1c
.SH "Detailed Description"
.PP 
Colours and styles that can be used with \fBcaca_set_attr()\fP\&. 
.SH "Enumeration Type Documentation"
.PP 
.SS "enum \fBcaca_color\fP"
\fIlibcaca\fP colour keyword 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fICACA_BLACK \fP\fP
The colour index for black\&. 
.TP
\fB\fICACA_BLUE \fP\fP
The colour index for blue\&. 
.TP
\fB\fICACA_GREEN \fP\fP
The colour index for green\&. 
.TP
\fB\fICACA_CYAN \fP\fP
The colour index for cyan\&. 
.TP
\fB\fICACA_RED \fP\fP
The colour index for red\&. 
.TP
\fB\fICACA_MAGENTA \fP\fP
The colour index for magenta\&. 
.TP
\fB\fICACA_BROWN \fP\fP
The colour index for brown\&. 
.TP
\fB\fICACA_LIGHTGRAY \fP\fP
The colour index for light gray\&. 
.TP
\fB\fICACA_DARKGRAY \fP\fP
The colour index for dark gray\&. 
.TP
\fB\fICACA_LIGHTBLUE \fP\fP
The colour index for blue\&. 
.TP
\fB\fICACA_LIGHTGREEN \fP\fP
The colour index for light green\&. 
.TP
\fB\fICACA_LIGHTCYAN \fP\fP
The colour index for light cyan\&. 
.TP
\fB\fICACA_LIGHTRED \fP\fP
The colour index for light red\&. 
.TP
\fB\fICACA_LIGHTMAGENTA \fP\fP
The colour index for light magenta\&. 
.TP
\fB\fICACA_YELLOW \fP\fP
The colour index for yellow\&. 
.TP
\fB\fICACA_WHITE \fP\fP
The colour index for white\&. 
.TP
\fB\fICACA_DEFAULT \fP\fP
The output driver's default colour\&. 
.TP
\fB\fICACA_TRANSPARENT \fP\fP
The transparent colour\&. 
.SS "enum \fBcaca_style\fP"
\fIlibcaca\fP style keyword 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fICACA_BOLD \fP\fP
The style mask for bold\&. 
.TP
\fB\fICACA_ITALICS \fP\fP
The style mask for italics\&. 
.TP
\fB\fICACA_UNDERLINE \fP\fP
The style mask for underline\&. 
.TP
\fB\fICACA_BLINK \fP\fP
The style mask for blink\&. 
.SS "enum \fBcaca_event_type\fP"
This enum serves two purposes:
.IP "\(bu" 2
Build listening masks for \fBcaca_get_event()\fP\&.
.IP "\(bu" 2
Define the type of a \fIcaca_event_t\fP\&. 
.PP

.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fICACA_EVENT_NONE \fP\fP
No event\&. 
.TP
\fB\fICACA_EVENT_KEY_PRESS \fP\fP
A key was pressed\&. 
.TP
\fB\fICACA_EVENT_KEY_RELEASE \fP\fP
A key was released\&. 
.TP
\fB\fICACA_EVENT_MOUSE_PRESS \fP\fP
A mouse button was pressed\&. 
.TP
\fB\fICACA_EVENT_MOUSE_RELEASE \fP\fP
A mouse button was released\&. 
.TP
\fB\fICACA_EVENT_MOUSE_MOTION \fP\fP
The mouse was moved\&. 
.TP
\fB\fICACA_EVENT_RESIZE \fP\fP
The window was resized\&. 
.TP
\fB\fICACA_EVENT_QUIT \fP\fP
The user requested to quit\&. 
.TP
\fB\fICACA_EVENT_ANY \fP\fP
Bitmask for any event\&. 
.SS "enum \fBcaca_key\fP"
Special key values returned by \fBcaca_get_event()\fP for which there is no printable ASCII equivalent\&. 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fICACA_KEY_UNKNOWN \fP\fP
Unknown key\&. 
.TP
\fB\fICACA_KEY_CTRL_A \fP\fP
The Ctrl-A key\&. 
.TP
\fB\fICACA_KEY_CTRL_B \fP\fP
The Ctrl-B key\&. 
.TP
\fB\fICACA_KEY_CTRL_C \fP\fP
The Ctrl-C key\&. 
.TP
\fB\fICACA_KEY_CTRL_D \fP\fP
The Ctrl-D key\&. 
.TP
\fB\fICACA_KEY_CTRL_E \fP\fP
The Ctrl-E key\&. 
.TP
\fB\fICACA_KEY_CTRL_F \fP\fP
The Ctrl-F key\&. 
.TP
\fB\fICACA_KEY_CTRL_G \fP\fP
The Ctrl-G key\&. 
.TP
\fB\fICACA_KEY_BACKSPACE \fP\fP
The backspace key\&. 
.TP
\fB\fICACA_KEY_TAB \fP\fP
The tabulation key\&. 
.TP
\fB\fICACA_KEY_CTRL_J \fP\fP
The Ctrl-J key\&. 
.TP
\fB\fICACA_KEY_CTRL_K \fP\fP
The Ctrl-K key\&. 
.TP
\fB\fICACA_KEY_CTRL_L \fP\fP
The Ctrl-L key\&. 
.TP
\fB\fICACA_KEY_RETURN \fP\fP
The return key\&. 
.TP
\fB\fICACA_KEY_CTRL_N \fP\fP
The Ctrl-N key\&. 
.TP
\fB\fICACA_KEY_CTRL_O \fP\fP
The Ctrl-O key\&. 
.TP
\fB\fICACA_KEY_CTRL_P \fP\fP
The Ctrl-P key\&. 
.TP
\fB\fICACA_KEY_CTRL_Q \fP\fP
The Ctrl-Q key\&. 
.TP
\fB\fICACA_KEY_CTRL_R \fP\fP
The Ctrl-R key\&. 
.TP
\fB\fICACA_KEY_PAUSE \fP\fP
The pause key\&. 
.TP
\fB\fICACA_KEY_CTRL_T \fP\fP
The Ctrl-T key\&. 
.TP
\fB\fICACA_KEY_CTRL_U \fP\fP
The Ctrl-U key\&. 
.TP
\fB\fICACA_KEY_CTRL_V \fP\fP
The Ctrl-V key\&. 
.TP
\fB\fICACA_KEY_CTRL_W \fP\fP
The Ctrl-W key\&. 
.TP
\fB\fICACA_KEY_CTRL_X \fP\fP
The Ctrl-X key\&. 
.TP
\fB\fICACA_KEY_CTRL_Y \fP\fP
The Ctrl-Y key\&. 
.TP
\fB\fICACA_KEY_CTRL_Z \fP\fP
The Ctrl-Z key\&. 
.TP
\fB\fICACA_KEY_ESCAPE \fP\fP
The escape key\&. 
.TP
\fB\fICACA_KEY_DELETE \fP\fP
The delete key\&. 
.TP
\fB\fICACA_KEY_UP \fP\fP
The up arrow key\&. 
.TP
\fB\fICACA_KEY_DOWN \fP\fP
The down arrow key\&. 
.TP
\fB\fICACA_KEY_LEFT \fP\fP
The left arrow key\&. 
.TP
\fB\fICACA_KEY_RIGHT \fP\fP
The right arrow key\&. 
.TP
\fB\fICACA_KEY_INSERT \fP\fP
The insert key\&. 
.TP
\fB\fICACA_KEY_HOME \fP\fP
The home key\&. 
.TP
\fB\fICACA_KEY_END \fP\fP
The end key\&. 
.TP
\fB\fICACA_KEY_PAGEUP \fP\fP
The page up key\&. 
.TP
\fB\fICACA_KEY_PAGEDOWN \fP\fP
The page down key\&. 
.TP
\fB\fICACA_KEY_F1 \fP\fP
The F1 key\&. 
.TP
\fB\fICACA_KEY_F2 \fP\fP
The F2 key\&. 
.TP
\fB\fICACA_KEY_F3 \fP\fP
The F3 key\&. 
.TP
\fB\fICACA_KEY_F4 \fP\fP
The F4 key\&. 
.TP
\fB\fICACA_KEY_F5 \fP\fP
The F5 key\&. 
.TP
\fB\fICACA_KEY_F6 \fP\fP
The F6 key\&. 
.TP
\fB\fICACA_KEY_F7 \fP\fP
The F7 key\&. 
.TP
\fB\fICACA_KEY_F8 \fP\fP
The F8 key\&. 
.TP
\fB\fICACA_KEY_F9 \fP\fP
The F9 key\&. 
.TP
\fB\fICACA_KEY_F10 \fP\fP
The F10 key\&. 
.TP
\fB\fICACA_KEY_F11 \fP\fP
The F11 key\&. 
.TP
\fB\fICACA_KEY_F12 \fP\fP
The F12 key\&. 
.TP
\fB\fICACA_KEY_F13 \fP\fP
The F13 key\&. 
.TP
\fB\fICACA_KEY_F14 \fP\fP
The F14 key\&. 
.TP
\fB\fICACA_KEY_F15 \fP\fP
The F15 key\&. 
.SH "Author"
.PP 
Generated automatically by Doxygen for libcaca from the source code\&.