Module: Gtk::Editable

Defined in:
(unknown)

Overview

The Gtk::Editable interface is an interface which should be implemented by text editing widgets, such as Gtk::Entry 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 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);
}

Instance Method Summary collapse

Instance Method Details

#changed ⇒ nil

Returns:

  • (nil)

#copy_clipboard ⇒ nil

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

Returns:

  • (nil)

#cut_clipboard ⇒ nil

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

Returns:

  • (nil)

#delete_selection ⇒ nil

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

Returns:

  • (nil)

#delete_text(start_pos, end_pos) ⇒ nil

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:

  • start_pos (Integer) —

    start position

  • end_pos (Integer) —

    end position

Returns:

  • (nil)

#do_delete_text(start_pos, end_pos) ⇒ nil

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:

  • start_pos (Integer) —

    start position

  • end_pos (Integer) —

    end position

Returns:

  • (nil)

#do_insert_text(new_text, new_text_length, position) ⇒ nil

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:

  • new_text (String) —

    the text to append

  • new_text_length (Integer) —

    the length of the text in bytes, or -1

  • position (Integer) —

    location of the position text will be inserted at

Returns:

  • (nil)

#editable ⇒ TrueClass

Retrieves whether editable is editable. See gtk_editable_set_editable().

Returns:

  • (TrueClass) —

    true if editable is editable.

#editable=(is_editable) ⇒ nil

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

Parameters:

  • is_editable (TrueClass) —

    true if the user is allowed to edit the text in the widget

Returns:

  • (nil)

#get_chars(start_pos, end_pos) ⇒ String

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:

  • start_pos (Integer) —

    start of text

  • end_pos (Integer) —

    end of text

Returns:

  • (String) —

    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.

#get_selection_bounds(start_pos, end_pos) ⇒ TrueClass

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:

  • start_pos (Integer) —

    location to store the starting position, or nil

  • end_pos (Integer) —

    location to store the end position, or nil

Returns:

  • (TrueClass) —

    true if an area is selected, false otherwise

#insert_text(new_text, new_text_length, position) ⇒ nil

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:

  • new_text (String) —

    the text to append

  • new_text_length (Integer) —

    the length of the text in bytes, or -1

  • position (Integer) —

    location of the position text will be inserted at

Returns:

  • (nil)

#paste_clipboard ⇒ nil

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

Returns:

  • (nil)

#position ⇒ Integer

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:

  • (Integer) —

    the cursor position

#position=(position) ⇒ nil

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 (Integer) —

    the position of the cursor

Returns:

  • (nil)

#select_region(start_pos, end_pos) ⇒ nil

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:

  • start_pos (Integer) —

    start of region

  • end_pos (Integer) —

    end of region

Returns:

  • (nil)

#set_selection_bounds(start_pos, end_pos) ⇒ nil

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:

  • start_pos (Integer) —

    start of region

  • end_pos (Integer) —

    end of region

Returns:

  • (nil)