:right-sidebar: True

CompletionCell
===================================================================

.. currentmodule:: gi.repository.GtkSource





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


Superclasses: :class:`~gi.repository.Gtk.Widget`, :class:`~gi.repository.GObject.InitiallyUnowned`, :class:`~gi.repository.GObject.Object`



Implemented Interfaces: :class:`~gi.repository.Gtk.Accessible`, :class:`~gi.repository.Gtk.Buildable`, :class:`~gi.repository.Gtk.ConstraintTarget`



Widget for single cell of completion proposal.

The ``GtkSourceCompletionCell`` widget provides a container to display various
types of information with the completion display.

Each proposal may consist of multiple cells depending on the complexity of
the proposal. For example, programming language proposals may contain a cell
for the "left-hand-side" of an operation along with the "typed-text" for a
function name and "parameters". They may also optionally set an icon to
signify the kind of result.

A :obj:`~gi.repository.GtkSource.CompletionProvider` should implement the
:obj:`~gi.repository.CompletionProvider.display` virtual function to control
how to convert data from their :obj:`~gi.repository.GtkSource.CompletionProposal` to content for
the ``GtkSourceCompletionCell``\.




Methods
-------

.. rst-class:: interim-class

.. class:: CompletionCell
   :no-index:


   .. method:: get_column() -> ~gi.repository.GtkSource.CompletionColumn

      









   .. method:: get_widget() -> ~gi.repository.Gtk.Widget | None

      Gets the child :obj:`~gi.repository.Gtk.Widget`\, if any.









   .. method:: set_gicon(gicon: ~gi.repository.Gio.Icon) -> None

      






      :param gicon: 




   .. method:: set_icon_name(icon_name: str) -> None

      






      :param icon_name: 




   .. method:: set_markup(markup: str) -> None

      






      :param markup: 




   .. method:: set_paintable(paintable: ~gi.repository.Gdk.Paintable) -> None

      






      :param paintable: 




   .. method:: set_text(text: str | None = None) -> None

      Sets the text for the column cell. Use :const:`None` to unset.






      :param text: the text to set or :const:`None`




   .. method:: set_text_with_attributes(text: str, attrs: ~gi.repository.Pango.AttrList) -> None

      






      :param text: 

      :param attrs: 




   .. method:: set_widget(child: ~gi.repository.Gtk.Widget) -> None

      






      :param child: 








Properties
----------

.. rst-class:: interim-class

.. class:: CompletionCell
   :no-index:
   

   .. attribute:: props.column
      :type: ~gi.repository.GtkSource.CompletionColumn

      The type of the None singleton.







   .. attribute:: props.markup
      :type: str

      The type of the None singleton.







   .. attribute:: props.paintable
      :type: ~gi.repository.Gdk.Paintable

      The type of the None singleton.







   .. attribute:: props.text
      :type: str

      The type of the None singleton.







   .. attribute:: props.widget
      :type: ~gi.repository.Gtk.Widget

      The type of the None singleton.