gtk4

Struct ListBox

source
pub struct ListBox { /* private fields */ }
Expand description

ListBox is a vertical list.

A ListBox only contains ListBoxRow children. These rows can by dynamically sorted and filtered, and headers can be added dynamically depending on the row content. It also allows keyboard and mouse navigation and selection like a typical list.

Using ListBox is often an alternative to TreeView, especially when the list contents has a more complicated layout than what is allowed by a CellRenderer, or when the contents is interactive (i.e. has a button in it).

Although a ListBox must have only ListBoxRow children, you can add any kind of widget to it via prepend(), append() and insert() and a ListBoxRow widget will automatically be inserted between the list and the widget.

GtkListBoxRows can be marked as activatable or selectable. If a row is activatable, row-activated will be emitted for it when the user tries to activate it. If it is selectable, the row will be marked as selected when the user tries to select it.

§GtkListBox as GtkBuildable

The ListBox implementation of the Buildable interface supports setting a child as the placeholder by specifying “placeholder” as the “type” attribute of a <child> element. See set_placeholder() for info.

§Shortcuts and Gestures

The following signals have default keybindings:

§CSS nodes

⚠️ The following code is in plain ⚠️

list[.separators][.rich-list][.navigation-sidebar][.boxed-list]
╰── row[.activatable]

ListBox uses a single CSS node named list. It may carry the .separators style class, when the show-separators property is set. Each ListBoxRow uses a single CSS node named row. The row nodes get the .activatable style class added when appropriate.

It may also carry the .boxed-list style class. In this case, the list will be automatically surrounded by a frame and have separators.

The main list node may also carry style classes to select the style of list presentation: .rich-list, .navigation-sidebar or .data-table.

§Accessibility

ListBox uses the AccessibleRole::List role and ListBoxRow uses the AccessibleRole::ListItem role.

§Properties

§accept-unpaired-release

Whether to accept unpaired release events.

Readable | Writeable

§activate-on-single-click

Determines whether children can be activated with a single click, or require a double-click.

Readable | Writeable

§selection-mode

The selection mode used by the list box.

Readable | Writeable

§show-separators

Whether to show separators between rows.

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-cursor-row

Emitted when the cursor row is activated.

Action

§move-cursor

Emitted when the user initiates a cursor movement.

The default bindings for this signal come in two variants, the variant with the Shift modifier extends the selection, the variant without the Shift modifier does not. There are too many key combinations to list them all here.

  • , , , move by individual children
  • Home, End move to the ends of the box
  • PgUp, PgDn move vertically by pages

Action

§row-activated

Emitted when a row has been activated by the user.

§row-selected

Emitted when a new row is selected, or (with a None @row) when the selection is cleared.

When the @box_ is using SelectionMode::Multiple, this signal will not give you the full picture of selection changes, and you should use the selected-rows-changed signal instead.

§select-all

Emitted to select all children of the box, if the selection mode permits it.

This is a keybinding signal.

The default binding for this signal is Ctrl-a.

Action

§selected-rows-changed

Emitted when the set of selected rows changes.

§toggle-cursor-row

Emitted when the cursor row is toggled.

The default bindings for this signal is Ctrl+.

Action

§unselect-all

Emitted to unselect all children of the box, if the selection mode permits it.

This is a keybinding signal.

The default binding for this signal is Ctrl-Shift-a.

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§

source§

impl ListBox

source

pub fn new() -> ListBox

Creates a new ListBox container.

§Returns

a new ListBox

source

pub fn builder() -> ListBoxBuilder

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

This method returns an instance of ListBoxBuilder which can be used to create ListBox objects.

source

pub fn append(&self, child: &impl IsA<Widget>)

Append a widget to the list.

If a sort function is set, the widget will actually be inserted at the calculated position.

§child

the Widget to add

source

pub fn bind_model<P: Fn(&Object) -> Widget + 'static>( &self, model: Option<&impl IsA<ListModel>>, create_widget_func: P, )

Binds @model to @self.

If @self was already bound to a model, that previous binding is destroyed.

The contents of @self are cleared and then filled with widgets that represent items from @model. @self is updated whenever @model changes. If @model is None, @self is left empty.

It is undefined to add or remove widgets directly (for example, with insert()) while @self is bound to a model.

Note that using a model is incompatible with the filtering and sorting functionality in ListBox. When using a model, filtering and sorting should be implemented by the model.

§model

the GListModel to be bound to @self

§create_widget_func

a function that creates widgets for items or None in case you also passed None as @model

source

pub fn drag_highlight_row(&self, row: &impl IsA<ListBoxRow>)

Add a drag highlight to a row.

This is a helper function for implementing DnD onto a ListBox. The passed in @row will be highlighted by setting the StateFlags::DROP_ACTIVE state and any previously highlighted row will be unhighlighted.

The row will also be unhighlighted when the widget gets a drag leave event.

§row

a ListBoxRow

source

pub fn drag_unhighlight_row(&self)

If a row has previously been highlighted via gtk_list_box_drag_highlight_row(), it will have the highlight removed.

source

pub fn activates_on_single_click(&self) -> bool

Returns whether rows activate on single clicks.

§Returns

true if rows are activated on single click, false otherwise

source

pub fn adjustment(&self) -> Option<Adjustment>

Gets the adjustment (if any) that the widget uses to for vertical scrolling.

§Returns

the adjustment

source

pub fn row_at_index(&self, index_: i32) -> Option<ListBoxRow>

Gets the n-th child in the list (not counting headers).

If @index_ is negative or larger than the number of items in the list, None is returned.

§index_

the index of the row

§Returns

the child Widget

source

pub fn row_at_y(&self, y: i32) -> Option<ListBoxRow>

Gets the row at the @y position.

§y

position

§Returns

the row

source

pub fn selected_row(&self) -> Option<ListBoxRow>

Gets the selected row, or None if no rows are selected.

Note that the box may allow multiple selection, in which case you should use selected_foreach() to find all selected rows.

§Returns

the selected row

source

pub fn selected_rows(&self) -> Vec<ListBoxRow>

Creates a list of all selected children.

§Returns

A GList containing the Widget for each selected child. Free with g_list_free() when done.

source

pub fn selection_mode(&self) -> SelectionMode

