:right-sidebar: True Editable =================================================================== .. currentmodule:: gi.repository.Gtk .. class:: Editable(*args, **kwargs) :no-contents-entry: Implementations: :class:`~gi.repository.Gtk.EditableLabel`, :class:`~gi.repository.Gtk.Entry`, :class:`~gi.repository.Gtk.PasswordEntry`, :class:`~gi.repository.Gtk.SearchEntry`, :class:`~gi.repository.Gtk.SpinButton`, :class:`~gi.repository.Gtk.Text` ``GtkEditable`` is an interface for text editing widgets. Typical examples of editable widgets are :obj:`~gi.repository.Gtk.Entry` and :obj:`~gi.repository.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 modify the behavior of a widget. As an example of the latter usage, by connecting the following handler to :obj:`~gi.repository.Gtk.Editable.signals.insert_text`, an application can convert all entry into a widget into uppercase. Forcing entry to uppercase. --------------------------- .. code-block:: c :dedent: ``include`` void insert_text_handler (GtkEditable *editable, const char *text, int length, int *position, gpointer data) { char *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); } Implementing GtkEditable ------------------------ The most likely scenario for implementing ``GtkEditable`` on your own widget is that you will embed a ``GtkText`` inside a complex widget, and want to delegate the editable functionality to that text widget. ``GtkEditable`` provides some utility functions to make this easy. In your class_init function, call :obj:`~gi.repository.Gtk.Editable.install_properties`, passing the first available property ID: .. code-block:: c :dedent: static void my_class_init (MyClass *class) { ... g_object_class_install_properties (object_class, NUM_PROPERTIES, props); gtk_editable_install_properties (object_clas, NUM_PROPERTIES); ... } In your interface_init function for the ``GtkEditable`` interface, provide an implementation for the get_delegate vfunc that returns your text widget: .. code-block:: c :dedent: GtkEditable * get_editable_delegate (GtkEditable *editable) { return GTK_EDITABLE (MY_WIDGET (editable)->text_widget); } static void my_editable_init (GtkEditableInterface *iface) { iface->get_delegate = get_editable_delegate; } You don't need to provide any other vfuncs. The default implementations work by forwarding to the delegate that the GtkEditableInterface.get_delegate() vfunc returns. In your instance_init function, create your text widget, and then call :obj:`~gi.repository.Gtk.Editable.init_delegate`: .. code-block:: c :dedent: static void my_widget_init (MyWidget *self) { ... self->text_widget = gtk_text_new (); gtk_editable_init_delegate (GTK_EDITABLE (self)); ... } In your dispose function, call :obj:`~gi.repository.Gtk.Editable.finish_delegate` before destroying your text widget: .. code-block:: c :dedent: static void my_widget_dispose (GObject *object) { ... gtk_editable_finish_delegate (GTK_EDITABLE (self)); g_clear_pointer (&self->text_widget, gtk_widget_unparent); ... } Finally, use :obj:`~gi.repository.Gtk.Editable.delegate_set_property` in your ``set_property`` function (and similar for ``get_property``), to set the editable properties: .. code-block:: c :dedent: ... if (gtk_editable_delegate_set_property (object, prop_id, value, pspec)) return; switch (prop_id) ... It is important to note that if you create a ``GtkEditable`` that uses a delegate, the low level :obj:`~gi.repository.Gtk.Editable.signals.insert_text` and :obj:`~gi.repository.Gtk.Editable.signals.delete_text` signals will be propagated from the "wrapper" editable to the delegate, but they will not be propagated from the delegate to the "wrapper" editable, as they would cause an infinite recursion. If you wish to connect to the :obj:`~gi.repository.Gtk.Editable.signals.insert_text` and :obj:`~gi.repository.Gtk.Editable.signals.delete_text` signals, you will need to connect to them on the delegate obtained via :obj:`~gi.repository.Gtk.Editable.get_delegate`. Methods ------- .. rst-class:: interim-class .. class:: Editable :no-index: .. method:: delegate_get_accessible_platform_state(state: ~gi.repository.Gtk.AccessiblePlatformState) -> bool Retrieves the accessible platform state from the editable delegate. This is an helper function to retrieve the accessible state for ``GtkEditable`` interface implementations using a delegate pattern. You should call this function in your editable widget implementation of the :obj:`~gi.repository.Gtk.Accessible.get_platform_state` virtual function, for instance: .. code-block:: c :dedent: static void accessible_interface_init (GtkAccessibleInterface *iface) { iface->get_platform_state = your_editable_get_accessible_platform_state; } static gboolean your_editable_get_accessible_platform_state (GtkAccessible *accessible, GtkAccessiblePlatformState state) { return gtk_editable_delegate_get_accessible_platform_state (GTK_EDITABLE (accessible), state); } .. versionadded:: 4.10 :param state: what kind of accessible state to retrieve .. method:: delegate_get_property(object: ~gi.repository.GObject.Object, prop_id: int, value: ~typing.Any, pspec: ~gi.repository.GObject.ParamSpec) -> bool Gets a property of the ``GtkEditable`` delegate for ``object``. This is helper function that should be called in the ``get_property`` function of your ``GtkEditable`` implementation, before handling your own properties. :param object: a ``GObject`` :param prop_id: a property ID :param value: value to set :param pspec: the ``GParamSpec`` for the property .. method:: delegate_set_property(object: ~gi.repository.GObject.Object, prop_id: int, value: ~typing.Any, pspec: ~gi.repository.GObject.ParamSpec) -> bool Sets a property on the ``GtkEditable`` delegate for ``object``. This is a helper function that should be called in the ``set_property`` function of your ``GtkEditable`` implementation, before handling your own properties. :param object: a ``GObject`` :param prop_id: a property ID :param value: value to set :param pspec: the ``GParamSpec`` for the property .. method:: delete_selection() -> None Deletes the currently selected text of the editable. This call doesn’t do anything if there is no selected text. .. method:: delete_text(start_pos: int, end_pos: int) -> None 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. :param start_pos: start position :param end_pos: end position .. method:: finish_delegate() -> None Undoes the setup done by :obj:`~gi.repository.Gtk.Editable.init_delegate`. This is a helper function that should be called from dispose, before removing the delegate object. .. method:: get_alignment() -> float Gets the alignment of the editable. .. method:: get_chars(start_pos: int, end_pos: int) -> 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. :param start_pos: start of text :param end_pos: end of text .. method:: get_delegate() -> ~gi.repository.Gtk.Editable | None Gets the ``GtkEditable`` that ``editable`` is delegating its implementation to. Typically, the delegate is a :obj:`~gi.repository.Gtk.Text` widget. .. method:: get_editable() -> bool Retrieves whether ``editable`` is editable. .. method:: get_enable_undo() -> bool Gets if undo/redo actions are enabled for ``editable`` .. method:: get_max_width_chars() -> int Retrieves the desired maximum width of ``editable``, in characters. .. method:: get_position() -> 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. .. method:: get_selection_bounds() -> tuple[bool, int, 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 :const:`False` will be returned. Note that positions are specified in characters, not bytes. .. method:: get_text() -> str Retrieves the contents of ``editable``. The returned string is owned by GTK and must not be modified or freed. .. method:: get_width_chars() -> int Gets the number of characters of space reserved for the contents of the editable. .. method:: init_delegate() -> None Sets up a delegate for ``GtkEditable``. This is assuming that the get_delegate vfunc in the ``GtkEditable`` interface has been set up for the ``editable``'s type. This is a helper function that should be called in instance init, after creating the delegate object. .. method:: insert_text(text, position) Inserts ``length`` bytes of ``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. :param text: the text to insert :param position: location of the position text will be inserted at .. method:: install_properties(object_class: ~gi.repository.GObject.ObjectClass, first_prop: int) -> int Overrides the ``GtkEditable`` properties for ``class``. This is a helper function that should be called in class_init, after installing your own properties. Note that your class must have "text", "cursor-position", "selection-bound", "editable", "width-chars", "max-width-chars", "xalign" and "enable-undo" properties for this function to work. To handle the properties in your set_property and get_property functions, you can either use :obj:`~gi.repository.Gtk.Editable.delegate_set_property` and :obj:`~gi.repository.Gtk.Editable.delegate_get_property` (if you are using a delegate), or remember the ``first_prop`` offset and add it to the values in the :obj:`~gi.repository.Gtk.EditableProperties` enumeration to get the property IDs for these properties. :param object_class: a ``GObjectClass`` :param first_prop: property ID to use for the first property .. method:: select_region(start_pos: int, end_pos: int) -> None 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. :param start_pos: start of region :param end_pos: end of region .. method:: set_alignment(xalign: float) -> None Sets the alignment for the contents of the editable. This controls the horizontal positioning of the contents when the displayed text is shorter than the width of the editable. :param xalign: The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts .. method:: set_editable(is_editable: bool) -> None Determines if the user can edit the text in the editable widget. :param is_editable: :const:`True` if the user is allowed to edit the text in the widget .. method:: set_enable_undo(enable_undo: bool) -> None If enabled, changes to ``editable`` will be saved for undo/redo actions. This results in an additional copy of text changes and are not stored in secure memory. As such, undo is forcefully disabled when :obj:`~gi.repository.Gtk.Text.props.visibility` is set to :const:`False`. :param enable_undo: if undo/redo should be enabled .. method:: set_max_width_chars(n_chars: int) -> None Sets the desired maximum width in characters of ``editable``. :param n_chars: the new desired maximum width, in characters .. method:: set_position(position: int) -> None 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. :param position: the position of the cursor .. method:: set_text(text: str) -> None Sets the text in the editable to the given value. This is replacing the current contents. :param text: the text to set .. method:: set_width_chars(n_chars: int) -> None Changes the size request of the editable to be about the right size for ``n_chars`` characters. Note that it changes the size request, the size can still be affected by how you pack the widget into containers. If ``n_chars`` is -1, the size reverts to the default size. :param n_chars: width in chars Properties ---------- .. rst-class:: interim-class .. class:: Editable :no-index: .. attribute:: props.cursor_position :type: int The current position of the insertion cursor in chars. .. attribute:: props.editable :type: bool Whether the entry contents can be edited. .. attribute:: props.enable_undo :type: bool If undo/redo should be enabled for the editable. .. attribute:: props.max_width_chars :type: int The desired maximum width of the entry, in characters. .. attribute:: props.selection_bound :type: int The position of the opposite end of the selection from the cursor in chars. .. attribute:: props.text :type: str The contents of the entry. .. attribute:: props.width_chars :type: int Number of characters to leave space for in the entry. .. attribute:: props.xalign :type: float The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts. Signals ------- .. rst-class:: interim-class .. class:: Editable.signals :no-index: .. method:: changed() -> None Emitted at the end of a single user-visible operation on the contents. 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). .. method:: delete_text(start_pos: int, end_pos: int) -> None 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 :func:`~gi.repository.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 :obj:`~gi.repository.Gtk.Editable.delete_text`. :param start_pos: the starting position :param end_pos: the end position .. method:: insert_text(text: str, length: int) -> int 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 :func:`~gi.repository.GObject.signal_stop_emission`, it is possible to modify the inserted text, or prevent it from being inserted entirely. :param text: the new text to insert :param length: the length of the new text, in bytes, or -1 if new_text is nul-terminated Virtual Methods --------------- .. rst-class:: interim-class .. class:: Editable :no-index: .. method:: do_changed() -> None .. method:: do_delete_text(start_pos: int, end_pos: int) -> None 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. :param start_pos: start position :param end_pos: end position .. method:: do_do_delete_text(start_pos: int, end_pos: int) -> None 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. :param start_pos: start position :param end_pos: end position .. method:: do_do_insert_text(text: str, length: int) -> int Inserts ``length`` bytes of ``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. :param text: the text to insert :param length: the length of the text in bytes, or -1 .. method:: do_get_delegate() -> ~gi.repository.Gtk.Editable | None Gets the ``GtkEditable`` that ``editable`` is delegating its implementation to. Typically, the delegate is a :obj:`~gi.repository.Gtk.Text` widget. .. method:: do_get_selection_bounds() -> tuple[bool, int, 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 :const:`False` will be returned. Note that positions are specified in characters, not bytes. .. method:: do_get_text() -> str Retrieves the contents of ``editable``. The returned string is owned by GTK and must not be modified or freed. .. method:: do_insert_text(text: str, length: int) -> int Inserts ``length`` bytes of ``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. :param text: the text to insert :param length: the length of the text in bytes, or -1 .. method:: do_set_selection_bounds(start_pos: int, end_pos: int) -> None 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. :param start_pos: start of region :param end_pos: end of region