Gtk.Editable

g GObject.GInterface GObject.GInterface Gtk.Editable Gtk.Editable GObject.GInterface->Gtk.Editable

Implementations:
 Gtk.Entry

Methods

  copy_clipboard ()
  cut_clipboard ()
  delete_selection ()
  delete_text (start_pos, end_pos)
  get_chars (start_pos, end_pos)
  get_editable ()
  get_position ()
  get_selection_bounds ()
  insert_text (self, text, position)
  paste_clipboard ()
  select_region (start_pos, end_pos)
  set_editable (is_editable)
  set_position (position)

Virtual Methods

  do_changed ()
  do_delete_text (start_pos, end_pos)
  do_do_delete_text (start_pos, end_pos)
  do_do_insert_text (new_text, new_text_length, position)
  do_get_chars (start_pos, end_pos)
  do_get_position ()
  do_get_selection_bounds ()
  do_insert_text (new_text, new_text_length, position)
  do_set_position (position)
  do_set_selection_bounds (start_pos, end_pos)

Properties

None

Signals

Name Short Description
changed The ::changed signal is emitted at the end of a single user-visible operation on the contents of the Gtk.Editable.
delete-text This signal is emitted when text is deleted from the widget by the user.
insert-text This signal is emitted when text is inserted into the widget by the user.

Fields

None

Class Details

class Gtk.Editable
Bases:GObject.GInterface
Structure:Gtk.EditableInterface

The Gtk.Editable interface is an interface which should be implemented by text editing widgets, such as Gtk.Entry and Gtk.SpinButton. 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 Gtk.Editable ::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);
}
copy_clipboard()[source]

Copies the contents of the currently selected content in the editable and puts it on the clipboard.

cut_clipboard()[source]

Removes the contents of the currently selected content in the editable and puts it on the clipboard.

delete_selection()[source]

Deletes the currently selected text of the editable. This call doesn’t do anything if there is no selected text.

delete_text(start_pos, end_pos)[source]
Parameters:
  • start_pos (int) – start position
  • end_pos (int) – end position

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.

get_chars(start_pos, end_pos)[source]
Parameters:
  • start_pos (int) – start of text
  • end_pos (int) – end of text
Returns:

a pointer to the contents of the widget as a string. This string is allocated by the Gtk.Editable implementation and should be freed by the caller.

Return type:

str

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.

get_editable()[source]
Returns:True if self is editable.
Return type:bool

Retrieves whether self is editable. See Gtk.Editable.set_editable().

get_position()[source]
Returns:the cursor position
Return type:int

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.

get_selection_bounds()[source]
Returns:An empty tuple if no area is selected or a tuple containing:
start_pos:the starting position
end_pos:the end position
Return type:(start_pos: int, end_pos: int) or ()

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 an empty tuple will be returned.

Note that positions are specified in characters, not bytes.

insert_text(self, text, position)[source]
Parameters:
  • new_text (str) – the text to append
  • position (int) – location of the position text will be inserted at
Returns:

location of the position text will be inserted at

Return type:

int

Inserts new_text into the contents of the widget, at position position.

Note that the position is in characters, not in bytes.

paste_clipboard()[source]

Pastes the content of the clipboard to the current position of the cursor in the editable.

select_region(start_pos, end_pos)[source]
Parameters:
  • start_pos (int) – start of region
  • end_pos (int) – end of region

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.

set_editable(is_editable)[source]
Parameters:is_editable (bool) – True if the user is allowed to edit the text in the widget

Determines if the user can edit the text in the editable widget or not.

set_position(position)[source]
Parameters:position (int) – the position of the cursor

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.

do_changed() virtual
do_delete_text(start_pos, end_pos) virtual
Parameters:
  • start_pos (int) – start position
  • end_pos (int) – end position

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.

do_do_delete_text(start_pos, end_pos) virtual
Parameters:
  • start_pos (int) – start position
  • end_pos (int) – end position

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.

do_do_insert_text(new_text, new_text_length, position) virtual
Parameters:
  • new_text (str) – the text to append
  • new_text_length (int) – the length of the text in bytes, or -1
  • position (int) – location of the position text will be inserted at
Returns:

location of the position text will be inserted at

Return type:

position: int

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.

do_get_chars(start_pos, end_pos) virtual
Parameters:
  • start_pos (int) – start of text
  • end_pos (int) – end of text
Returns:

a pointer to the contents of the widget as a string. This string is allocated by the Gtk.Editable implementation and should be freed by the caller.

Return type:

str

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.

do_get_position() virtual
Returns:the cursor position
Return type:int

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.

do_get_selection_bounds() virtual
Returns:True if an area is selected, False otherwise
start_pos:location to store the starting position, or None
end_pos:location to store the end position, or None
Return type:(bool, start_pos: int, end_pos: int)

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.

do_insert_text(new_text, new_text_length, position) virtual
Parameters:
  • new_text (str) – the text to append
  • new_text_length (int) – the length of the text in bytes, or -1
  • position (int) – location of the position text will be inserted at
Returns:

location of the position text will be inserted at

Return type:

position: int

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.

do_set_position(position) virtual
Parameters:position (int) – the position of the cursor

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.

do_set_selection_bounds(start_pos, end_pos) virtual
Parameters:
  • start_pos (int) – start of region
  • end_pos (int) – end of region

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.

Signal Details

Gtk.Editable.signals.changed(editable)
Signal Name:changed
Flags:RUN_LAST
Parameters:editable (Gtk.Editable) – The object which received the signal

The ::changed signal is emitted at the end of a single user-visible operation on the contents of the Gtk.Editable.

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).

Gtk.Editable.signals.delete_text(editable, start_pos, end_pos)
Signal Name:

delete-text

Flags:

RUN_LAST

Parameters:
  • editable (Gtk.Editable) – The object which received the signal
  • start_pos (int) – the starting position
  • end_pos (int) – the end position

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.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().

Gtk.Editable.signals.insert_text(editable, new_text, new_text_length, position)
Signal Name:

insert-text

Flags:

RUN_LAST

Parameters:
  • editable (Gtk.Editable) – The object which received the signal
  • new_text (str) – the new text to insert
  • new_text_length (int) – the length of the new text, in bytes, or -1 if new_text is nul-terminated
  • position (int) – 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.
Returns:

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.

Return type:

position: int

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.signal_stop_emission(), it is possible to modify the inserted text, or prevent it from being inserted entirely.