:right-sidebar: True

CompletionWords
===================================================================

.. currentmodule:: gi.repository.GtkSource





.. class:: CompletionWords(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.GObject.Object`



Implemented Interfaces: :class:`~gi.repository.GtkSource.CompletionProvider`



A :obj:`~gi.repository.GtkSource.CompletionProvider` for the completion of words.

The ``GtkSourceCompletionWords`` is an example of an implementation of
the :obj:`~gi.repository.GtkSource.CompletionProvider` interface. The proposals are words
appearing in the registered :obj:`~gi.repository.Gtk.TextBuffer`\s.


Constructors
------------

.. rst-class:: interim-class

.. class:: CompletionWords
   :no-index:


   .. classmethod:: new(title: str | None = None) -> ~gi.repository.GtkSource.CompletionWords

      






      :param title: The title for the provider, or :const:`None`.








Methods
-------

.. rst-class:: interim-class

.. class:: CompletionWords
   :no-index:


   .. method:: register(buffer: ~gi.repository.Gtk.TextBuffer) -> None

      Registers ``buffer`` in the ``words`` provider.






      :param buffer: a :obj:`~gi.repository.Gtk.TextBuffer`




   .. method:: unregister(buffer: ~gi.repository.Gtk.TextBuffer) -> None

      Unregisters ``buffer`` from the ``words`` provider.






      :param buffer: a :obj:`~gi.repository.Gtk.TextBuffer`








Properties
----------

.. rst-class:: interim-class

.. class:: CompletionWords
   :no-index:
   

   .. attribute:: props.minimum_word_size
      :type: int

      The type of the None singleton.







   .. attribute:: props.priority
      :type: int

      The type of the None singleton.







   .. attribute:: props.proposals_batch_size
      :type: int

      The type of the None singleton.







   .. attribute:: props.scan_batch_size
      :type: int

      The type of the None singleton.







   .. attribute:: props.title
      :type: str

      The type of the None singleton.















Fields
------

.. rst-class:: interim-class

.. class:: CompletionWords
   :no-index:
   

   .. attribute:: parent_instance