:right-sidebar: True

AccessibleText
===================================================================

.. currentmodule:: gi.repository.Gtk


.. versionadded:: 4.14




.. class:: AccessibleText(*args, **kwargs)
   :no-contents-entry:





Implementations: :class:`~gi.repository.Gtk.Inscription`, :class:`~gi.repository.Gtk.Label`, :class:`~gi.repository.Gtk.Text`, :class:`~gi.repository.Gtk.TextView`


An interface for accessible objects containing formatted text.

The ``GtkAccessibleText`` interfaces is meant to be implemented by accessible
objects that have text formatted with attributes, or non-trivial text contents.

You should use the :obj:`~gi.repository.Gtk.AccessibleProperty.LABEL` or the
:obj:`~gi.repository.Gtk.AccessibleProperty.DESCRIPTION` properties for accessible
objects containing simple, unformatted text.





Methods
-------

.. rst-class:: interim-class

.. class:: AccessibleText
   :no-index:


   .. method:: update_caret_position() -> None

      Updates the position of the caret.

      Implementations of the ``GtkAccessibleText`` interface should call this
      function every time the caret has moved, in order to notify assistive
      technologies.



      .. versionadded:: 4.14








   .. method:: update_contents(change: ~gi.repository.Gtk.AccessibleTextContentChange, start: int, end: int) -> None

      Notifies assistive technologies of a change in contents.

      Implementations of the ``GtkAccessibleText`` interface should call this
      function every time their contents change as the result of an operation,
      like an insertion or a removal.

      Note: If the change is a deletion, this function must be called *before*
      removing the contents, if it is an insertion, it must be called *after*
      inserting the new contents.



      .. versionadded:: 4.14





      :param change: the type of change in the contents


      :param start: the starting offset of the change, in characters


      :param end: the end offset of the change, in characters





   .. method:: update_selection_bound() -> None

      Updates the boundary of the selection.

      Implementations of the ``GtkAccessibleText`` interface should call this
      function every time the selection has moved, in order to notify assistive
      technologies.



      .. versionadded:: 4.14
















Virtual Methods
---------------

.. rst-class:: interim-class

.. class:: AccessibleText
   :no-index:
   

   .. method:: do_get_attributes(offset: int) -> tuple[bool, list[~gi.repository.Gtk.AccessibleTextRange], list[str], list[str]]

      Retrieves the text attributes inside the accessible object.

      Each attribute is composed by:


      - a range
      - a name
      - a value

      It is left to the implementation to determine the serialization format
      of the value to a string.

      GTK provides support for various text attribute names and values, but
      implementations of this interface are free to add their own attributes.

      If this function returns true, ``n_ranges`` will be set to a value
      greater than or equal to one, ``ranges`` will be set to a newly
      allocated array of [struct#Gtk.AccessibleTextRange].



      .. versionadded:: 4.14





      :param offset: the offset, in characters





   .. method:: do_get_caret_position() -> int

      Retrieves the position of the caret inside the accessible object.



      .. versionadded:: 4.14








   .. method:: do_get_contents(start: int, end: int) -> ~gi.repository.GLib.Bytes

      Retrieve the current contents of the accessible object within
      the given range.

      If ``end`` is ``G_MAXUINT``, the end of the range is the full content
      of the accessible object.



      .. versionadded:: 4.14





      :param start: the beginning of the range, in characters


      :param end: the end of the range, in characters





   .. method:: do_get_contents_at(offset: int, granularity: ~gi.repository.Gtk.AccessibleTextGranularity) -> tuple[~gi.repository.GLib.Bytes, int, int]

      Retrieve the current contents of the accessible object starting
      from the given offset, and using the given granularity.

      The ``start`` and ``end`` values contain the boundaries of the text.



      .. versionadded:: 4.14





      :param offset: the offset, in characters


      :param granularity: the granularity of the query





   .. method:: do_get_default_attributes() -> tuple[list[str], list[str]]

      Retrieves the default text attributes inside the accessible object.

      Each attribute is composed by:


      - a name
      - a value

      It is left to the implementation to determine the serialization format
      of the value to a string.

      GTK provides support for various text attribute names and values, but
      implementations of this interface are free to add their own attributes.



      .. versionadded:: 4.14








   .. method:: do_get_selection() -> tuple[bool, list[~gi.repository.Gtk.AccessibleTextRange]]

      Retrieves the selection ranges in the accessible object.

      If this function returns true, ``n_ranges`` will be set to a value
      greater than or equal to one, and ``ranges`` will be set to a newly
      allocated array of [struct#Gtk.AccessibleTextRange].



      .. versionadded:: 4.14