:right-sidebar: True

CompletionProposal
===================================================================

.. currentmodule:: gi.repository.GtkSource





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






Interface for completion proposals.

This interface is used to denote that an object is capable of being
a completion proposal for :obj:`~gi.repository.GtkSource.Completion`\.

Currently, no method or functions are required but additional methods
may be added in the future. Proposals created by
:obj:`~gi.repository.GtkSource.CompletionProvider` can use :obj:`~gi.repository.GObject.IMPLEMENT_INTERFACE` to
implement this with :const:`None` for the interface init function.




Methods
-------

.. rst-class:: interim-class

.. class:: CompletionProposal
   :no-index:


   .. method:: get_typed_text() -> str | None

      Gets the typed-text for the proposal, if supported by the implementation.

      Implementing this virtual-function is optional, but can be useful to allow
      external tooling to compare results.


      .. versionadded:: 5.6
















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

.. rst-class:: interim-class

.. class:: CompletionProposal
   :no-index:
   

   .. method:: do_get_typed_text() -> str | None

      Gets the typed-text for the proposal, if supported by the implementation.

      Implementing this virtual-function is optional, but can be useful to allow
      external tooling to compare results.


      .. versionadded:: 5.6