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 gtk.EditableIF;
26 
27 private import glib.Str;
28 private import gobject.Signals;
29 public  import gtkc.gdktypes;
30 private import gtkc.gtk;
31 public  import gtkc.gtktypes;
32 
33 
34 /**
35  * The #GtkEditable interface is an interface which should be implemented by
36  * text editing widgets, such as #GtkEntry and #GtkSpinButton. It contains functions
37  * for generically manipulating an editable widget, a large number of action
38  * signals used for key bindings, and several signals that an application can
39  * connect to to modify the behavior of a widget.
40  * 
41  * As an example of the latter usage, by connecting
42  * the following handler to #GtkEditable::insert-text, an application
43  * can convert all entry into a widget into uppercase.
44  * 
45  * ## Forcing entry to uppercase.
46  * 
47  * |[<!-- language="C" -->
48  * #include <ctype.h>;
49  * 
50  * void
51  * insert_text_handler (GtkEditable *editable,
52  * const gchar *text,
53  * gint         length,
54  * gint        *position,
55  * gpointer     data)
56  * {
57  * gchar *result = g_utf8_strup (text, length);
58  * 
59  * g_signal_handlers_block_by_func (editable,
60  * (gpointer) insert_text_handler, data);
61  * gtk_editable_insert_text (editable, result, length, position);
62  * g_signal_handlers_unblock_by_func (editable,
63  * (gpointer) insert_text_handler, data);
64  * 
65  * g_signal_stop_emission_by_name (editable, "insert_text");
66  * 
67  * g_free (result);
68  * }
69  * ]|
70  */
71 public interface EditableIF{
72 	/** Get the main Gtk struct */
73 	public GtkEditable* getEditableStruct();
74 
75 	/** the main Gtk struct as a void* */
76 	protected void* getStruct();
77 
78 
79 	/**
80 	 * Copies the contents of the currently selected content in the editable and
81 	 * puts it on the clipboard.
82 	 */
83 	public void copyClipboard();
84 
85 	/**
86 	 * Removes the contents of the currently selected content in the editable and
87 	 * puts it on the clipboard.
88 	 */
89 	public void cutClipboard();
90 
91 	/**
92 	 * Deletes the currently selected text of the editable.
93 	 * This call doesn’t do anything if there is no selected text.
94 	 */
95 	public void deleteSelection();
96 
97 	/**
98 	 * Deletes a sequence of characters. The characters that are deleted are
99 	 * those characters at positions from @start_pos up to, but not including
100 	 * @end_pos. If @end_pos is negative, then the characters deleted
101 	 * are those from @start_pos to the end of the text.
102 	 *
103 	 * Note that the positions are specified in characters, not bytes.
104 	 *
105 	 * Params:
106 	 *     startPos = start position
107 	 *     endPos = end position
108 	 */
109 	public void deleteText(int startPos, int endPos);
110 
111 	/**
112 	 * Retrieves a sequence of characters. The characters that are retrieved
113 	 * are those characters at positions from @start_pos up to, but not
114 	 * including @end_pos. If @end_pos is negative, then the characters
115 	 * retrieved are those characters from @start_pos to the end of the text.
116 	 *
117 	 * Note that positions are specified in characters, not bytes.
118 	 *
119 	 * Params:
120 	 *     startPos = start of text
121 	 *     endPos = end of text
122 	 *
123 	 * Return: a pointer to the contents of the widget as a
124 	 *     string. This string is allocated by the #GtkEditable
125 	 *     implementation and should be freed by the caller.
126 	 */
127 	public string getChars(int startPos, int endPos);
128 
129 	/**
130 	 * Retrieves whether @editable is editable. See
131 	 * gtk_editable_set_editable().
132 	 *
133 	 * Return: %TRUE if @editable is editable.
134 	 */
135 	public bool getEditable();
136 
137 	/**
138 	 * Retrieves the current position of the cursor relative to the start
139 	 * of the content of the editable.
140 	 *
141 	 * Note that this position is in characters, not in bytes.
142 	 *
143 	 * Return: the cursor position
144 	 */
145 	public int getPosition();
146 
147 	/**
148 	 * Retrieves the selection bound of the editable. start_pos will be filled
149 	 * with the start of the selection and @end_pos with end. If no text was
150 	 * selected both will be identical and %FALSE will be returned.
151 	 *
152 	 * Note that positions are specified in characters, not bytes.
153 	 *
154 	 * Params:
155 	 *     startPos = location to store the starting position, or %NULL
156 	 *     endPos = location to store the end position, or %NULL
157 	 *
158 	 * Return: %TRUE if an area is selected, %FALSE otherwise
159 	 */
160 	public bool getSelectionBounds(out int startPos, out int endPos);
161 
162 	/**
163 	 * Inserts @new_text_length bytes of @new_text into the contents of the
164 	 * widget, at position @position.
165 	 *
166 	 * Note that the position is in characters, not in bytes.
167 	 * The function updates @position to point after the newly inserted text.
168 	 *
169 	 * Params:
170 	 *     newText = the text to append
171 	 *     newTextLength = the length of the text in bytes, or -1
172 	 *     position = location of the position text will be inserted at
173 	 */
174 	public void insertText(string newText, int newTextLength, ref int position);
175 
176 	/**
177 	 * Pastes the content of the clipboard to the current position of the
178 	 * cursor in the editable.
179 	 */
180 	public void pasteClipboard();
181 
182 	/**
183 	 * Selects a region of text. The characters that are selected are
184 	 * those characters at positions from @start_pos up to, but not
185 	 * including @end_pos. If @end_pos is negative, then the
186 	 * characters selected are those characters from @start_pos to
187 	 * the end of the text.
188 	 *
189 	 * Note that positions are specified in characters, not bytes.
190 	 *
191 	 * Params:
192 	 *     startPos = start of region
193 	 *     endPos = end of region
194 	 */
195 	public void selectRegion(int startPos, int endPos);
196 
197 	/**
198 	 * Determines if the user can edit the text in the editable
199 	 * widget or not.
200 	 *
201 	 * Params:
202 	 *     isEditable = %TRUE if the user is allowed to edit the text
203 	 *         in the widget
204 	 */
205 	public void setEditable(bool isEditable);
206 
207 	/**
208 	 * Sets the cursor position in the editable to the given value.
209 	 *
210 	 * The cursor is displayed before the character with the given (base 0)
211 	 * index in the contents of the editable. The value must be less than or
212 	 * equal to the number of characters in the editable. A value of -1
213 	 * indicates that the position should be set after the last character
214 	 * of the editable. Note that @position is in characters, not in bytes.
215 	 *
216 	 * Params:
217 	 *     position = the position of the cursor
218 	 */
219 	public void setPosition(int position);
220 	@property void delegate(EditableIF)[] onChangedListeners();
221 	/**
222 	 * The ::changed signal is emitted at the end of a single
223 	 * user-visible operation on the contents of the #GtkEditable.
224 	 *
225 	 * E.g., a paste operation that replaces the contents of the
226 	 * selection will cause only one signal emission (even though it
227 	 * is implemented by first deleting the selection, then inserting
228 	 * the new content, and may cause multiple ::notify::text signals
229 	 * to be emitted).
230 	 */
231 	void addOnChanged(void delegate(EditableIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0);
232 
233 	@property void delegate(int, int, EditableIF)[] onDeleteTextListeners();
234 	/**
235 	 * This signal is emitted when text is deleted from
236 	 * the widget by the user. The default handler for
237 	 * this signal will normally be responsible for deleting
238 	 * the text, so by connecting to this signal and then
239 	 * stopping the signal with g_signal_stop_emission(), it
240 	 * is possible to modify the range of deleted text, or
241 	 * prevent it from being deleted entirely. The @start_pos
242 	 * and @end_pos parameters are interpreted as for
243 	 * gtk_editable_delete_text().
244 	 *
245 	 * Params:
246 	 *     startPos = the starting position
247 	 *     endPos = the end position
248 	 */
249 	void addOnDeleteText(void delegate(int, int, EditableIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0);
250 
251 	@property void delegate(string, int, void*, EditableIF)[] onInsertTextListeners();
252 	/**
253 	 * This signal is emitted when text is inserted into
254 	 * the widget by the user. The default handler for
255 	 * this signal will normally be responsible for inserting
256 	 * the text, so by connecting to this signal and then
257 	 * stopping the signal with g_signal_stop_emission(), it
258 	 * is possible to modify the inserted text, or prevent
259 	 * it from being inserted entirely.
260 	 *
261 	 * Params:
262 	 *     newText = the new text to insert
263 	 *     newTextLength = the length of the new text, in bytes,
264 	 *         or -1 if new_text is nul-terminated
265 	 *     position = the position, in characters,
266 	 *         at which to insert the new text. this is an in-out
267 	 *         parameter.  After the signal emission is finished, it
268 	 *         should point after the newly inserted text.
269 	 */
270 	void addOnInsertText(void delegate(string, int, void*, EditableIF) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0);
271 
272 }