Gets the selection mode of the listbox.

§Returns

a SelectionMode

source

pub fn shows_separators(&self) -> bool

Returns whether the list box should show separators between rows.

§Returns

true if the list box shows separators

source

pub fn insert(&self, child: &impl IsA<Widget>, position: i32)

Insert the @child into the @self at @position.

If a sort function is set, the widget will actually be inserted at the calculated position.

If @position is -1, or larger than the total number of items in the @self, then the @child will be appended to the end.

§child

the Widget to add

§position

the position to insert @child in

source

pub fn invalidate_filter(&self)

Update the filtering for all rows.

Call this when result of the filter function on the @self is changed due to an external factor. For instance, this would be used if the filter function just looked for a specific search string and the entry with the search string has changed.

source

pub fn invalidate_headers(&self)

Update the separators for all rows.

Call this when result of the header function on the @self is changed due to an external factor.

source

pub fn invalidate_sort(&self)

Update the sorting for all rows.

Call this when result of the sort function on the @self is changed due to an external factor.

source

pub fn prepend(&self, child: &impl IsA<Widget>)

Prepend a widget to the list.

If a sort function is set, the widget will actually be inserted at the calculated position.

§child

the Widget to add

source

pub fn remove(&self, child: &impl IsA<Widget>)

Removes a child from @self.

§child

the child to remove

source

pub fn remove_all(&self)

Available on crate feature v4_12 only.

Removes all rows from @self.

This function does nothing if @self is backed by a model.

source

pub fn select_all(&self)

Select all children of @self, if the selection mode allows it.

source

pub fn select_row(&self, row: Option<&impl IsA<ListBoxRow>>)

Make @row the currently selected row.

§row

The row to select

source

pub fn selected_foreach<P: FnMut(&ListBox, &ListBoxRow)>(&self, func: P)

Calls a function for each selected child.

Note that the selection cannot be modified from within this function.

§func

the function to call for each selected child

source

pub fn set_activate_on_single_click(&self, single: bool)

If @single is true, rows will be activated when you click on them, otherwise you need to double-click.

§single

a boolean

source

pub fn set_adjustment(&self, adjustment: Option<&impl IsA<Adjustment>>)

Sets the adjustment (if any) that the widget uses to for vertical scrolling.

For instance, this is used to get the page size for PageUp/Down key handling.

In the normal case when the @self is packed inside a ScrolledWindow the adjustment from that will be picked up automatically, so there is no need to manually do that.

§adjustment

the adjustment

source

pub fn set_filter_func<P: Fn(&ListBoxRow) -> bool + 'static>( &self, filter_func: P, )

By setting a filter function on the @self one can decide dynamically which of the rows to show.

For instance, to implement a search function on a list that filters the original list to only show the matching rows.

The @filter_func will be called for each row after the call, and it will continue to be called each time a row changes (via ListBoxRowExt::changed()) or when invalidate_filter() is called.

Note that using a filter function is incompatible with using a model (see bind_model()).

§filter_func

callback that lets you filter which rows to show

source

pub fn set_header_func<P: Fn(&ListBoxRow, Option<&ListBoxRow>) + 'static>( &self, update_header: P, )

Sets a header function.

By setting a header function on the @self one can dynamically add headers in front of rows, depending on the contents of the row and its position in the list.

For instance, one could use it to add headers in front of the first item of a new kind, in a list sorted by the kind.

The @update_header can look at the current header widget using ListBoxRowExt::header() and either update the state of the widget as needed, or set a new one using ListBoxRowExt::set_header(). If no header is needed, set the header to None.

Note that you may get many calls @update_header to this for a particular row when e.g. changing things that don’t affect the header. In this case it is important for performance to not blindly replace an existing header with an identical one.

The @update_header function will be called for each row after the call, and it will continue to be called each time a row changes (via ListBoxRowExt::changed()) and when the row before changes (either by ListBoxRowExt::changed() on the previous row, or when the previous row becomes a different row). It is also called for all rows when invalidate_headers() is called.

§update_header

callback that lets you add row headers

source

pub fn set_placeholder(&self, placeholder: Option<&impl IsA<Widget>>)

Sets the placeholder widget that is shown in the list when it doesn’t display any visible children.

§placeholder

a Widget

source

pub fn set_selection_mode(&self, mode: SelectionMode)

Sets how selection works in the listbox.

§mode

The SelectionMode

source

pub fn set_show_separators(&self, show_separators: bool)

Sets whether the list box should show separators between rows.

§show_separators

true to show separators

source

pub fn unselect_all(&self)

Unselect all children of @self, if the selection mode allows it.

source

pub fn unselect_row(&self, row: &impl IsA<ListBoxRow>)

Unselects a single row of @self, if the selection mode allows it.

§row

the row to unselect

source

pub fn accepts_unpaired_release(&self) -> bool

Whether to accept unpaired release events.

source

pub fn set_accept_unpaired_release(&self, accept_unpaired_release: bool)

Whether to accept unpaired release events.

source

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

Emitted when the cursor row is activated.

source

pub fn emit_activate_cursor_row(&self)

source

pub fn connect_move_cursor<F: Fn(&Self, MovementStep, i32, bool, bool) + 'static>( &self, f: F, ) -> SignalHandlerId

Emitted when the user initiates a cursor movement.

The default bindings for this signal come in two variants, the variant with the Shift modifier extends the selection, the variant without the Shift modifier does not. There are too many key combinations to list them all here.

  • , , , move by individual children
  • Home, End move to the ends of the box
  • PgUp, PgDn move vertically by pages
§step

the granularity of the move, as a MovementStep

§count

the number of @step units to move

§extend

whether to extend the selection

§modify

whether to modify the selection

source

pub fn emit_move_cursor( &self, step: MovementStep, count: i32, extend: bool, modify: bool, )

source

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

Emitted when a row has been activated by the user.

§row

the activated row

source

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

Emitted when a new row is selected, or (with a None @row) when the selection is cleared.

When the @box_ is using SelectionMode::Multiple, this signal will not give you the full picture of selection changes, and you should use the selected-rows-changed signal instead.

§row

the selected row

source

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

Emitted to select all children of the box, if the selection mode permits it.

This is a keybinding signal.

The default binding for this signal is Ctrl-a.

