EditableT

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 "insert-text", an application can convert all entry into a widget into uppercase.

template EditableT (

TStruct

) {

protected

GtkEditable* gtkEditable;

GtkEditable* getEditableTStruct();

int[string] connectedSignals;

void delegate(EditableIF)[] _onChangedListeners;

void delegate(EditableIF)[] onChangedListeners [@property getter];

void addOnChanged(void delegate(EditableIF) dlg, ConnectFlags connectFlags);

static void callBackChanged(GtkEditable* editableStruct, EditableIF _editableIF);

void delegate(gint, gint, EditableIF)[] _onDeleteTextListeners;

void delegate(gint, gint, EditableIF)[] onDeleteTextListeners [@property getter];

void addOnDeleteText(void delegate(gint, gint, EditableIF) dlg, ConnectFlags connectFlags);

static void callBackDeleteText(GtkEditable* editableStruct, gint startPos, gint endPos, EditableIF _editableIF);

void delegate(string, gint, void*, EditableIF)[] _onInsertTextListeners;

void delegate(string, gint, void*, EditableIF)[] onInsertTextListeners [@property getter];

void addOnInsertText(void delegate(string, gint, void*, EditableIF) dlg, ConnectFlags connectFlags);

static void callBackInsertText(GtkEditable* editableStruct, gchar* newText, gint newTextLength, void* position, EditableIF _editableIF);

void selectRegion(int startPos, int endPos);

int getSelectionBounds(int startPos, int endPos);

void insertText(string newText, int position);

void deleteText(int startPos, int endPos);

string getChars(int startPos, int endPos);

void cutClipboard();

void copyClipboard();

void pasteClipboard();

void deleteSelection();

void setPosition(int position);

int getPosition();

void setEditable(int isEditable);

int getEditable();

}

Members

Functions

addOnChanged void addOnChanged(void delegate(EditableIF) dlg, ConnectFlags connectFlags): 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).
addOnDeleteText void addOnDeleteText(void delegate(gint, gint, EditableIF) dlg, ConnectFlags connectFlags): 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 g_signal_stop_emission(), 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_delete_text().
addOnInsertText void addOnInsertText(void delegate(string, gint, void*, EditableIF) dlg, ConnectFlags connectFlags): 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 g_signal_stop_emission(), it is possible to modify the inserted text, or prevent it from being inserted entirely.
copyClipboard void copyClipboard(): Copies the contents of the currently selected content in the editable and puts it on the clipboard.
cutClipboard void cutClipboard(): Removes the contents of the currently selected content in the editable and puts it on the clipboard.
deleteSelection void deleteSelection(): Deletes the currently selected text of the editable. This call doesn't do anything if there is no selected text.
deleteText 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. Virtual: do_delete_text
getChars 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.
getEditable int getEditable(): Retrieves whether editable is editable. See gtk_editable_set_editable().
getEditableTStruct GtkEditable* getEditableTStruct(): Undocumented in source. Be warned that the author may not have intended to support it.
getPosition 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.
getSelectionBounds int getSelectionBounds(int startPos, 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.
insertText void insertText(string newText, 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. Virtual: do_insert_text
pasteClipboard void pasteClipboard(): Pastes the content of the clipboard to the current position of the cursor in the editable.
selectRegion 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. Virtual: set_selection_bounds
setEditable void setEditable(int isEditable): Determines if the user can edit the text in the editable widget or not.
setPosition 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.

Properties

onChangedListeners void delegate(EditableIF)[] onChangedListeners [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
onDeleteTextListeners void delegate(gint, gint, EditableIF)[] onDeleteTextListeners [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
onInsertTextListeners void delegate(string, gint, void*, EditableIF)[] onInsertTextListeners [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.

Static functions

callBackChanged void callBackChanged(GtkEditable* editableStruct, EditableIF _editableIF): Undocumented in source. Be warned that the author may not have intended to support it.
callBackDeleteText void callBackDeleteText(GtkEditable* editableStruct, gint startPos, gint endPos, EditableIF _editableIF): Undocumented in source. Be warned that the author may not have intended to support it.
callBackInsertText void callBackInsertText(GtkEditable* editableStruct, gchar* newText, gint newTextLength, void* position, EditableIF _editableIF): Undocumented in source. Be warned that the author may not have intended to support it.

Variables

_onChangedListeners void delegate(EditableIF)[] _onChangedListeners;: Undocumented in source.
_onDeleteTextListeners void delegate(gint, gint, EditableIF)[] _onDeleteTextListeners;: Undocumented in source.
_onInsertTextListeners void delegate(string, gint, void*, EditableIF)[] _onInsertTextListeners;: Undocumented in source.
connectedSignals int[string] connectedSignals;
gtkEditable GtkEditable* gtkEditable;: the main Gtk struct