Struct gtk4::ComboBox

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

A ComboBox is a widget that allows the user to choose from a list of valid choices.

The ComboBox displays the selected choice; when activated, the ComboBox displays a popup which allows the user to make a new choice.

The ComboBox uses the model-view pattern; the list of valid choices is specified in the form of a tree model, and the display of the choices can be adapted to the data in the model by using cell renderers, as you would in a tree view. This is possible since ComboBox implements the CellLayout interface. The tree model holding the valid choices is not restricted to a flat list, it can be a real tree, and the popup will reflect the tree structure.

To allow the user to enter values not in the model, the property::ComboBox::has-entry property allows the ComboBox to contain a Entry. This entry can be accessed by calling ComboBoxExt::child() on the combo box.

For a simple list of textual choices, the model-view API of ComboBox can be a bit overwhelming. In this case, ComboBoxText offers a simple alternative. Both ComboBox and ComboBoxText can contain an entry.

CSS nodes

combobox
├── box.linked
│   ╰── button.combo
│       ╰── box
│           ├── cellview
│           ╰── arrow
╰── window.popup

A normal combobox contains a box with the .linked class, a button with the .combo class and inside those buttons, there are a cellview and an arrow.

combobox
├── box.linked
│   ├── entry.combo
│   ╰── button.combo
│       ╰── box
│           ╰── arrow
╰── window.popup

A ComboBox with an entry has a single CSS node with name combobox. It contains a box with the .linked class. That box contains an entry and a button, both with the .combo class added. The button also contains another node with name arrow.

Accessibility

ComboBox uses the AccessibleRole::ComboBox role.

Implements

ComboBoxExt, WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, CellEditableExt, CellLayoutExt, ComboBoxExtManual, WidgetExtManual, AccessibleExtManual, CellEditableExtManual, CellLayoutExtManual

Implementations

impl ComboBox

pub const NONE: Option<&'static ComboBox> = None

pub fn new() -> ComboBox

Creates a new empty ComboBox.

Returns

A new ComboBox

pub fn with_entry() -> ComboBox

Creates a new empty ComboBox with an entry.

In order to use a combo box with entry, you need to tell it which column of the model contains the text for the entry by calling ComboBoxExt::set_entry_text_column().

Returns

A new ComboBox

pub fn with_model(model: &impl IsA<TreeModel>) -> ComboBox

Creates a new ComboBox with a model.

model

a TreeModel

Returns

A new ComboBox

pub fn with_model_and_entry(model: &impl IsA<TreeModel>) -> ComboBox

Creates a new empty ComboBox with an entry and a model.

See also with_entry().

model

A TreeModel

Returns

A new ComboBox

pub fn builder() -> ComboBoxBuilder

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

This method returns an instance of ComboBoxBuilder which can be used to create ComboBox objects.

Trait Implementations

impl Clone for ComboBox

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 ComboBox

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

Formats the value using the given formatter.

impl Default for ComboBox

fn default() -> Self

Returns the “default value” for a type.

impl Display for ComboBox

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

Formats the value using the given formatter.

impl Hash for ComboBox

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<T: ComboBoxImpl> IsSubclassable<T> for ComboBox

fn class_init(class: &mut Class<Self>)

Override the virtual methods of this class for the given subclass and do other class initialization.

fn instance_init(instance: &mut InitializingObject<T>)

Instance specific initialization.

impl Ord for ComboBox

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 ComboBox

type Parent = Widget

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

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 ComboBox

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 ComboBox

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ComboBox

impl IsA<Accessible> for ComboBox

impl IsA<Buildable> for ComboBox

impl IsA<CellEditable> for ComboBox

impl IsA<CellLayout> for ComboBox

impl IsA<ComboBox> for ComboBoxText

impl IsA<ConstraintTarget> for ComboBox

impl IsA<Widget> for ComboBox