Struct gtk4::DropDown

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

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

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

impl DropDown

pub fn new( model: Option<&impl IsA<ListModel>>, expression: Option<impl AsRef<Expression>> ) -> DropDown

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

expression

the expression to use

Returns

a new DropDown

pub fn from_strings(strings: &[&str]) -> DropDown

Creates a new DropDown that is populated with the strings.

strings

The strings to put in the dropdown

Returns

a new DropDown

pub fn builder() -> DropDownBuilder

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.

pub fn enables_search(&self) -> bool

Returns whether search is enabled.

Returns

true if the popup includes a search entry

pub fn expression(&self) -> Option<Expression>

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

See set_expression().

Returns

a Expression

pub fn factory(&self) -> Option<ListItemFactory>

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

pub fn list_factory(&self) -> Option<ListItemFactory>

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

Returns

The factory in use

pub fn model(&self) -> Option<ListModel>

Gets the model that provides the displayed items.

Returns

The model in use

pub fn selected(&self) -> u32

Gets the position of the selected item.

Returns

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

pub fn selected_item(&self) -> Option<Object>

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

Returns

The selected item

pub fn shows_arrow(&self) -> bool

Available on crate feature v4_6 only.

Returns whether to show an arrow within the widget.

Returns

true if an arrow will be shown.

pub fn set_enable_search(&self, enable_search: bool)

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.

enable_search

whether to enable search

pub fn set_expression(&self, expression: Option<impl AsRef<Expression>>)

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

pub fn set_factory(&self, factory: Option<&impl IsA<ListItemFactory>>)

Sets the ListItemFactory to use for populating list items.

factory

the factory to use

pub fn set_list_factory(&self, factory: Option<&impl IsA<ListItemFactory>>)

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

factory

the factory to use

pub fn set_model(&self, model: Option<&impl IsA<ListModel>>)

Sets the GListModel to use.

model

the model to use

pub fn set_selected(&self, position: u32)

Selects the item at the given position.

position

the position of the item to select, or GTK_INVALID_LIST_POSITION

pub fn set_show_arrow(&self, show_arrow: bool)

Available on crate feature v4_6 only.

Sets whether an arrow will be displayed within the widget.

show_arrow

whether to show an arrow within the widget

pub fn connect_activate<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

Available on crate feature v4_6 only.

Emitted to when the drop down is activated.

The ::activate signal on DropDown is an action signal and emitting it causes the drop down to pop up its dropdown.

pub fn emit_activate(&self)

Available on crate feature v4_6 only.

pub fn connect_enable_search_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_expression_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_factory_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_list_factory_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_model_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_selected_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_selected_item_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_show_arrow_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Available on crate feature v4_6 only.

Trait Implementations

impl Clone for DropDown

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 DropDown

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

Formats the value using the given formatter.

impl Default for DropDown

fn default() -> Self

Returns the “default value” for a type.

impl Display for DropDown

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

Formats the value using the given formatter.

impl Hash for DropDown

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 DropDown

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 DropDown

type Parent = Widget

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

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 DropDown

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 DropDown

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for DropDown

impl IsA<Accessible> for DropDown

impl IsA<Buildable> for DropDown

impl IsA<ConstraintTarget> for DropDown

impl IsA<Widget> for DropDown