Struct libadwaita::ComboRow

pub struct ComboRow { /* private fields */ }

A gtk::ListBoxRow used to choose from a list of items.

The ComboRow widget allows the user to choose from a list of valid choices. The row displays the selected choice. When activated, the row displays a popover which allows the user to make a new choice.

Example of an ComboRow UI definition:

<object class="AdwComboRow">
  <property name="title" translatable="yes">Combo Row</property>
  <property name="model">
    <object class="GtkStringList">
      <items>
        <item translatable="yes">Foo</item>
        <item translatable="yes">Bar</item>
        <item translatable="yes">Baz</item>
      </items>
    </object>
  </property>
</object>

The selected and selected-item properties can be used to keep track of the selected item and react to their changes.

ComboRow mirrors Gtk::DropDown, see that widget for details.

ComboRow is activatable if a model is set.

CSS nodes

ComboRow has a main CSS node with name row and the .combo style class.

Its popover has the node named popover with the .menu style class, it contains a gtk::ScrolledWindow, which in turn contains a gtk::ListView, both are accessible via their regular nodes.

Accessibility

ComboRow uses the GTK_ACCESSIBLE_ROLE_COMBO_BOX role.

Properties

enable-search

Whether to show a search entry in the popup.

If set to TRUE, a search entry will be shown in the popup that allows to search for items in the list.

Search requires expression to be set.

Readable | Writeable

expression

An expression used to obtain strings from items.

The expression must have a value type of G_TYPE_STRING.

It’s used to bind strings to labels produced by the default factory if factory is not set, or when use-subtitle is set to TRUE.

Readable | Writeable

factory

Factory for populating list items.

This factory is always used for the item in the row. It is also used for items in the popup unless list-factory is set.

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

The model that provides 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

use-subtitle

Whether to use the current value as the subtitle.

If you use a custom list item factory, you will need to give the row a name conversion expression with expression.

If set to TRUE, you should not access subtitle.

The subtitle is interpreted as Pango markup if use-markup is set to TRUE.

Readable | Writeable

ActionRow

activatable-widget

The widget to activate when the row is activated.

The row can be activated either by clicking on it, calling ActionRowExt::activate(), or via mnemonics in the title. See the use-underline property to enable mnemonics.

The target widget will be activated by emitting the mnemonic-activate signal on it.

Readable | Writeable

icon-name

The icon name for this row.

Readable | Writeable

subtitle

The subtitle for this row.

The subtitle is interpreted as Pango markup unless use-markup is set to FALSE.

Readable | Writeable

subtitle-lines

The number of lines at the end of which the subtitle label will be ellipsized.

If the value is 0, the number of lines won’t be limited.

Readable | Writeable

subtitle-selectable

Whether the user can copy the subtitle from the label.

See also [selectable][struct@crate::Gtk::Label#selectable].

Readable | Writeable

title-lines

The number of lines at the end of which the title label will be ellipsized.

If the value is 0, the number of lines won’t be limited.

Readable | Writeable

PreferencesRow

title

The title of the preference represented by this row.

The title is interpreted as Pango markup unless use-markup is set to FALSE.

Readable | Writeable

title-selectable

Whether the user can copy the title from the label.

See also [selectable][struct@crate::Gtk::Label#selectable].

Readable | Writeable

use-markup

Whether to use Pango markup for the title label.

Subclasses may also use it for other labels, such as subtitle.

See also parse_markup().

Readable | Writeable

use-underline

Whether an embedded underline in the title indicates a mnemonic.

Readable | Writeable

ListBoxRow

activatable

Determines whether the ::row-activated signal will be emitted for this row.

Readable | Writeable

child

The child widget.

Readable | Writeable

selectable

Determines whether this row can be selected.

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 gtk::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 [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::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 [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::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 [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::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 [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::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 gtk::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 Gtk::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 Gtk::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 gtk::Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Actionable

action-name

The name of the action with which this widget should be associated.

Readable | Writeable

action-target

The target value of the actionable widget’s action.

Readable | Writeable

Implements

ComboRowExt, ActionRowExt, PreferencesRowExt, gtk::prelude::ListBoxRowExt, gtk::prelude::WidgetExt, [trait@glib::ObjectExt], gtk::prelude::AccessibleExt, gtk::prelude::BuildableExt, gtk::prelude::ConstraintTargetExt, gtk::prelude::ActionableExt

GLib type: GObject with reference counted clone semantics.

Implementations

impl ComboRow

pub const NONE: Option<&'static ComboRow> = None

pub fn new() -> ComboRow

Creates a new ComboRow.

Returns

the newly created ComboRow

pub fn builder() -> ComboRowBuilder

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

This method returns an instance of ComboRowBuilder which can be used to create ComboRow objects.

Trait Implementations

impl Clone for ComboRow

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 ComboRow

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

Formats the value using the given formatter.

impl Default for ComboRow

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for ComboRow

type ParamSpec = ParamSpecObject

type SetValue = ComboRow

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for ComboRow

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<T: ComboRowImpl> IsSubclassable<T> for ComboRow

fn class_init(class: &mut Class<Self>)

Override the virtual methods of this class for the given subclass and do other class initialization.

fn instance_init(instance: &mut InitializingObject<T>)

Instance specific initialization.

impl Ord for ComboRow

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 + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for ComboRow

type Parent = ActionRow

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

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

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 ComboRow

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

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 ComboRow

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ComboRow

impl IsA<Accessible> for ComboRow

impl IsA<ActionRow> for ComboRow

impl IsA<Actionable> for ComboRow

impl IsA<Buildable> for ComboRow

impl IsA<ConstraintTarget> for ComboRow

impl IsA<ListBoxRow> for ComboRow

impl IsA<PreferencesRow> for ComboRow

impl IsA<Widget> for ComboRow