EditableIF

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); } ]|

interface EditableIF {

GtkEditable* getEditableStruct(bool transferOwnership);

void* getStruct();

static GType getType();

void copyClipboard();

void cutClipboard();

void deleteSelection();

void deleteText(int startPos, int endPos);

string getChars(int startPos, int endPos);

bool getEditable();

int getPosition();

bool getSelectionBounds(int startPos, int endPos);

void insertText(string newText, int newTextLength, int position);

void pasteClipboard();

void selectRegion(int startPos, int endPos);

void setEditable(bool isEditable);

void setPosition(int position);

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

gulong addOnDeleteText(void delegate(int, int, EditableIF) dlg, ConnectFlags connectFlags);

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

}

Members

Functions

addOnChanged gulong 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.
addOnDeleteText gulong addOnDeleteText(void delegate(int, int, 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 gulong addOnInsertText(void delegate(string, int, 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.
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.
getEditable bool getEditable(): Retrieves whether @editable is editable. See gtk_editable_set_editable().
getEditableStruct GtkEditable* getEditableStruct(bool transferOwnership): Get the main Gtk struct
getPosition int getPosition(): Retrieves the current position of the cursor relative to the start of the content of the editable.
getSelectionBounds bool 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.
getStruct void* getStruct(): the main Gtk struct as a void*
insertText void insertText(string newText, int newTextLength, int position): Inserts @new_text_length bytes of @new_text into the contents of the widget, at position @position.
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.
setEditable void setEditable(bool 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.

Static functions

getType GType getType()

EditableIF

Forcing entry to uppercase.

Members

Functions

Static functions

Meta

Source