string. This string is allocated by the #GtkEditable implementation and should be freed by the caller.
gtk.editable_mixin
Module for [Editable] interface mixin
Templates 2
tmplEditableT()
The #GtkEditable interface is an interface which should be implemented by text editing widgets, such as #GtkEntry and #GtkSpinButton. It contains functions for generically manipulating an editable widget, a large number of action signals used for key bindings, and several signals that an application can connect to to modify the behavior of a widget.
As an example of the latter usage, by connecting the following handler to #GtkEditable::insert-text, an application can convert all entry into a widget into uppercase.
Forcing entry to uppercase.
#include <ctype.h>;
void
insert_text_handler (GtkEditable *editable,
const gchar *text,
gint length,
gint *position,
gpointer data)
{
gchar *result = g_utf8_strup (text, length);
g_signal_handlers_block_by_func (editable,
(gpointer) insert_text_handler, data);
gtk_editable_insert_text (editable, result, length, position);
g_signal_handlers_unblock_by_func (editable,
(gpointer) insert_text_handler, data);
g_signal_stop_emission_by_name (editable, "insert_text");
g_free (result);
}Functions
void copyClipboard()
Copies the contents of the currently selected content in the editable and puts it on the clipboard.
void cutClipboard()
Removes the contents of the currently selected content in the editable and puts it on the clipboard.
void deleteSelection()
Deletes the currently selected text of the editable. This call doesn’t do anything if there is no selected text.
void deleteText(int startPos, int endPos)
Deletes a sequence of characters. The characters that are deleted are those characters at positions from start_pos up to, but not including end_pos. If end_pos is negative, then the characters deleted are those from start_pos to the end of the text.
Note that the positions are specified in characters, not bytes.
Parameters
startPos | start position |
endPos | end position |
string getChars(int startPos, int endPos)
Retrieves a sequence of characters. The characters that are retrieved are those characters at positions from start_pos up to, but not including end_pos. If end_pos is negative, then the characters retrieved are those characters from start_pos to the end of the text.
Note that positions are specified in characters, not bytes.
Parameters
startPos | start of text |
endPos | end of text |
Returns
a pointer to the contents of the widget as a
bool getEditable()
Retrieves whether editable is editable. See [gtk.editable.Editable.setEditable].
Returns
true if editable is editable.
int getPosition()
Retrieves the current position of the cursor relative to the start of the content of the editable.
Note that this position is in characters, not in bytes.
Returns
the cursor position
bool getSelectionBounds(out int startPos, out int endPos)
Retrieves the selection bound of the editable. start_pos will be filled with the start of the selection and end_pos with end. If no text was selected both will be identical and false will be returned.
Note that positions are specified in characters, not bytes.
Parameters
startPos | location to store the starting position, or null |
endPos | location to store the end position, or null |
Returns
true if an area is selected, false otherwise
void insertText(string newText, ref int position)
Inserts new_text_length bytes of new_text into the contents of the widget, at position position.
Note that the position is in characters, not in bytes. The function updates position to point after the newly inserted text.
Parameters
newText | the text to append |
position | location of the position text will be inserted at |
void pasteClipboard()
Pastes the content of the clipboard to the current position of the cursor in the editable.
void selectRegion(int startPos, int endPos)
Selects a region of text. The characters that are selected are those characters at positions from start_pos up to, but not including end_pos. If end_pos is negative, then the characters selected are those characters from start_pos to the end of the text.
Note that positions are specified in characters, not bytes.
Parameters
startPos | start of region |
endPos | end of region |
void setEditable(bool isEditable)
Determines if the user can edit the text in the editable widget or not.
Parameters
isEditable | true if the user is allowed to edit the text in the widget |
void setPosition(int position)
Sets the cursor position in the editable to the given value.
The cursor is displayed before the character with the given (base 0) index in the contents of the editable. The value must be less than or equal to the number of characters in the editable. A value of -1 indicates that the position should be set after the last character of the editable. Note that position is in characters, not in bytes.
Parameters
position | the position of the cursor |
gulong connectChanged(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] : gtk.editable.Editable)))
&& Parameters!T.length < 2)
Connect to Changed signal.
The ::changed signal is emitted at the end of a single user-visible operation on the contents of the #GtkEditable.
E.g., a paste operation that replaces the contents of the selection will cause only one signal emission (even though it is implemented by first deleting the selection, then inserting the new content, and may cause multiple ::notify::text signals to be emitted).
Parameters
callback | signal callback delegate or function to connect void callback(gtk.editable.Editable editable) editable the instance the signal is connected to (optional) |
after | Yes.After to execute callback after default handler, No.After to execute before (default) |
Returns
Signal ID
gulong connectDeleteText(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] == int)))
&& (Parameters!T.length < 2 || (ParameterStorageClassTuple!T[1] == ParameterStorageClass.none && is(Parameters!T[1] == int)))
&& (Parameters!T.length < 3 || (ParameterStorageClassTuple!T[2] == ParameterStorageClass.none && is(Parameters!T[2] : gtk.editable.Editable)))
&& Parameters!T.length < 4)
Connect to DeleteText signal.
This signal is emitted when text is deleted from the widget by the user. The default handler for this signal will normally be responsible for deleting the text, so by connecting to this signal and then stopping the signal with [gobject.global.signalStopEmission], it is possible to modify the range of deleted text, or prevent it from being deleted entirely. The start_pos and end_pos parameters are interpreted as for [gtk.editable.Editable.deleteText].
Parameters
callback | signal callback delegate or function to connect void callback(int startPos, int endPos, gtk.editable.Editable editable) startPos the starting position (optional) endPos the end position (optional) editable the instance the signal is connected to (optional) |
after | Yes.After to execute callback after default handler, No.After to execute before (default) |
Returns
Signal ID
gulong connectInsertText(T)(T callback, Flag!"After" after = No.After) if (isCallable!T
&& is(ReturnType!T == void)
&& (Parameters!T.length < 1 || (ParameterStorageClassTuple!T[0] == ParameterStorageClass.none && is(Parameters!T[0] == string)))
&& (Parameters!T.length < 2 || (ParameterStorageClassTuple!T[1] == ParameterStorageClass.ref_ && is(Parameters!T[1] == int)))
&& (Parameters!T.length < 3 || (ParameterStorageClassTuple!T[2] == ParameterStorageClass.none && is(Parameters!T[2] : gtk.editable.Editable)))
&& Parameters!T.length < 4)
Connect to InsertText signal.
This signal is emitted when text is inserted into the widget by the user. The default handler for this signal will normally be responsible for inserting the text, so by connecting to this signal and then stopping the signal with [gobject.global.signalStopEmission], it is possible to modify the inserted text, or prevent it from being inserted entirely.
Parameters
callback | signal callback delegate or function to connect void callback(string newText, ref int position, gtk.editable.Editable editable) newText the new text to insert (optional) position the position, in characters, at which to insert the new text. this is an in-out parameter. After the signal emission is finished, it should point after the newly inserted text. (optional) editable the instance the signal is connected to (optional) |
after | Yes.After to execute callback after default handler, No.After to execute before (default) |
Returns
Signal ID
tmplEditableGidBuilderT()