1 /*
2  * This file is part of gtkD.
3  *
4  * gtkD is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * gtkD is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with gtkD; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19 
20 // generated automatically - do not change
21 // find conversion definition on APILookup.txt
22 // implement new conversion functionalities on the wrap.utils pakage
23 
24 
25 module vtec.vtetypes;
26 
27 public import gtkc.gtktypes;
28 
29 /**
30  * An enumerated type which can be used to indicate the cursor blink mode
31  * for the terminal.
32  */
33 public enum VteCursorBlinkMode
34 {
35 	/**
36 	 * Follow GTK+ settings for cursor blinking.
37 	 */
38 	SYSTEM = 0,
39 	/**
40 	 * Cursor blinks.
41 	 */
42 	ON = 1,
43 	/**
44 	 * Cursor does not blink.
45 	 */
46 	OFF = 2,
47 }
48 alias VteCursorBlinkMode CursorBlinkMode;
49 
50 /**
51  * An enumerated type which can be used to indicate what should the terminal
52  * draw at the cursor position.
53  */
54 public enum VteCursorShape
55 {
56 	/**
57 	 * Draw a block cursor.  This is the default.
58 	 */
59 	BLOCK = 0,
60 	/**
61 	 * Draw a vertical bar on the left side of character.
62 	 * This is similar to the default cursor for other GTK+ widgets.
63 	 */
64 	IBEAM = 1,
65 	/**
66 	 * Draw a horizontal bar below the character.
67 	 */
68 	UNDERLINE = 2,
69 }
70 alias VteCursorShape CursorShape;
71 
72 /**
73  * An enumerated type which can be used to indicate which string the terminal
74  * should send to an application when the user presses the Delete or Backspace
75  * keys.
76  */
77 public enum VteEraseBinding
78 {
79 	/**
80 	 * For backspace, attempt to determine the right value from the terminal's IO settings.  For delete, use the control sequence.
81 	 */
82 	AUTO = 0,
83 	/**
84 	 * Send an ASCII backspace character (0x08).
85 	 */
86 	ASCII_BACKSPACE = 1,
87 	/**
88 	 * Send an ASCII delete character (0x7F).
89 	 */
90 	ASCII_DELETE = 2,
91 	/**
92 	 * Send the "@@7" control sequence.
93 	 */
94 	DELETE_SEQUENCE = 3,
95 	/**
96 	 * Send terminal's "erase" setting.
97 	 */
98 	TTY = 4,
99 }
100 alias VteEraseBinding EraseBinding;
101 
102 public enum VtePtyError
103 {
104 	/**
105 	 * failure when using the GNOME PTY helper to
106 	 * allocate the PTY
107 	 */
108 	PTY_HELPER_FAILED = 0,
109 	/**
110 	 * failure when using PTY98 to allocate the PTY
111 	 */
112 	PTY98_FAILED = 1,
113 }
114 alias VtePtyError PtyError;
115 
116 public enum VtePtyFlags
117 {
118 	/**
119 	 * don't record the session in lastlog. Deprecated: 0.38
120 	 */
121 	NO_LASTLOG = 1,
122 	/**
123 	 * don't record the session in utmp. Deprecated: 0.38
124 	 */
125 	NO_UTMP = 2,
126 	/**
127 	 * don't record the session in wtmp. Deprecated: 0.38
128 	 */
129 	NO_WTMP = 4,
130 	/**
131 	 * don't use the GNOME PTY helper to allocate the PTY. Deprecated: 0.38
132 	 */
133 	NO_HELPER = 8,
134 	/**
135 	 * when allocating the PTY with the PTY helper fails,
136 	 * don't fall back to try using PTY98. Deprecated: 0.38
137 	 */
138 	NO_FALLBACK = 16,
139 	/**
140 	 * the default flags
141 	 */
142 	DEFAULT = 0,
143 }
144 alias VtePtyFlags PtyFlags;
145 
146 /**
147  * A flag type to determine how terminal contents should be written
148  * to an output stream.
149  */
150 public enum VteWriteFlags
151 {
152 	/**
153 	 * Write contents as UTF-8 text.  This is the default.
154 	 */
155 	DEFAULT = 0,
156 }
157 alias VteWriteFlags WriteFlags;
158 
159 struct VteCharAttributes
160 {
161 	long row;
162 	long column;
163 	PangoColor fore;
164 	PangoColor back;
165 	import std.bitmanip: bitfields;
166 	mixin(bitfields!(
167 		uint, "underline", 1,
168 		uint, "strikethrough", 1,
169 		uint, "", 30
170 	));
171 }
172 
173 struct VtePty;
174 
175 struct VtePtyClass;
176 
177 struct VteTerminal
178 {
179 	GtkWidget widget;
180 	VteTerminalPrivate* pvt;
181 }
182 
183 /**
184  * All of these fields should be considered read-only, except for derived classes.
185  */
186 struct VteTerminalClass
187 {
188 	GtkWidgetClass parentClass;
189 	extern(C) void function(VteTerminal* terminal) eof;
190 	extern(C) void function(VteTerminal* terminal, int status) childExited;
191 	extern(C) void function(VteTerminal* terminal) encodingChanged;
192 	extern(C) void function(VteTerminal* terminal, uint charWidth, uint charHeight) charSizeChanged;
193 	extern(C) void function(VteTerminal* terminal) windowTitleChanged;
194 	extern(C) void function(VteTerminal* terminal) iconTitleChanged;
195 	extern(C) void function(VteTerminal* terminal) selectionChanged;
196 	extern(C) void function(VteTerminal* terminal) contentsChanged;
197 	extern(C) void function(VteTerminal* terminal) cursorMoved;
198 	extern(C) void function(VteTerminal* terminal, const(char)* text, uint size) commit;
199 	extern(C) void function(VteTerminal* terminal) deiconifyWindow;
200 	extern(C) void function(VteTerminal* terminal) iconifyWindow;
201 	extern(C) void function(VteTerminal* terminal) raiseWindow;
202 	extern(C) void function(VteTerminal* terminal) lowerWindow;
203 	extern(C) void function(VteTerminal* terminal) refreshWindow;
204 	extern(C) void function(VteTerminal* terminal) restoreWindow;
205 	extern(C) void function(VteTerminal* terminal) maximizeWindow;
206 	extern(C) void function(VteTerminal* terminal, uint width, uint height) resizeWindow;
207 	extern(C) void function(VteTerminal* terminal, uint x, uint y) moveWindow;
208 	extern(C) void function(VteTerminal* terminal) increaseFontSize;
209 	extern(C) void function(VteTerminal* terminal) decreaseFontSize;
210 	extern(C) void function(VteTerminal* terminal) textModified;
211 	extern(C) void function(VteTerminal* terminal) textInserted;
212 	extern(C) void function(VteTerminal* terminal) textDeleted;
213 	extern(C) void function(VteTerminal* terminal, int delta) textScrolled;
214 	extern(C) void function(VteTerminal* terminal) copyClipboard;
215 	extern(C) void function(VteTerminal* terminal) pasteClipboard;
216 	extern(C) void function(VteTerminal* terminal) bell;
217 	void*[16] padding;
218 	VteTerminalClassPrivate* priv;
219 }
220 
221 struct VteTerminalClassPrivate;
222 
223 struct VteTerminalPrivate;
224 
225 /**
226  * Specifies the type of a selection function used to check whether
227  * a cell has to be selected or not.
228  *
229  * Params:
230  *     terminal = terminal in which the cell is.
231  *     column = column in which the cell is.
232  *     row = row in which the cell is.
233  *     data = user data.
234  *
235  * Return: %TRUE if cell has to be selected; %FALSE if otherwise.
236  */
237 public alias extern(C) int function(VteTerminal* terminal, glong column, glong row, void* data) VteSelectionFunc;