Struct DropDown

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]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, and adds a checkmark to the selected item in the popup.

To set your own factory, use set_factory(). It is possible to use a separate factory for the items in the popup, with set_list_factory().

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

Here is a UI definition example for DropDown with a simple model:

<object class="GtkDropDown">
  <property name="model">
    <object class="GtkStringList">
      <items>
        <item translatable="yes">Factory</item>
        <item translatable="yes">Home</item>
        <item translatable="yes">Subway</item>
      </items>
    </object>
  </property>
</object>

If a DropDown is created in this manner, or with from_strings(), for instance, the object returned from selected_item() will be a StringObject.

To learn more about the list widget framework, see the overview.

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.

Properties

enable-search

Whether to show a search entry in the popup.

Note that search requires expression to be set.

Readable | Writeable

expression

An expression to evaluate to obtain strings to match against the search term.

See enable-search for how to enable search. If factory is not set, the expression is also used to bind strings to labels produced by a default factory.

Readable | Writeable

factory

Factory for populating list items.

Readable | Writeable

header-factory

The factory for creating header widgets for the popup.

Readable | Writeable

list-factory

The factory for populating list items in the popup.

If this is not set, factory is used.

Readable | Writeable

model

Model for the displayed items.

Readable | Writeable

search-match-mode

The match mode for the search filter.

Readable | Writeable

selected

The position of the selected item.

If no item is selected, the property has the value GTK_INVALID_LIST_POSITION.

Readable | Writeable

selected-item

The selected item.

Readable

show-arrow

Whether to show an arrow within the GtkDropDown widget.

Readable | Writeable

Widget

can-focus

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

can-target

Whether the widget can receive pointer events.

Readable | Writeable

css-classes

A list of css classes applied to this widget.

Readable | Writeable

css-name

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

cursor

The cursor used by @widget.

Readable | Writeable

focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Readable | Writeable

focusable

Whether this widget itself will accept the input focus.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

has-default

Whether the widget is the default widget.

Readable

has-focus

Whether the widget has the input focus.

Readable

has-tooltip

Enables or disables the emission of the ::query-tooltip signal on @widget.

A value of true indicates that @widget can have a tooltip, in this case the widget will be queried using query-tooltip to determine whether it will provide a tooltip or not.

Readable | Writeable

height-request

Override for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

hexpand

Whether to expand horizontally.

Readable | Writeable

hexpand-set

Whether to use the hexpand property.

Readable | Writeable

layout-manager

The LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

margin-bottom

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-end

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-start

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-top

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

name

The name of the widget.

Readable | Writeable

opacity

The requested opacity of the widget.

Readable | Writeable

overflow

How content outside the widget’s content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

parent

The parent widget of this widget.

Readable

receives-default

Whether the widget will receive the default action when it is focused.

Readable | Writeable

root

The Root widget of the widget tree containing this widget.

This will be None if the widget is not contained in a root widget.

Readable

scale-factor

The scale factor of the widget.

Readable

sensitive

Whether the widget responds to input.

Readable | Writeable

tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

tooltip-text

Sets the text of tooltip to be the given string.

Also see Tooltip::set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space.

Readable | Writeable

vexpand

Whether to expand vertically.

Readable | Writeable

vexpand-set

Whether to use the vexpand property.

Readable | Writeable

visible

Whether the widget is visible.

Readable | Writeable

width-request

Override for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

accessible-role

The accessible role of the given Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Signals

activate

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.

Action

Widget

destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

May result in finalization of the widget if all references are released.

This signal is not suitable for saving widget state.

direction-changed

Emitted when the text direction of a widget changes.

hide

Emitted when @widget is hidden.

keynav-failed

Emitted if keyboard navigation fails.

See WidgetExt::keynav_failed() for details.

map

Emitted when @widget is going to be mapped.

A widget is mapped when the widget is visible (which is controlled with visible) and all its parents up to the toplevel widget are also visible.

The ::map signal can be used to determine whether a widget will be drawn, for instance it can resume an animation that was stopped during the emission of unmap.

mnemonic-activate

Emitted when a widget is activated via a mnemonic.

The default handler for this signal activates @widget if @group_cycling is false, or just makes @widget grab focus if @group_cycling is true.

move-focus

Emitted when the focus is moved.

The ::move-focus signal is a keybinding signal.

The default bindings for this signal are Tab to move forward, and Shift+Tab to move backward.

Action

query-tooltip

Emitted when the widget’s tooltip is about to be shown.

This happens when the has-tooltip property is true and the hover timeout has expired with the cursor hovering “above” @widget; or emitted when @widget got focus in keyboard mode.

Using the given coordinates, the signal handler should determine whether a tooltip should be shown for @widget. If this is the case true should be returned, false otherwise. Note that if @keyboard_mode is true, the values of @x and @y are undefined and should not be used.

The signal handler is free to manipulate @tooltip with the therefore destined function calls.

realize

Emitted when @widget is associated with a gdk::Surface.

This means that WidgetExt::realize() has been called or the widget has been mapped (that is, it is going to be drawn).

show

Emitted when @widget is shown.

state-flags-changed

Emitted when the widget state changes.

See WidgetExt::state_flags().

unmap

Emitted when @widget is going to be unmapped.

A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.

As ::unmap indicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.

unrealize

Emitted when the gdk::Surface associated with @widget is destroyed.

This means that WidgetExt::unrealize() has been called or the widget has been unmapped (that is, it is going to be hidden).

Implements

WidgetExt, [trait@glib::ObjectExt], AccessibleExt, BuildableExt, ConstraintTargetExt, WidgetExtManual, AccessibleExtManual

GLib type: GObject with reference counted clone semantics.

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 list-factory is not set.

Returns

The factory in use

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

Available on crate feature v4_12 only.

Gets the factory that’s currently used to create header widgets for the popup.

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 search_match_mode(&self) -> StringFilterMatchMode

Available on crate feature v4_12 only.

Returns the match mode that the search filter is using.

Returns

the match mode of the search filter

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 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_header_factory(&self, factory: Option<&impl IsA<ListItemFactory>>)

Available on crate feature v4_12 only.

Sets the ListItemFactory to use for creating header widgets for the popup.

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_search_match_mode(&self, search_match_mode: StringFilterMatchMode)

Available on crate feature v4_12 only.

Sets the match mode for the search filter.

search_match_mode

the new match mode

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_header_factory_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Available on crate feature v4_12 only.

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_search_match_mode_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Available on crate feature v4_12 only.

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

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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 HasParamSpec for DropDown

type ParamSpec = ParamSpecObject

type SetValue = DropDown

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, DropDown>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for DropDown

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

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>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

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