:right-sidebar: True

CellRendererCombo
===================================================================

.. currentmodule:: gi.repository.Gtk





.. deprecated:: 4.10

   List views use widgets to display their contents. You
   should use :obj:`~gi.repository.Gtk.DropDown` instead



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


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





Renders a combobox in a cell

``GtkCellRendererCombo`` renders text in a cell like ``GtkCellRendererText`` from
which it is derived. But while ``GtkCellRendererText`` offers a simple entry to
edit the text, ``GtkCellRendererCombo`` offers a ``GtkComboBox``
widget to edit the text. The values to display in the combo box are taken from
the tree model specified in the ``GtkCellRendererCombo``:model property.

The combo cell renderer takes care of adding a text cell renderer to the combo
box and sets it to display the column specified by its
``GtkCellRendererCombo``:text-column property. Further properties of the combo box
can be set in a handler for the ``GtkCellRenderer::editing-started`` signal.



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

.. rst-class:: interim-class

.. class:: CellRendererCombo
   :no-index:


   .. classmethod:: new() -> ~gi.repository.Gtk.CellRenderer

      Creates a new ``GtkCellRendererCombo``.
      Adjust how text is drawn using object properties.
      Object properties can be set globally (with :func:`~gi.repository.GObject.GObject.Object.set`).
      Also, with ``GtkTreeViewColumn``, you can bind a property to a value
      in a ``GtkTreeModel``. For example, you can bind the “text” property
      on the cell renderer to a string value in the model, thus rendering
      a different string in each row of the ``GtkTreeView``.






      .. deprecated:: 4.10

         Please do not use it in newly written code













Properties
----------

.. rst-class:: interim-class

.. class:: CellRendererCombo
   :no-index:
   

   .. attribute:: props.has_entry
      :type: bool

      If :const:`True`, the cell renderer will include an entry and allow to enter
      values other than the ones in the popup list.







   .. attribute:: props.model
      :type: ~gi.repository.Gtk.TreeModel

      Holds a tree model containing the possible values for the combo box.
      Use the text_column property to specify the column holding the values.







   .. attribute:: props.text_column
      :type: int

      Specifies the model column which holds the possible values for the
      combo box.

      Note that this refers to the model specified in the model property,
      not the model backing the tree view to which
      this cell renderer is attached.

      ``GtkCellRendererCombo`` automatically adds a text cell renderer for
      this column to its combo box.











Signals
-------

.. rst-class:: interim-class

.. class:: CellRendererCombo.signals
   :no-index:
   

   .. method:: changed(path_string: str, new_iter: ~gi.repository.Gtk.TreeIter) -> None

      This signal is emitted each time after the user selected an item in
      the combo box, either by using the mouse or the arrow keys.  Contrary
      to GtkComboBox, GtkCellRendererCombo::changed is not emitted for
      changes made to a selected item in the entry.  The argument ``new_iter``
      corresponds to the newly selected item in the combo box and it is relative
      to the GtkTreeModel set via the model property on GtkCellRendererCombo.

      Note that as soon as you change the model displayed in the tree view,
      the tree view will immediately cease the editing operating.  This
      means that you most probably want to refrain from changing the model
      until the combo cell renderer emits the edited or editing_canceled signal.







      :param path_string: a string of the path identifying the edited cell
         (relative to the tree view model)


      :param new_iter: the new iter selected in the combo box
         (relative to the combo box model)