Struct gtk4::ComboBoxText[][src]

pub struct ComboBoxText(_);
Expand description

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

An example GtkComboBoxText

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(). The entry itself can be accessed by calling ComboBoxExt::child() on the combo box.

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

GtkComboBoxText as GtkBuildable

The ComboBoxText implementation of the Buildable interface supports adding items directly using the <items> element and specifying <item> elements for each item. Each <item> 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

Creates a new ComboBoxText.

Returns

A new ComboBoxText

pub fn with_entry() -> ComboBoxText

Creates a new ComboBoxText with an entry.

Returns

a new ComboBoxText

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.

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, or None

text

A string

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

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().

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, or None

text

A string to display

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

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, or None

text

a string

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

Removes the string at position from self.

position

Index of the item to remove

Removes all the text entries from the combo box.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

Formats the value using the given formatter. Read more

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

This method returns an Ordering between self and other. Read more

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

Restrict a value to a certain interval. Read more

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

This method tests for !=.

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

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

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

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

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

Returns the type identifier of Self.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Upcasts an object to a superclass or interface T. Read more

Upcasts an object to a reference of its superclass or interface T. Read more

Tries to downcast to a subclass or interface implementor T. Read more

Tries to downcast to a reference of its subclass or interface implementor T. Read more

Tries to cast to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more

Tries to cast to reference to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more

Casts to T unconditionally. Read more

Casts to &T unconditionally. Read more

Performs the conversion.

Performs the conversion.

Returns true if the object is an instance of (can be cast to) T.

Safety Read more

Safety Read more

Safety Read more

Safety Read more

Safety Read more

Safety Read more

Same as connect but takes a SignalId instead of a signal name.

Same as connect_local but takes a SignalId instead of a signal name.

Same as connect_unsafe but takes a SignalId instead of a signal name.

Emit signal by signal id.

Same as emit but takes Value for the arguments.

Emit signal by its name.

Same as emit_by_name but takes Value for the arguments.

Emit signal with details by signal id.

Same as emit_with_details but takes Value for the arguments.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

Returns a SendValue clone of self.

Converts the given value to a String. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.