CSS nodes

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

Accessibility

GtkDropDown uses the GTK_ACCESSIBLE_ROLE_COMBO_BOX role.

gtk_drop_down_new ()

GtkWidget *
gtk_drop_down_new (GListModel *model,
                   GtkExpression *expression);

Creates a new GtkDropDown.

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

gtk_drop_down_new_from_strings ()

GtkWidget *
gtk_drop_down_new_from_strings (const char * const *strings);

Creates a new GtkDropDown that is populated with the strings in strings .

gtk_drop_down_set_model ()

void
gtk_drop_down_set_model (GtkDropDown *self,
                         GListModel *model);

Sets the GListModel to use.

gtk_drop_down_get_model ()

GListModel *
gtk_drop_down_get_model (GtkDropDown *self);

Gets the model that provides the displayed items.

gtk_drop_down_set_selected ()

void
gtk_drop_down_set_selected (GtkDropDown *self,
                            guint position);

Selects the item at the given position.

gtk_drop_down_get_selected ()

guint
gtk_drop_down_get_selected (GtkDropDown *self);

Gets the position of the selected item.

gtk_drop_down_get_selected_item ()

gpointer
gtk_drop_down_get_selected_item (GtkDropDown *self);

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

gtk_drop_down_set_factory ()

void
gtk_drop_down_set_factory (GtkDropDown *self,
                           GtkListItemFactory *factory);

Sets the GtkListItemFactory to use for populating list items.

gtk_drop_down_get_factory ()

GtkListItemFactory *
gtk_drop_down_get_factory (GtkDropDown *self);

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.

gtk_drop_down_set_list_factory ()

void
gtk_drop_down_set_list_factory (GtkDropDown *self,
                                GtkListItemFactory *factory);

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

gtk_drop_down_get_list_factory ()

GtkListItemFactory *
gtk_drop_down_get_list_factory (GtkDropDown *self);

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

gtk_drop_down_set_expression ()

void
gtk_drop_down_set_expression (GtkDropDown *self,
                              GtkExpression *expression);

Sets the expression that gets evaluated to obtain strings from items when searching in the popup. The expression must have a value type of G_TYPE_STRING.

gtk_drop_down_get_expression ()

GtkExpression *
gtk_drop_down_get_expression (GtkDropDown *self);

Gets the expression set with gtk_drop_down_set_expression().

gtk_drop_down_set_enable_search ()

void
gtk_drop_down_set_enable_search (GtkDropDown *self,
                                 gboolean enable_search);

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.

gtk_drop_down_get_enable_search ()

gboolean
gtk_drop_down_get_enable_search (GtkDropDown *self);

Returns whether search is enabled.

GtkDropDown

typedef struct _GtkDropDown GtkDropDown;

The “enable-search” property

  “enable-search”            gboolean

Whether to show a search entry in the popup.

Note that search requires “expression” to be set.

Owner: GtkDropDown

Flags: Read / Write

Default value: FALSE

The “expression” property

  “expression”               GtkExpression *

An expression to evaluate to obtain strings to match against the search term (see “enable-search”). If “factory” is not set, the expression is also used to bind strings to labels produced by a default factory.

[type GtkExpression]

Owner: GtkDropDown

Flags: Read / Write

The “factory” property

  “factory”                  GtkListItemFactory *

Factory for populating list items.

Owner: GtkDropDown

Flags: Read / Write

The “list-factory” property

  “list-factory”             GtkListItemFactory *

The factory for populating list items in the popup.

If this is not set, “factory” is used.

Owner: GtkDropDown

Flags: Read / Write

The “model” property

  “model”                    GListModel *

Model for the displayed items.

Owner: GtkDropDown

Flags: Read / Write

The “selected” property

  “selected”                 guint

The position of the selected item in “model”, or GTK_INVALID_LIST_POSITION if no item is selected.

Owner: GtkDropDown

Flags: Read / Write

Default value: 4294967295

The “selected-item” property

  “selected-item”            GObject *

The selected item.

Owner: GtkDropDown

Flags: Read