Struct gtk4::DropDown[][src]

pub struct DropDown(_);
Expand description

DropDown is a widget that allows the user to choose an item from a list of options.

An example GtkDropDown

The DropDown displays the selected choice.

The options are given to DropDown in the form of GListModel and how the individual options are represented is determined by a ListItemFactory. The default factory displays simple strings.

DropDown knows how to obtain strings from the items in a StringList; for other models, you have to provide an expression to find the strings via set_expression().

DropDown can optionally allow search in the popup, which is useful if the list of options is long. To enable the search entry, use set_enable_search().

CSS nodes

DropDown has a single CSS node with name dropdown, with the button and popover nodes as children.

Accessibility

DropDown uses the AccessibleRole::ComboBox role.

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, WidgetExtManual, AccessibleExtManual

Implementations

Creates a new DropDown that is populated with the strings.

strings

The strings to put in the dropdown

Returns

a new DropDown

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

This method returns an instance of DropDownBuilder which can be used to create DropDown objects.

Returns whether search is enabled.

Returns

true if the popup includes a search entry

Gets the expression set that is used to obtain strings from items.

See set_expression().

Returns

a Expression or None

Gets the factory that’s currently used to populate list items.

The factory returned by this function is always used for the item in the button. It is also used for items in the popup if property::DropDown::list-factory is not set.

Returns

The factory in use

Gets the factory that’s currently used to populate list items in the popup.

Returns

The factory in use

Gets the model that provides the displayed items.

Returns

The model in use

Gets the position of the selected item.

Returns

the position of the selected item, or GTK_INVALID_LIST_POSITION if not item is selected

Gets the selected item. If no item is selected, None is returned.

Returns

The selected item

Sets whether a search entry will be shown in the popup that allows to search for items in the list.

Note that property::DropDown::expression must be set for search to work.

whether to enable search

Sets the ListItemFactory to use for populating list items.

factory

the factory to use or None for none

Sets the ListItemFactory to use for populating list items in the popup.

factory

the factory to use or None for none

Sets the GListModel to use.

model

the model to use or None for none

Selects the item at the given position.

position

the position of the item to select, or GTK_INVALID_LIST_POSITION

Creates a new DropDown.

You may want to call set_factory() to set up a way to map its items to widgets.

model

the model to use or None for none

expression

the expression to use or None for none

Returns

a new DropDown

Sets the expression that gets evaluated to obtain strings from items.

This is used for search in the popup. The expression must have a value type of G_TYPE_STRING.

expression

a Expression, or None

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

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.