source

pub fn emit_select_all(&self)

source

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

Emitted when the set of selected rows changes.

source

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

Emitted when the cursor row is toggled.

The default bindings for this signal is Ctrl+.

source

pub fn emit_toggle_cursor_row(&self)

source

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

Emitted to unselect all children of the box, if the selection mode permits it.

This is a keybinding signal.

The default binding for this signal is Ctrl-Shift-a.

source

pub fn emit_unselect_all(&self)

source

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

source

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

source

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

source

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

source§

impl ListBox

source

pub fn unbind_model(&self)

source

pub fn unset_filter_func(&self)

source

pub fn unset_header_func(&self)

source

pub fn set_sort_func<P: Fn(&ListBoxRow, &ListBoxRow) -> Ordering + 'static>( &self, sort_func: P, )

Sets a sort function.

By setting a sort function on the @self one can dynamically reorder the rows of the list, based on the contents of the rows.

The @sort_func will be called for each row after the call, and will continue to be called each time a row changes (via ListBoxRowExt::changed()) and when invalidate_sort() is called.

Note that using a sort function is incompatible with using a model (see bind_model()).

§sort_func

the sort function

source

pub fn unset_sort_func(&self)

Trait Implementations§

source§

impl Clone for ListBox

source§

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.

1.6.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for ListBox

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for ListBox

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl HasParamSpec for ListBox

source§

type ParamSpec = ParamSpecObject

source§

type SetValue = ListBox

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

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

source§

fn param_spec_builder() -> Self::BuilderFn

source§

impl Hash for ListBox

source§

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

Hashes the memory address of this object.

1.6.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for ListBox

source§

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

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

Restrict a value to a certain interval. Read more
source§

impl ParentClassIs for ListBox

source§

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

source§

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

1.6.0 · source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<OT: ObjectType> PartialOrd<OT> for ListBox

source§

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

1.6.0 · source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.6.0 · source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.6.0 · source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.6.0 · source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
source§

impl StaticType for ListBox

source§

fn static_type() -> Type

Returns the type identifier of Self.
source§

impl Eq for ListBox

source§

impl IsA<Accessible> for ListBox

source§

impl IsA<Buildable> for ListBox

source§

impl IsA<ConstraintTarget> for ListBox

source§

impl IsA<Widget> for ListBox

Auto Trait Implementations§

Blanket Implementations§

source§

impl<O> AccessibleExt for O
where O: IsA<Accessible>,

source§

fn announce(&self, message: &str, priority: AccessibleAnnouncementPriority)

Available on crate feature v4_14 only.
Requests the user’s screen reader to announce the given message. Read more
source§

fn accessible_parent(&self) -> Option<Accessible>

Available on crate feature v4_10 only.
Retrieves the accessible parent for an accessible object. Read more
source§

fn accessible_role(&self) -> AccessibleRole

Retrieves the accessible role of an accessible object. Read more
source§

fn at_context(&self) -> ATContext

Available on crate feature v4_10 only.
Retrieves the accessible implementation for the given Accessible. Read more
source§

fn bounds(&self) -> Option<(i32, i32, i32, i32)>

Available on crate feature v4_10 only.
Queries the coordinates and dimensions of this accessible Read more
source§

fn first_accessible_child(&self) -> Option<Accessible>

Available on crate feature v4_10 only.
Retrieves the first accessible child of an accessible object. Read more
source§

fn next_accessible_sibling(&self) -> Option<Accessible>

Available on crate feature v4_10 only.
Retrieves the next accessible sibling of an accessible object Read more
source§

fn platform_state(&self, state: AccessiblePlatformState) -> bool

Available on crate feature v4_10 only.
Query a platform state, such as focus. Read more
source§

fn reset_property(&self, property: AccessibleProperty)

Resets the accessible @property to its default value. Read more
source§

fn reset_relation(&self, relation: AccessibleRelation)

Resets the accessible @relation to its default value. Read more
source§

fn reset_state(&self, state: AccessibleState)

Resets the accessible @state to its default value. Read more
source§

fn set_accessible_parent( &self, parent: Option<&impl IsA<Accessible>>, next_sibling: Option<&impl IsA<Accessible>>, )

Available on crate feature v4_10 only.
Sets the parent and sibling of an accessible object. Read more
source§

fn update_next_accessible_sibling( &self, new_sibling: Option<&impl IsA<Accessible>>, )

Available on crate feature v4_10 only.
Updates the next accessible sibling of @self. Read more
source§

fn set_accessible_role(&self, accessible_role: AccessibleRole)

The accessible role of the given Accessible implementation. Read more
source§

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

source§

impl<O> AccessibleExtManual for O
where O: IsA<Accessible>,

source§

