1 /*
2  * Copyright (C) 2001,2002,2003,2009,2010 Red Hat, Inc.
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
17  */
18 
19 #ifndef __NOVTE_VTE_ENUMS_H__
20 #define __NOVTE_VTE_ENUMS_H__
21 
22 #include <glib.h>
23 
24 G_BEGIN_DECLS
25 
26 /**
27  * VteCursorBlinkMode:
28  * @VTE_CURSOR_BLINK_SYSTEM: Follow GTK+ settings for cursor blinking.
29  * @VTE_CURSOR_BLINK_ON: Cursor blinks.
30  * @VTE_CURSOR_BLINK_OFF: Cursor does not blink.
31  *
32  * An enumerated type which can be used to indicate the cursor blink mode
33  * for the terminal.
34  */
35 typedef enum {
36     VTE_CURSOR_BLINK_SYSTEM,
37     VTE_CURSOR_BLINK_ON,
38     VTE_CURSOR_BLINK_OFF
39 } VteCursorBlinkMode;
40 
41 /**
42  * VteCursorShape:
43  * @VTE_CURSOR_SHAPE_BLOCK: Draw a block cursor.  This is the default.
44  * @VTE_CURSOR_SHAPE_IBEAM: Draw a vertical bar on the left side of character.
45  * This is similar to the default cursor for other GTK+ widgets.
46  * @VTE_CURSOR_SHAPE_UNDERLINE: Draw a horizontal bar below the character.
47  *
48  * An enumerated type which can be used to indicate what should the terminal
49  * draw at the cursor position.
50  */
51 typedef enum {
52     VTE_CURSOR_SHAPE_BLOCK,
53     VTE_CURSOR_SHAPE_IBEAM,
54     VTE_CURSOR_SHAPE_UNDERLINE
55 } VteCursorShape;
56 
57 /**
58  * VteTextBlinkMode:
59  * @VTE_TEXT_BLINK_NEVER: Do not blink the text.
60  * @VTE_TEXT_BLINK_FOCUSED: Allow blinking text only if the terminal is focused.
61  * @VTE_TEXT_BLINK_UNFOCUSED: Allow blinking text only if the terminal is unfocused.
62  * @VTE_TEXT_BLINK_ALWAYS: Allow blinking text. This is the default.
63  *
64  * An enumerated type which can be used to indicate whether the terminal allows
65  * the text contents to be blinked.
66  *
67  * Since: 0.52
68  */
69 typedef enum {
70     VTE_TEXT_BLINK_NEVER     = 0,
71     VTE_TEXT_BLINK_FOCUSED   = 1,
72     VTE_TEXT_BLINK_UNFOCUSED = 2,
73     VTE_TEXT_BLINK_ALWAYS    = 3
74 } VteTextBlinkMode;
75 
76 /**
77  * VteEraseBinding:
78  * @VTE_ERASE_AUTO: For backspace, attempt to determine the right value from the terminal's IO settings.  For delete, use the control sequence.
79  * @VTE_ERASE_ASCII_BACKSPACE: Send an ASCII backspace character (0x08).
80  * @VTE_ERASE_ASCII_DELETE: Send an ASCII delete character (0x7F).
81  * @VTE_ERASE_DELETE_SEQUENCE: Send the "@@7" control sequence.
82  * @VTE_ERASE_TTY: Send terminal's "erase" setting.
83  *
84  * An enumerated type which can be used to indicate which string the terminal
85  * should send to an application when the user presses the Delete or Backspace
86  * keys.
87  */
88 typedef enum {
89     VTE_ERASE_AUTO,
90     VTE_ERASE_ASCII_BACKSPACE,
91     VTE_ERASE_ASCII_DELETE,
92     VTE_ERASE_DELETE_SEQUENCE,
93     VTE_ERASE_TTY
94 } VteEraseBinding;
95 
96 /**
97  * VteWriteFlags:
98  * @VTE_WRITE_DEFAULT: Write contents as UTF-8 text.  This is the default.
99  *
100  * A flag type to determine how terminal contents should be written
101  * to an output stream.
102  */
103 typedef enum {
104     VTE_WRITE_DEFAULT = 0
105 } VteWriteFlags;
106 
107 /**
108  * VteFormat:
109  * @VTE_FORMAT_TEXT: Export as plain text
110  * @VTE_FORMAT_HTML: Export as HTML formatted text
111  *
112  * An enumeratio type that can be used to specify the format the selection
113  * should be copied to the clipboard in.
114  *
115  * Since: 0.50
116  */
117 typedef enum {
118     VTE_FORMAT_TEXT = 1,
119     VTE_FORMAT_HTML = 2
120 } VteFormat;
121 
122 G_END_DECLS
123 
124 #endif /* __NOVTE_VTE_ENUMS_H__ */
125