:right-sidebar: True

Completion
===================================================================

.. currentmodule:: gi.repository.GLib





.. deprecated:: 2.26

   Rarely used API



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






:Constructors:

::

    Completion()





Methods
-------

.. rst-class:: interim-class

.. class:: Completion
   :no-index:


   .. method:: clear_items() -> None

      Removes all items from the :obj:`~gi.repository.GLib.Completion`. The items are not freed, so if the
      memory was dynamically allocated, it should be freed after calling this
      function.






      .. deprecated:: 2.26

         Rarely used API







   .. method:: complete_utf8(prefix: str, new_prefix: str) -> list[str]

      Attempts to complete the string ``prefix`` using the :obj:`~gi.repository.GLib.Completion` target items.
      In contrast to :func:`~gi.repository.GLib.Completion.complete`, this function returns the largest common
      prefix that is a valid UTF-8 string, omitting a possible common partial
      character.

      You should use this function instead of :func:`~gi.repository.GLib.Completion.complete` if your
      items are UTF-8 strings.



      .. versionadded:: 2.4




      .. deprecated:: 2.26

         Rarely used API




      :param prefix: the prefix string, typically used by the user, which is compared
         with each of the items


      :param new_prefix: if non-:const:`None`, returns the longest prefix which is common to all
         items that matched ``prefix``, or :const:`None` if no items matched ``prefix``.
         This string should be freed when no longer needed.





   .. method:: free() -> None

      Frees all memory used by the :obj:`~gi.repository.GLib.Completion`. The items are not freed, so if
      the memory was dynamically allocated, it should be freed after calling this
      function.






      .. deprecated:: 2.26

         Rarely used API

















Fields
------

.. rst-class:: interim-class

.. class:: Completion
   :no-index:
   

   .. attribute:: cache

      The list of items which begin with ``prefix``.







   .. attribute:: func

      Function which is called to get the string associated with a
      target item. It is :const:`None` if the target items are strings.







   .. attribute:: items

      List of target items (strings or data structures).







   .. attribute:: prefix

      The last prefix passed to :func:`~gi.repository.GLib.Completion.complete` or
      :func:`~gi.repository.GLib.Completion.complete_utf8`.







   .. attribute:: strncmp_func

      The function to use when comparing strings.  Use
      :func:`~gi.repository.GLib.Completion.set_compare` to modify this function.