Struct gtk4::ComboBoxText

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

Use DropDown with a StringList instead 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().

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, CellLayoutExtManual

Implementations§

source

pub fn with_entry() -> ComboBoxText

Creates a new ComboBoxText with an entry.

Deprecated since 4.10

Use DropDown

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.

Deprecated since 4.10

Use DropDown

id

a string ID for this value

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.

Deprecated since 4.10

Use DropDown

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

Deprecated since 4.10

Use DropDown

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.

Deprecated since 4.10

Use DropDown

position

An index to insert @text

id

a string ID for this value

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.

Deprecated since 4.10

Use DropDown

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.

Deprecated since 4.10

Use DropDown

id

a string ID for this value

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.

Deprecated since 4.10

Use DropDown

text

A string

Removes the string at @position from @self.

Deprecated since 4.10

Use DropDown

position

Index of the item to remove

Removes all the text entries from the combo box.

Deprecated since 4.10

Use DropDown

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more
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§

Updates an array of accessible properties. Read more
Updates an array of accessible relations. Read more
Updates an array of accessible states. Read more
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

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Returns true if the object is an instance of (can be cast to) T.
Returns the type of the object.
Returns the ObjectClass of the object. Read more
Returns the class of the object.
Returns the class of the object in the given type T. Read more
Returns the interface T of the object. Read more
Sets the property property_name of the object to value value. Read more
Sets the property property_name of the object to value value. Read more
Sets multiple properties of the object at once. Read more
Sets multiple properties of the object at once. Read more
Gets the property property_name of the object and cast it to the type V. Read more
Gets the property property_name of the object. Read more
Check if the object has a property property_name of the given type_. Read more
Get the type of the property property_name of this object. Read more
Get the ParamSpec of the property property_name of this object.
Return all ParamSpec of the properties of this object.
Freeze all property notifications until the return guard object is dropped. Read more
Set arbitrary data on this object with the given key. Read more
Return previously set arbitrary data of this object with the given key. Read more
Retrieve previously set arbitrary data of this object with the given key. Read more
Set arbitrary data on this object with the given key. Read more
Return previously set arbitrary data of this object with the given key. Read more
Retrieve previously set arbitrary data of this object with the given key. Read more
Block a given signal handler. Read more
Unblock a given signal handler.
Stop emission of the currently emitted signal.
Stop emission of the currently emitted signal by the (possibly detailed) signal name.
Connect to the signal signal_name on this object. Read more
Connect to the signal signal_id on this object. Read more
Connect to the signal signal_name on this object. Read more
Connect to the signal signal_id on this object. Read more
Connect to the signal signal_name on this object. Read more
Connect to the signal signal_id on this object. Read more
Connect a closure to the signal signal_name on this object. Read more
Connect a closure to the signal signal_id on this object. Read more
Limits the lifetime of closure to the lifetime of the object. When the object’s reference count drops to zero, the closure will be invalidated. An invalidated closure will ignore any calls to invoke_with_values, or invoke when using Rust closures. Read more
Emit signal by signal id. Read more
Same as Self::emit but takes Value for the arguments.
Emit signal by its name. Read more
Emit signal by its name. Read more
Emit signal by its name with details. Read more
Emit signal by its name with details. Read more
Emit signal by signal id with details. Read more
Emit signal by signal id with details. Read more
Disconnect a previously connected signal handler.
Connect to the notify signal of the object. Read more
Connect to the notify signal of the object. Read more
Connect to the notify signal of the object. Read more
Notify that the given property has changed its value. Read more
Notify that the given property has changed its value. Read more
Downgrade this object to a weak reference.
Add a callback to be notified when the Object is disposed.
Add a callback to be notified when the Object is disposed. Read more
Bind property source_property on this object to the target_property on the target object. Read more
Returns the strong reference count of this object.
Runs the dispose mechanism of the object. Read more
Ensures that the type has been registered with the type system.
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
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.