Struct gtk4::ComboBoxText

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

A ComboBoxText is a simple variant of ComboBox for text-only use cases.

ComboBoxText hides the model-view complexity of ComboBox.

To create a ComboBoxText, use new() or with_entry().

You can add items to a ComboBoxText with append_text(), insert_text() or prepend_text() and remove options with remove().

If the ComboBoxText contains an entry (via the property::ComboBox::has-entry property), its contents can be retrieved using active_text().

You should not call ComboBoxExt::set_model() or attempt to pack more cells into this combo box via its CellLayout interface.

GtkComboBoxText as GtkBuildable

The ComboBoxText implementation of the Buildable interface supports adding items directly using the element and specifying elements for each item. Each element can specify the “id” corresponding to the appended text and also supports the regular translation attributes “translatable”, “context” and “comments”.

Here is a UI definition fragment specifying ComboBoxText items:

<object class="GtkComboBoxText">
  <items>
    <item translatable="yes" id="factory">Factory</item>
    <item translatable="yes" id="home">Home</item>
    <item translatable="yes" id="subway">Subway</item>
  </items>
</object>

CSS nodes

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

ComboBoxText has a single CSS node with name combobox. It adds the style class .combo to the main CSS nodes of its entry and button children, and the .linked class to the node of its internal box.

Implements

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

Implementations

impl ComboBoxText

pub fn new() -> ComboBoxText

Creates a new ComboBoxText.

Returns

A new ComboBoxText

pub fn with_entry() -> ComboBoxText

Creates a new ComboBoxText with an entry.

Returns

a new ComboBoxText

pub fn builder() -> ComboBoxTextBuilder

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

This method returns an instance of ComboBoxTextBuilder which can be used to create ComboBoxText objects.

pub fn append(&self, id: Option<&str>, text: &str)

Appends @text to the list of strings stored in @self.

If @id is non-None then it is used as the ID of the row.

This is the same as calling insert() with a position of -1.

id

a string ID for this value

text

A string

pub fn append_text(&self, text: &str)

Appends @text to the list of strings stored in @self.

This is the same as calling insert_text() with a position of -1.

text

A string

pub fn active_text(&self) -> Option<GString>

Returns the currently active string in @self.

If no row is currently selected, None is returned. If @self contains an entry, this function will return its contents (which will not necessarily be an item from the list).

Returns

a newly allocated string containing the currently active text. Must be freed with g_free().

pub fn insert(&self, position: i32, id: Option<&str>, text: &str)

Inserts @text at @position in the list of strings stored in @self.

If @id is non-None then it is used as the ID of the row. See property::ComboBox::id-column.

If @position is negative then @text is appended.

position

An index to insert @text

id

a string ID for this value

text

A string to display

pub fn insert_text(&self, position: i32, text: &str)

Inserts @text at @position in the list of strings stored in @self.

If @position is negative then @text is appended.

This is the same as calling insert() with a None ID string.

position

An index to insert @text

text

A string

pub fn prepend(&self, id: Option<&str>, text: &str)

Prepends @text to the list of strings stored in @self.

If @id is non-None then it is used as the ID of the row.

This is the same as calling insert() with a position of 0.

id

a string ID for this value

text

a string

pub fn prepend_text(&self, text: &str)

Prepends @text to the list of strings stored in @self.

This is the same as calling insert_text() with a position of 0.

text

A string

pub fn remove(&self, position: i32)

Removes the string at @position from @self.

position

Index of the item to remove

pub fn remove_all(&self)

Removes all the text entries from the combo box.

Trait Implementations

impl Clone for ComboBoxText

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 ComboBoxText

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

Formats the value using the given formatter.

impl Default for ComboBoxText

fn default() -> Self

Returns the “default value” for a type.

impl Display for ComboBoxText

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

Formats the value using the given formatter.

impl Hash for ComboBoxText

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 ComboBoxText

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 ComboBoxText

type Parent = ComboBox

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

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 ComboBoxText

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 ComboBoxText

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ComboBoxText

impl IsA<Accessible> for ComboBoxText

impl IsA<Buildable> for ComboBoxText

impl IsA<CellEditable> for ComboBoxText

impl IsA<CellLayout> for ComboBoxText

impl IsA<ComboBox> for ComboBoxText

impl IsA<ConstraintTarget> for ComboBoxText

impl IsA<Widget> for ComboBoxText