fn update_property(&self, properties: &[Property<'_>])

Updates an array of accessible properties. Read more
source§

fn update_relation(&self, relations: &[Relation<'_>])

Updates an array of accessible relations. Read more
source§

fn update_state(&self, states: &[State])

Updates an array of accessible states. Read more
source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<O> BuildableExt for O
where O: IsA<Buildable>,

source§

fn buildable_id(&self) -> Option<GString>

Gets the ID of the @self object. Read more
source§

impl<T> Cast for T
where T: ObjectType,

source§

fn upcast<T>(self) -> T
where T: ObjectType, Self: IsA<T>,

Upcasts an object to a superclass or interface T. Read more
source§

fn upcast_ref<T>(&self) -> &T
where T: ObjectType, Self: IsA<T>,

Upcasts an object to a reference of its superclass or interface T. Read more
source§

fn downcast<T>(self) -> Result<T, Self>
where T: ObjectType, Self: MayDowncastTo<T>,

Tries to downcast to a subclass or interface implementor T. Read more
source§

fn downcast_ref<T>(&self) -> Option<&T>
where T: ObjectType, Self: MayDowncastTo<T>,

Tries to downcast to a reference of its subclass or interface implementor T. Read more
source§

fn dynamic_cast<T>(self) -> Result<T, Self>
where T: ObjectType,

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 upcast will do many checks at compile-time already. downcast will perform the same checks at runtime as dynamic_cast, but will also ensure some amount of compile-time safety. Read more
source§

fn dynamic_cast_ref<T>(&self) -> Option<&T>
where T: ObjectType,

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
source§

unsafe fn unsafe_cast<T>(self) -> T
where T: ObjectType,

Casts to T unconditionally. Read more
source§

unsafe fn unsafe_cast_ref<T>(&self) -> &T
where T: ObjectType,

Casts to &T unconditionally. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *const GList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(_: *const GList, _: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(_: *const GList, _: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *const GPtrArray, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec( _: *const GPtrArray, _: usize, ) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(_: *const GPtrArray, _: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *const GSList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(_: *const GSList, _: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(_: *const GSList, _: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *mut GPtrArray, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec( ptr: *mut GPtrArray, num: usize, ) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(ptr: *mut GPtrArray, num: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *const GList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(_: *const GList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(_: *const GList) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *const GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(_: *const GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(_: *const GPtrArray) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *const GSList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(_: *const GSList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(_: *const GSList) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *mut GList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(ptr: *mut GList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(ptr: *mut GList) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *mut GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(ptr: *mut GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(ptr: *mut GPtrArray) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *mut GSList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(ptr: *mut GSList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(ptr: *mut GSList) -> Vec<T>

source§

impl<O> GObjectPropertyExpressionExt for O
where O: IsA<Object>,

source§

fn property_expression(&self, property_name: &str) -> PropertyExpression

Create an expression looking up an object’s property.
source§

fn property_expression_weak(&self, property_name: &str) -> PropertyExpression

Create an expression looking up an object’s property with a weak reference.
source§

fn this_expression(property_name: &str) -> PropertyExpression

Create an expression looking up a property in the bound this object.
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoClosureReturnValue for T
where T: Into<Value>,

source§

impl<U> IsSubclassableExt for U

source§

impl<T> ObjectExt for T
where T: ObjectType,

source§

fn is<U>(&self) -> bool
where U: StaticType,

Returns true if the object is an instance of (can be cast to) T.
source§

fn type_(&self) -> Type

Returns the type of the object.
source§

fn object_class(&self) -> &Class<Object>

Returns the ObjectClass of the object. Read more
source§

fn class(&self) -> &Class<T>
where T: IsClass,

Returns the class of the object.
source§

fn class_of<U>(&self) -> Option<&Class<U>>
where U: IsClass,

Returns the class of the object in the given type T. Read more
source§

fn interface<U>(&self) -> Option<InterfaceRef<'_, U>>
where U: IsInterface,

Returns the interface T of the object. Read more
source§

fn set_property(&self, property_name: &str, value: impl Into<Value>)

Sets the property property_name of the object to value value. Read more
source§

fn set_property_from_value(&self, property_name: &str, value: &Value)

Sets the property property_name of the object to value value. Read more
source§

fn set_properties(&self, property_values: &[(&str, &dyn ToValue)])

Sets multiple properties of the object at once. Read more
source§

fn set_properties_from_value(&self, property_values: &[(&str, Value)])

Sets multiple properties of the object at once. Read more
source§

fn property<V>(&self, property_name: &str) -> V
where V: for<'b> FromValue<'b> + 'static,

Gets the property property_name of the object and cast it to the type V. Read more
source§

fn property_value(&self, property_name: &str) -> Value

Gets the property property_name of the object. Read more
source§

fn has_property(&self, property_name: &str, type_: Option<Type>) -> bool

Check if the object has a property property_name of the given type_. Read more
source§

fn property_type(&self, property_name: &str) -> Option<Type>

Get the type of the property property_name of this object. Read more
source§

fn find_property(&self, property_name: &str) -> Option<ParamSpec>

Get the ParamSpec of the property property_name of this object.
source§

fn list_properties(&self) -> PtrSlice<ParamSpec>

Return all ParamSpec of the properties of this object.
source§

fn freeze_notify(&self) -> PropertyNotificationFreezeGuard

Freeze all property notifications until the return guard object is dropped. Read more
source§

unsafe fn set_qdata<QD>(&self, key: Quark, value: QD)
where QD: 'static,

Set arbitrary data on this object with the given key. Read more
source§

unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>>
where QD: 'static,

Return previously set arbitrary data of this object with the given key. Read more
source§

unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD>
where QD: 'static,

Retrieve previously set arbitrary data of this object with the given key. Read more
source§

unsafe fn set_data<QD>(&self, key: &str, value: QD)
where QD: 'static,

Set arbitrary data on this object with the given key. Read more
source§

unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>>
where QD: 'static,

Return previously set arbitrary data of this object with the given key. Read more
source§

unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD>
where QD: 'static,

Retrieve previously set arbitrary data of this object with the given key. Read more
source§

fn block_signal(&self, handler_id: &SignalHandlerId)

Block a given signal handler. Read more
source§

fn unblock_signal(&self, handler_id: &SignalHandlerId)

Unblock a given signal handler.
source§

fn stop_signal_emission(&self, signal_id: SignalId, detail: Option<Quark>)

Stop emission of the currently emitted signal.
source§

fn stop_signal_emission_by_name(&self, signal_name: &str)

Stop emission of the currently emitted signal by the (possibly detailed) signal name.
source§

fn connect<F>( &self, signal_name: &str, after: bool, callback: F, ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,

Connect to the signal signal_name on this object. Read more
source§

fn connect_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F, ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,

Connect to the signal signal_id on this object. Read more
source§

fn connect_local<F>( &self, signal_name: &str, after: bool, callback: F, ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + 'static,

Connect to the signal signal_name on this object. Read more
source§

fn connect_local_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F, ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + 'static,

Connect to the signal signal_id on this object. Read more
source§

unsafe fn connect_unsafe<F>( &self, signal_name: &str, after: bool, callback: F, ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value>,

Connect to the signal signal_name on this object. Read more
source§

unsafe fn connect_unsafe_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F, ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value>,

Connect to the signal signal_id on this object. Read more
source§

fn connect_closure( &self, signal_name: &str, after: bool, closure: RustClosure, ) -> SignalHandlerId

Connect a closure to the signal signal_name on this object. Read more
source§

fn connect_closure_id( &self, signal_id: SignalId, details: Option<Quark>, after: bool, closure: RustClosure, ) -> SignalHandlerId

Connect a closure to the signal signal_id on this object. Read more
source§

fn watch_closure(&self, closure: &impl AsRef<Closure>)

Limits the lifetime of closure to the lifetime of the object. When the object’s reference count drops to zero, the closure will be invalidated. An invalidated closure will ignore any calls to invoke_with_values, or invoke when using Rust closures.
source§

fn emit<R>(&self, signal_id: SignalId, args: &[&dyn ToValue]) -> R

Emit signal by signal id. Read more
source§

fn emit_with_values(&self, signal_id: SignalId, args: &[Value]) -> Option<Value>

Same as Self::emit but takes Value for the arguments.
source§

fn emit_by_name<R>(&self, signal_name: &str, args: &[&dyn ToValue]) -> R

Emit signal by its name. Read more
source§

fn emit_by_name_with_values( &self, signal_name: &str, args: &[Value], ) -> Option<Value>

Emit signal by its name. Read more
source§

fn emit_by_name_with_details<R>( &self, signal_name: &str, details: Quark, args: &[&dyn ToValue], ) -> R

Emit signal by its name with details. Read more
source§

fn emit_by_name_with_details_and_values( &self, signal_name: &str, details: Quark, args: &[Value], ) -> Option<Value>

Emit signal by its name with details. Read more
source§

fn emit_with_details<R>( &self, signal_id: SignalId, details: Quark, args: &[&dyn ToValue], ) -> R

Emit signal by signal id with details. Read more
source§

fn emit_with_details_and_values( &self, signal_id: SignalId, details: Quark, args: &[Value], ) -> Option<Value>

Emit signal by signal id with details. Read more
source§

fn disconnect(&self, handler_id: SignalHandlerId)

Disconnect a previously connected signal handler.
source§

fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
where F: Fn(&T, &ParamSpec) + Send + Sync + 'static,

Connect to the notify signal of the object. Read more
source§

fn connect_notify_local<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
where F: Fn(&T, &ParamSpec) + 'static,

Connect to the notify signal of the object. Read more
source§

unsafe fn connect_notify_unsafe<F>( &self, name: Option<&str>, f: F, ) -> SignalHandlerId
where F: Fn(&T, &ParamSpec),

Connect to the notify signal of the object. Read more
source§

fn notify(&self, property_name: &str)

Notify that the given property has changed its value. Read more
source§

fn notify_by_pspec(&self, pspec: &ParamSpec)

Notify that the given property has changed its value. Read more
source§

fn downgrade(&self) -> WeakRef<T>

Downgrade this object to a weak reference.
source§

fn add_weak_ref_notify<F>(&self, f: F) -> WeakRefNotify<T>
where F: FnOnce() + Send + 'static,

Add a callback to be notified when the Object is disposed.
source§

fn add_weak_ref_notify_local<F>(&self, f: F) -> WeakRefNotify<T>
where F: FnOnce() + 'static,

Add a callback to be notified when the Object is disposed. Read more
source§

fn bind_property<'a, 'f, 't, O>( &'a self, source_property: &'a str, target: &'a O, target_property: &'a str, ) -> BindingBuilder<'a, 'f, 't>
where O: ObjectType,

Bind property source_property on this object to the target_property on the target object. Read more
source§

fn ref_count(&self) -> u32

Returns the strong reference count of this object.
source§

unsafe fn run_dispose(&self)

Runs the dispose mechanism of the object. Read more
source§

impl<T> Property for T
where T: HasParamSpec,

source§

type Value = T

source§

impl<T> PropertyGet for T
where T: HasParamSpec,

source§

type Value = T

source§

fn get<R, F>(&self, f: F) -> R
where F: Fn(&<T as PropertyGet>::Value) -> R,

source§

impl<T> StaticTypeExt for T
where T: StaticType,

source§

fn ensure_type()

Ensures that the type has been registered with the type system.
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> TransparentType for T

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T> TryFromClosureReturnValue for T
where T: for<'a> FromValue<'a> + StaticType + 'static,

source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<O> WidgetExt for O
where O: IsA<Widget>,

source§

fn action_set_enabled(&self, action_name: &str, enabled: bool)

Enable or disable an action installed with gtk_widget_class_install_action(). Read more
source§

fn activate(&self) -> bool

For widgets that can be “activated” (buttons, menu items, etc.), this function activates them. Read more
source§

fn activate_action( &self, name: &str, args: Option<&Variant>, ) -> Result<(), BoolError>

Looks up the action in the action groups associated with @self and its ancestors, and activates it. Read more
source§

fn activate_default(&self)

Activates the default.activate action from @self.
source§

fn add_controller(&self, controller: impl IsA<EventController>)

Adds @controller to @self so that it will receive events. Read more
source§

fn add_css_class(&self, css_class: &str)

Adds a style class to @self. Read more
source§

fn add_mnemonic_label(&self, label: &impl IsA<Widget>)

Adds a widget to the list of mnemonic labels for this widget. Read more
source§

fn allocate( &self, width: i32, height: i32, baseline: i32, transform: Option<Transform>, )

This function is only used by Widget subclasses, to assign a size, position and (optionally) baseline to their child widgets. Read more
source§

fn child_focus(&self, direction: DirectionType) -> bool

Called by widgets as the user moves around the window using keyboard shortcuts. Read more
source§

fn compute_bounds(&self, target: &impl IsA<Widget>) -> Option<Rect>

Computes the bounds for @self in the coordinate space of @target. Read more
source§

fn compute_expand(&self, orientation: Orientation) -> bool

Computes whether a container should give this widget extra space when possible. Read more
source§

fn compute_point( &self, target: &impl IsA<Widget>, point: &Point, ) -> Option<Point>

Translates the given @point in @self’s coordinates to coordinates relative to @target’s coordinate system. Read more
source§

fn compute_transform(&self, target: &impl IsA<Widget>) -> Option<Matrix>

Computes a matrix suitable to describe a transformation from @self’s coordinate system into @target’s coordinate system. Read more
source§

fn contains(&self, x: f64, y: f64) -> bool

Tests if the point at (@x, @y) is contained in @self. Read more
source§

fn create_pango_context(&self) -> Context

Creates a new pango::Context with the appropriate font map, font options, font description, and base direction for drawing text for this widget. Read more
source§

fn create_pango_layout(&self, text: Option<&str>) -> Layout

Creates a new pango::Layout with the appropriate font map, font description, and base direction for drawing text for this widget. Read more
source§

fn drag_check_threshold( &self, start_x: i32, start_y: i32, current_x: i32, current_y: i32, ) -> bool

Checks to see if a drag movement has passed the GTK drag threshold. Read more
source§

fn error_bell(&self)

Notifies the user about an input-related error on this widget. Read more
source§

fn allocated_baseline(&self) -> i32

👎Deprecated: Since 4.12
Returns the baseline that has currently been allocated to @self. Read more
source§

fn allocated_height(&self) -> i32

👎Deprecated: Since 4.12
Returns the height that has currently been allocated to @self. Read more
source§

fn allocated_width(&self) -> i32

👎Deprecated: Since 4.12
Returns the width that has currently been allocated to @self. Read more
source§

fn allocation(&self) -> Allocation

👎Deprecated: Since 4.12
Retrieves the widget’s allocation. Read more
source§

fn ancestor(&self, widget_type: Type) -> Option<Widget>

Gets the first ancestor of @self with type @widget_type. Read more
source§

fn baseline(&self) -> i32

Available on crate feature v4_12 only.
Returns the baseline that has currently been allocated to @self. Read more
source§

fn can_focus(&self) -> bool

Determines whether the input focus can enter @self or any of its children. Read more
source§

fn can_target(&self) -> bool

Queries whether @self can be the target of pointer events. Read more
source§

fn is_child_visible(&self) -> bool

Gets the value set with gtk_widget_set_child_visible(). Read more
source§

fn clipboard(&self) -> Clipboard

Gets the clipboard object for @self. Read more
source§

fn color(&self) -> RGBA

Available on crate feature v4_10 only.
Gets the current foreground color for the widget’s CSS style. Read more
source§

fn css_classes(&self) -> Vec<GString>

Returns the list of style classes applied to @self. Read more
source§

fn css_name(&self) -> GString

Returns the CSS name that is used for @self. Read more
source§

fn cursor(&self) -> Option<Cursor>

Queries the cursor set on @self. Read more
source§

fn direction(&self) -> TextDirection

Gets the reading direction for a particular widget. Read more
source§

fn display(&self) -> Display

Get the gdk::Display for the toplevel window associated with this widget. Read more
source§

fn first_child(&self) -> Option<Widget>

Returns the widget’s first child. Read more
source§

fn focus_child(&self) -> Option<Widget>

Returns the current focus child of @self. Read more
source§

fn gets_focus_on_click(&self) -> bool

Returns whether the widget should grab focus when it is clicked with the mouse. Read more
source§

fn is_focusable(&self) -> bool

Determines whether @self can own the input focus. Read more
source§

fn font_map(&self) -> Option<FontMap>

Gets the font map of @self. Read more
source§

fn font_options(&self) -> Option<FontOptions>

👎Deprecated: Since 4.16
Returns the cairo::FontOptions of widget. Read more
source§

fn frame_clock(&self) -> Option<FrameClock>

Obtains the frame clock for a widget. Read more
source§

fn halign(&self) -> Align

Gets the horizontal alignment of @self. Read more
source§

fn has_tooltip(&self) -> bool

Returns the current value of the has-tooltip property. Read more
source§

fn height(&self) -> i32

Returns the content height of the widget. Read more
source§

fn hexpands(&self) -> bool

Gets whether the widget would like any available extra horizontal space. Read more
source§

fn is_hexpand_set(&self) -> bool

Gets whether gtk_widget_set_hexpand() has been used to explicitly set the expand flag on this widget. Read more
source§

fn last_child(&self) -> Option<Widget>

Returns the widget’s last child. Read more
source§

fn layout_manager(&self) -> Option<LayoutManager>

Retrieves the layout manager used by @self. Read more
source§

fn is_mapped(&self) -> bool

Whether the widget is mapped. Read more
source§

fn margin_bottom(&self) -> i32

Gets the bottom margin of @self. Read more
source§

fn margin_end(&self) -> i32

Gets the end margin of @self. Read more
source§

fn margin_start(&self) -> i32

Gets the start margin of @self. Read more
source§

fn margin_top(&self) -> i32

Gets the top margin of @self. Read more
source§

fn widget_name(&self) -> GString

Retrieves the name of a widget. Read more
source§

fn native(&self) -> Option<Native>

Returns the nearest Native ancestor of @self. Read more
source§

fn next_sibling(&self) -> Option<Widget>

Returns the widget’s next sibling. Read more
source§

fn opacity(&self) -> f64

#Fetches the requested opacity for this widget. Read more
source§

fn overflow(&self) -> Overflow

Returns the widget’s overflow value. Read more
source§

fn pango_context(&self) -> Context

Gets a pango::Context with the appropriate font map, font description, and base direction for this widget. Read more
source§

fn parent(&self) -> Option<Widget>

Returns the parent widget of @self. Read more
source§

fn preferred_size(&self) -> (Requisition, Requisition)

Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management. Read more
source§

fn prev_sibling(&self) -> Option<Widget>

Returns the widget’s previous sibling. Read more
source§

fn primary_clipboard(&self) -> Clipboard

Gets the primary clipboard of @self. Read more
source§

fn is_realized(&self) -> bool

Determines whether @self is realized. Read more
source§

fn receives_default(&self) -> bool

Determines whether @self is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default. Read more
source§

fn request_mode(&self) -> SizeRequestMode

Gets whether the widget prefers a height-for-width layout or a width-for-height layout. Read more
source§

fn root(&self) -> Option<Root>

Returns the Root widget of @self. Read more
source§

fn scale_factor(&self) -> i32

Retrieves the internal scale factor that maps from window coordinates to the actual device pixels. Read more
source§

fn get_sensitive(&self) -> bool

Returns the widget’s sensitivity. Read more
source§

fn settings(&self) -> Settings

Gets the settings object holding the settings used for this widget. Read more
source§

fn size(&self, orientation: Orientation) -> i32

Returns the content width or height of the widget. Read more
source§

fn size_request(&self) -> (i32, i32)

Gets the size request that was explicitly set for the widget using gtk_widget_set_size_request(). Read more
source§

fn state_flags(&self) -> StateFlags

Returns the widget state as a flag set. Read more
source§

fn style_context(&self) -> StyleContext

👎Deprecated: Since 4.10
Returns the style context associated to @self. Read more
source§

fn tooltip_markup(&self) -> Option<GString>

Gets the contents of the tooltip for @self. Read more
source§

fn tooltip_text(&self) -> Option<GString>

Gets the contents of the tooltip for @self. Read more
source§

fn valign(&self) -> Align

Gets the vertical alignment of @self. Read more
source§

fn vexpands(&self) -> bool

Gets whether the widget would like any available extra vertical space. Read more
source§

fn is_vexpand_set(&self) -> bool

Gets whether gtk_widget_set_vexpand() has been used to explicitly set the expand flag on this widget. Read more
source§

fn get_visible(&self) -> bool

Determines whether the widget is visible. Read more
source§

fn width(&self) -> i32

Returns the content width of the widget. Read more
source§

fn grab_focus(&self) -> bool

Causes @self to have the keyboard focus for the Window it’s inside. Read more
source§

fn has_css_class(&self, css_class: &str) -> bool

Returns whether @css_class is currently applied to @self. Read more
source§

fn has_default(&self) -> bool

Determines whether @self is the current default widget within its toplevel. Read more
source§

fn has_focus(&self) -> bool

Determines if the widget has the global input focus. Read more
source§

fn has_visible_focus(&self) -> bool

Determines if the widget should show a visible indication that it has the global input focus. Read more
source§

fn hide(&self)

👎Deprecated: Since 4.10
Reverses the effects of gtk_widget_show(). Read more
source§

fn in_destruction(&self) -> bool

Returns whether the widget is currently being destroyed. Read more
source§

fn insert_action_group(&self, name: &str, group: Option<&impl IsA<ActionGroup>>)

Inserts @group into @self. Read more
source§

fn insert_after( &self, parent: &impl IsA<Widget>, previous_sibling: Option<&impl IsA<Widget>>, )

Inserts @self into the child widget list of @parent. Read more
source§

fn insert_before( &self, parent: &impl IsA<Widget>, next_sibling: Option<&impl IsA<Widget>>, )

Inserts @self into the child widget list of @parent. Read more
source§

fn is_ancestor(&self, ancestor: &impl IsA<Widget>) -> bool

Determines whether @self is somewhere inside @ancestor, possibly with intermediate containers. Read more
source§

fn is_drawable(&self) -> bool

Determines whether @self can be drawn to. Read more
source§

fn is_focus(&self) -> bool

Determines if the widget is the focus widget within its toplevel. Read more
source§

fn is_sensitive(&self) -> bool

Returns the widget’s effective sensitivity. Read more
source§

fn is_visible(&self) -> bool

Determines whether the widget and all its parents are marked as visible. Read more
source§

fn keynav_failed(&self, direction: DirectionType) -> bool

Emits the ::keynav-failed signal on the widget. Read more
source§

fn list_mnemonic_labels(&self) -> Vec<Widget>

Returns the widgets for which this widget is the target of a mnemonic. Read more
source§

fn map(&self)

Causes a widget to be mapped if it isn’t already. Read more
source§

fn measure( &self, orientation: Orientation, for_size: i32, ) -> (i32, i32, i32, i32)

Measures @self in the orientation @orientation and for the given @for_size. Read more
source§

fn mnemonic_activate(&self, group_cycling: bool) -> bool

Emits the ::mnemonic-activate signal. Read more
source§

fn observe_children(&self) -> ListModel

Returns a GListModel to track the children of @self. Read more
source§

fn observe_controllers(&self) -> ListModel

Returns a GListModel to track the EventControllers of @self. Read more
source§

fn pick(&self, x: f64, y: f64, flags: PickFlags) -> Option<Widget>

Finds the descendant of @self closest to the point (@x, @y). Read more
source§

fn queue_allocate(&self)

Flags the widget for a rerun of the WidgetImpl::size_allocate() function. Read more
source§

fn queue_draw(&self)

Schedules this widget to be redrawn in the paint phase of the current or the next frame. Read more
source§

fn queue_resize(&self)

Flags a widget to have its size renegotiated. Read more
source§

fn realize(&self)

Creates the GDK resources associated with a widget. Read more
source§

fn remove_controller(&self, controller: &impl IsA<EventController>)

Removes @controller from @self, so that it doesn’t process events anymore. Read more
source§

fn remove_css_class(&self, css_class: &str)

Removes a style from @self. Read more
source§

fn remove_mnemonic_label(&self, label: &impl IsA<Widget>)

Removes a widget from the list of mnemonic labels for this widget. Read more
source§

fn set_can_focus(&self, can_focus: bool)

Specifies whether the input focus can enter the widget or any of its children. Read more
source§

fn set_can_target(&self, can_target: bool)

Sets whether @self can be the target of pointer events. Read more
source§

fn set_child_visible(&self, child_visible: bool)

Sets whether @self should be mapped along with its parent. Read more
source§

fn set_css_classes(&self, classes: &[&str])

Clear all style classes applied to @self and replace them with @classes. Read more
source§

fn set_cursor(&self, cursor: Option<&Cursor>)

Sets the cursor to be shown when pointer devices point towards @self. Read more
source§

fn set_cursor_from_name(&self, name: Option<&str>)

Sets a named cursor to be shown when pointer devices point towards @self. Read more
source§

fn set_direction(&self, dir: TextDirection)

Sets the reading direction on a particular widget. Read more
source§

fn set_focus_child(&self, child: Option<&impl IsA<Widget>>)

Set @child as the current focus child of @self. Read more
source§

fn set_focus_on_click(&self, focus_on_click: bool)

Sets whether the widget should grab focus when it is clicked with the mouse. Read more
source§

fn set_focusable(&self, focusable: bool)

Specifies whether @self can own the input focus. Read more
source§

fn set_font_map(&self, font_map: Option<&impl IsA<FontMap>>)

Sets the font map to use for Pango rendering. Read more
source§

fn set_font_options(&self, options: Option<&FontOptions>)

👎Deprecated: Since 4.16
Sets the cairo::FontOptions used for Pango rendering in this widget. Read more
source§

fn set_halign(&self, align: Align)

Sets the horizontal alignment of @self. Read more
source§

fn set_has_tooltip(&self, has_tooltip: bool)

Sets the has-tooltip property on @self to @has_tooltip. Read more
source§

fn set_hexpand(&self, expand: bool)

Sets whether the widget would like any available extra horizontal space. Read more
source§

fn set_hexpand_set(&self, set: bool)

Sets whether the hexpand flag will be used. Read more
source§

fn set_layout_manager(&self, layout_manager: Option<impl IsA<LayoutManager>>)

Sets the layout manager delegate instance that provides an implementation for measuring and allocating the children of @self. Read more
source§

fn set_margin_bottom(&self, margin: i32)

Sets the bottom margin of @self. Read more
source§

fn set_margin_end(&self, margin: i32)

Sets the end margin of @self. Read more
source§

fn set_margin_start(&self, margin: i32)

Sets the start margin of @self. Read more
source§

fn set_margin_top(&self, margin: i32)

Sets the top margin of @self. Read more
source§

fn set_widget_name(&self, name: &str)

Sets a widgets name. Read more
source§

fn set_opacity(&self, opacity: f64)

Request the @self to be rendered partially transparent. Read more
source§

fn set_overflow(&self, overflow: Overflow)

Sets how @self treats content that is drawn outside the widget’s content area. Read more
source§

fn set_parent(&self, parent: &impl IsA<Widget>)

Sets @parent as the parent widget of @self. Read more
source§

fn set_receives_default(&self, receives_default: bool)

Specifies whether @self will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default. Read more
source§

fn set_sensitive(&self, sensitive: bool)

Sets the sensitivity of a widget. Read more
source§

fn set_size_request(&self, width: i32, height: i32)

Sets the minimum size of a widget. Read more
source§

fn set_state_flags(&self, flags: StateFlags, clear: bool)

Turns on flag values in the current widget state. Read more
source§

fn set_tooltip_markup(&self, markup: Option<&str>)

Sets @markup as the contents of the tooltip, which is marked up with Pango markup. Read more
source§

fn set_tooltip_text(&self, text: Option<&str>)

Sets @text as the contents of the tooltip. Read more
source§

fn set_valign(&self, align: Align)

Sets the vertical alignment of @self. Read more
source§

fn set_vexpand(&self, expand: bool)

Sets whether the widget would like any available extra vertical space. Read more
source§

fn set_vexpand_set(&self, set: bool)

Sets whether the vexpand flag will be used. Read more
source§

fn set_visible(&self, visible: bool)

Sets the visibility state of @self. Read more
source§

fn should_layout(&self) -> bool

Returns whether @self should contribute to the measuring and allocation of its parent. Read more
source§

fn show(&self)

👎Deprecated: Since 4.10
Flags a widget to be displayed. Read more
source§

fn size_allocate(&self, allocation: &Allocation, baseline: i32)

Allocates widget with a transformation that translates the origin to the position in @allocation. Read more
source§

fn snapshot_child( &self, child: &impl IsA<Widget>, snapshot: &impl IsA<Snapshot>, )

Snapshot the a child of @self. Read more
source§

fn translate_coordinates( &self, dest_widget: &impl IsA<Widget>, src_x: f64, src_y: f64, ) -> Option<(f64, f64)>

👎Deprecated: Since 4.12
Translate coordinates relative to @self’s allocation to coordinates relative to @dest_widget’s allocations. Read more
source§

fn trigger_tooltip_query(&self)

Triggers a tooltip query on the display where the toplevel of @self is located.
source§

fn unmap(&self)

Causes a widget to be unmapped if it’s currently mapped. Read more
source§

fn unparent(&self)

Dissociate @self from its parent. Read more
source§

fn unrealize(&self)

Causes a widget to be unrealized (frees all GDK resources associated with the widget). Read more
source§

fn unset_state_flags(&self, flags: StateFlags)

Turns off flag values for the current widget state. Read more
source§

fn height_request(&self) -> i32

Override for height request of the widget. Read more
source§

fn set_height_request(&self, height_request: i32)

Override for height request of the widget. Read more
source§

fn width_request(&self) -> i32

Override for width request of the widget. Read more
source§

fn set_width_request(&self, width_request: i32)

Override for width request of the widget. Read more
source§

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

Signals that all holders of a reference to the widget should release the reference that they hold. Read more
source§

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

Emitted when the text direction of a widget changes. Read more
source§

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

Emitted when @widget is hidden.
source§

fn connect_keynav_failed<F: Fn(&Self, DirectionType) -> Propagation + 'static>( &self, f: F, ) -> SignalHandlerId

Emitted if keyboard navigation fails. Read more
source§

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

Emitted when @widget is going to be mapped. Read more
source§

fn connect_mnemonic_activate<F: Fn(&Self, bool) -> Propagation + 'static>( &self, f: F, ) -> SignalHandlerId

Emitted when a widget is activated via a mnemonic. Read more
source§

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

Emitted when the focus is moved. Read more
source§

fn emit_move_focus(&self, direction: DirectionType)

source§

fn connect_query_tooltip<F: Fn(&Self, i32, i32, bool, &Tooltip) -> bool + 'static>( &self, f: F, ) -> SignalHandlerId

Emitted when the widget’s tooltip is about to be shown. Read more
source§

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

Emitted when @widget is associated with a gdk::Surface. Read more
source§

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

Emitted when @widget is shown.
source§

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

Emitted when the widget state changes. Read more
source§

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

Emitted when @widget is going to be unmapped. Read more
source§

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

Emitted when the gdk::Surface associated with @widget is destroyed. Read more
source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

impl<O> WidgetExtManual for O
where O: IsA<Widget>,

source§

fn add_tick_callback<P: Fn(&Self, &FrameClock) -> ControlFlow + 'static>( &self, callback: P, ) -> TickCallbackId

Queues an animation frame update and adds a callback to be called before each frame. Read more
source§

impl<O> ConstraintTargetExt for O

source§

impl<'a, T, C, E> FromValueOptional<'a> for T
where T: FromValue<'a, Checker = C>, C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError<E>>, E: Error + Send + 'static,

source§

impl<Super, Sub> MayDowncastTo<Sub> for Super
where Super: IsA<Super>, Sub: IsA<Super>,