Struct gtk4::CellRendererCombo

#[repr(transparent)]
pub struct CellRendererCombo { /* private fields */ }

List views use widgets to display their contents. You should use DropDown instead Renders a combobox in a cell

CellRendererCombo renders text in a cell like CellRendererText from which it is derived. But while CellRendererText offers a simple entry to edit the text, CellRendererCombo offers a ComboBox widget to edit the text. The values to display in the combo box are taken from the tree model specified in the CellRendererCombo: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 CellRendererCombo:text-column property. Further properties of the combo box can be set in a handler for the GtkCellRenderer::editing-started signal.

Properties

has-entry

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

Readable | Writeable

model

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

Readable | Writeable

text-column

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.

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

Readable | Writeable

CellRendererText

align-set

Readable | Writeable

alignment

Specifies how to align the lines of text with respect to each other.

Note that this property describes how to align the lines of text in case there are several of them. The “xalign” property of CellRenderer, on the other hand, sets the horizontal alignment of the whole text.

Readable | Writeable

attributes

Readable | Writeable

background

Writeable

background-rgba

Background color as a gdk::RGBA

Readable | Writeable

background-set

Readable | Writeable

editable

Readable | Writeable

editable-set

Readable | Writeable

ellipsize

Specifies the preferred place to ellipsize the string, if the cell renderer does not have enough room to display the entire string. Setting it to pango::EllipsizeMode::None turns off ellipsizing. See the wrap-width property for another way of making the text fit into a given width.

Readable | Writeable

ellipsize-set

Readable | Writeable

family

Readable | Writeable

family-set

Readable | Writeable

font

Readable | Writeable

font-desc

Readable | Writeable

foreground

Writeable

foreground-rgba

Foreground color as a gdk::RGBA

Readable | Writeable

foreground-set

Readable | Writeable

language

Readable | Writeable

language-set

Readable | Writeable

markup

Writeable

max-width-chars

The desired maximum width of the cell, in characters. If this property is set to -1, the width will be calculated automatically.

For cell renderers that ellipsize or wrap text; this property controls the maximum reported width of the cell. The cell should not receive any greater allocation unless it is set to expand in its CellLayout and all of the cell’s siblings have received their natural width.

Readable | Writeable

placeholder-text

The text that will be displayed in the CellRenderer if GtkCellRendererText:editable is true and the cell is empty.

Readable | Writeable

rise

Readable | Writeable

rise-set

Readable | Writeable

scale

Readable | Writeable

scale-set

Readable | Writeable

single-paragraph-mode

Readable | Writeable

size

Readable | Writeable

size-points

Readable | Writeable

size-set

Readable | Writeable

stretch

Readable | Writeable

stretch-set

Readable | Writeable

strikethrough

Readable | Writeable

strikethrough-set

Readable | Writeable

style

Readable | Writeable

style-set

Readable | Writeable

text

Readable | Writeable

underline

Readable | Writeable

underline-set

Readable | Writeable

variant

Readable | Writeable

variant-set

Readable | Writeable

weight

Readable | Writeable

weight-set

Readable | Writeable

width-chars

The desired width of the cell, in characters. If this property is set to -1, the width will be calculated automatically, otherwise the cell will request either 3 characters or the property value, whichever is greater.

Readable | Writeable

wrap-mode

Specifies how to break the string into multiple lines, if the cell renderer does not have enough room to display the entire string. This property has no effect unless the wrap-width property is set.

Readable | Writeable

wrap-width

Specifies the minimum width at which the text is wrapped. The wrap-mode property can be used to influence at what character positions the line breaks can be placed. Setting wrap-width to -1 turns wrapping off.

Readable | Writeable

CellRenderer

cell-background

Writeable

cell-background-rgba

Cell background as a gdk::RGBA

Readable | Writeable

cell-background-set

Readable | Writeable

editing

Readable

height

Readable | Writeable

is-expanded

Readable | Writeable

is-expander

Readable | Writeable

mode

Readable | Writeable

sensitive

Readable | Writeable

visible

Readable | Writeable

width

Readable | Writeable

xalign

Readable | Writeable

xpad

Readable | Writeable

yalign

Readable | Writeable

ypad

Readable | Writeable

Signals

changed

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.

CellRendererText

edited

This signal is emitted after @renderer has been edited.

It is the responsibility of the application to update the model and store @new_text at the position indicated by @path.

CellRenderer

editing-canceled

This signal gets emitted when the user cancels the process of editing a cell. For example, an editable cell renderer could be written to cancel editing when the user presses Escape.

See also: gtk_cell_renderer_stop_editing().

editing-started

This signal gets emitted when a cell starts to be edited. The intended use of this signal is to do special setup on @editable, e.g. adding a EntryCompletion or setting up additional columns in a ComboBox.

See gtk_cell_editable_start_editing() for information on the lifecycle of the @editable and a way to do setup that doesn’t depend on the @renderer.

Note that GTK doesn’t guarantee that cell renderers will continue to use the same kind of widget for editing in future releases, therefore you should check the type of @editable before doing any specific setup, as in the following example:

⚠️ The following code is in C ⚠️

static void
text_editing_started (GtkCellRenderer *cell,
                      GtkCellEditable *editable,
                      const char      *path,
                      gpointer         data)
{
  if (GTK_IS_ENTRY (editable))
    {
      GtkEntry *entry = GTK_ENTRY (editable);

      // ... create a GtkEntryCompletion

      gtk_entry_set_completion (entry, completion);
    }
}

Implements

CellRendererTextExt, CellRendererExt, glib::ObjectExt, [CellRendererExtManual][trait@crate::prelude::CellRendererExtManual]

Implementations

impl CellRendererCombo

pub fn new() -> CellRendererCombo

Creates a new CellRendererCombo. Adjust how text is drawn using object properties. Object properties can be set globally (with g_object_set()). Also, with TreeViewColumn, you can bind a property to a value in a TreeModel. 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 TreeView.

Deprecated since 4.10

Returns

the new cell renderer

pub fn builder() -> CellRendererComboBuilder

Creates a new builder-pattern struct instance to construct CellRendererCombo objects.

This method returns an instance of CellRendererComboBuilder which can be used to create CellRendererCombo objects.

pub fn has_entry(&self) -> bool

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

pub fn set_has_entry(&self, has_entry: bool)

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

pub fn model(&self) -> Option<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.

pub fn set_model<P: IsA<TreeModel>>(&self, model: Option<&P>)

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

pub fn text_column(&self) -> i32

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.

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

pub fn set_text_column(&self, text_column: i32)

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.

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

pub fn connect_changed<F: Fn(&Self, TreePath, &TreeIter) + 'static>( &self, f: F ) -> SignalHandlerId

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.

path_string

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

new_iter

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

pub fn connect_has_entry_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_model_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_text_column_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Trait Implementations

impl Clone for CellRendererCombo

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CellRendererCombo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CellRendererCombo

fn default() -> Self

Returns the “default value” for a type.

impl Display for CellRendererCombo

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for CellRendererCombo

type ParamSpec = ParamSpecObject

type SetValue = CellRendererCombo

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, CellRendererCombo>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for CellRendererCombo

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CellRendererCombo

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for CellRendererCombo

type Parent = CellRendererText

impl<OT: ObjectType> PartialEq<OT> for CellRendererCombo

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for CellRendererCombo

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for CellRendererCombo

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for CellRendererCombo

impl IsA<CellRenderer> for CellRendererCombo

impl IsA<CellRendererText> for CellRendererCombo