Skip to main content

Sidebar

Struct Sidebar 

Source
pub struct Sidebar { /* private fields */ }
Available on crate feature v1_9 only.
Expand description

## CSS nodes

[`Sidebar`][crate::Sidebar] has a main CSS node with the name `sidebar`.

Internally, it's using a `Gtk::ListBox` with the
[`.navigation-sidebar`](style-classes.html#sidebars) style class in sidebar
mode, or an [`PreferencesPage`][crate::PreferencesPage] in page mode.

## Accessibility

[`Sidebar`][crate::Sidebar] uses the [enum@Gtk.AccessibleRole.generic] role.

## Properties


#### `drop-preload`
 Whether the drop data should be preloaded on hover.

See [`preload`][struct@crate::Gtk::DropTarget#preload].

Readable | Writable


#### `filter`
 The item filter.

Can be used to implement search within the sidebar.

Use [`placeholder`][struct@crate::Sidebar#placeholder] to provide an empty state.

Readable | Writable


#### `items`
 A list model with the sidebar's items.

This can be used to keep an up-to-date view.

The model implements `Gtk::SectionModel` and creates sections
corresponding to the sidebar's sections.

The model also implements [`gtk::SelectionModel`][crate::gtk::SelectionModel] and can be used to
track and change the selection.

To only track sections, use [`sections`][struct@crate::Sidebar#sections] instead.

Readable


#### `menu-model`
 Context menu model for the items.

When a context menu is shown for an item, it will be constructed from the
provided menu model. Use the [`setup-menu`][struct@crate::Sidebar#setup-menu] signal to set up
the menu actions for the particular item.

[`menu-model`][struct@crate::Sidebar#menu-model] will be preferred over this model if set.

Readable | Writable


#### `mode`


If set to [enum@Adw.SidebarMode.sidebar], behaves like a sidebar: with a
sidebar style and a persistent selection.

If set to [enum@Adw.SidebarMode.page], behaves like a page of boxed lists.
In this mode, the selection is invisible and only tracked to determine the
initially selected item once switched back to sidebar mode.

The page mode is intended to be used with [`NavigationSplitView`][crate::NavigationSplitView] when
collapsed, as the sidebar pane becomes a page there.

When used with [`OverlaySplitView`][crate::OverlaySplitView], the sidebar should stay in sidebar
mode, as the sidebar pane is still a sidebar when collapsed.

Readable | Writable


#### `placeholder`
 The placeholder widget.

This widget will be shown if the sidebar has no items, or all of its items
have been filtered out by [`filter`][struct@crate::Sidebar#filter].

Readable | Writable


#### `prefix`
 A widget to be displayed before the sidebar items.

Readable | Writable


#### `sections`
 A list model with the sidebar's sections.

This can be used to keep an up-to-date view.

To track items, use [`items`][struct@crate::Sidebar#items] instead.

Readable


#### `selected`
 The index of the currently selected item.

If set to `Gtk::INVALID_LIST_POSITION`, no item is selected.

If [`mode`][struct@crate::Sidebar#mode] is set to [enum@Adw.SidebarMode.page], the
selection is invisible, but still tracked, indicating which item will be
selected once the mode is changed to [enum@Adw.SidebarMode.sidebar].

See also: [`selected-item`][struct@crate::Sidebar#selected-item].

Readable | Writable


#### `selected-item`
 The currently selected item.

This is a convenience property, equivalent to calling
[`Sidebar::item()`][crate::Sidebar::item()] with [`selected`][struct@crate::Sidebar#selected] provided as the
index.

To change selection, use [`selected`][struct@crate::Sidebar#selected].

Readable


#### `suffix`
 A widget to be displayed after the sidebar items.

Readable | Writable
<details><summary><h4>Widget</h4></summary>


#### `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 | Writable


#### `can-target`
 Whether the widget can receive pointer events.

Readable | Writable


#### `css-classes`
 A list of css classes applied to this widget.

Readable | Writable


#### `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 | Writable | Construct Only


#### `cursor`
 The cursor used by @widget.

Readable | Writable


#### `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 | Writable


#### `focusable`
 Whether this widget itself will accept the input focus.

Readable | Writable


#### `halign`
 How to distribute horizontal space if widget gets extra space.

Readable | Writable


#### `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`][struct@crate::gtk::Widget#query-tooltip]
signal on @widget.

A true value indicates that @widget can have a tooltip, in this case
the widget will be queried using [`query-tooltip`][struct@crate::gtk::Widget#query-tooltip] to
determine whether it will provide a tooltip or not.

Readable | Writable


#### `height-request`
 Overrides for height request of the widget.

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

Readable | Writable


#### `hexpand`
 Whether to expand horizontally.

Readable | Writable


#### `hexpand-set`
 Whether to use the `hexpand` property.

Readable | Writable


#### `layout-manager`
 The [`gtk::LayoutManager`][crate::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 | Writable


#### `limit-events`
 Makes this widget act like a modal dialog, with respect to
event delivery.

Global event controllers will not handle events with targets
inside the widget, unless they are set up to ignore propagation
limits. See `Gtk::EventController::set_propagation_limit()`.

Readable | Writable


#### `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 | Writable


#### `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 | Writable


#### `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 | Writable


#### `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 | Writable


#### `name`
 The name of the widget.

Readable | Writable


#### `opacity`
 The requested opacity of the widget.

Readable | Writable


#### `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 | Writable


#### `parent`
 The parent widget of this widget.

Readable


#### `receives-default`
 Whether the widget will receive the default action when it is focused.

Readable | Writable


#### `root`
 The [`gtk::Root`][crate::gtk::Root] widget of the widget tree containing this widget.

This will be `NULL` 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 | Writable


#### `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 `NULL`:
[`has-tooltip`][struct@crate::gtk::Widget#has-tooltip] will automatically be set to true
and there will be taken care of [`query-tooltip`][struct@crate::gtk::Widget#query-tooltip] in
the default signal handler.

Note that if both [`tooltip-text`][struct@crate::gtk::Widget#tooltip-text] and
[`tooltip-markup`][struct@crate::gtk::Widget#tooltip-markup] are set, the last one wins.

Readable | Writable


#### `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 `NULL`:
[`has-tooltip`][struct@crate::gtk::Widget#has-tooltip] will automatically be set to true
and there will be taken care of [`query-tooltip`][struct@crate::gtk::Widget#query-tooltip] in
the default signal handler.

Note that if both [`tooltip-text`][struct@crate::gtk::Widget#tooltip-text] and
[`tooltip-markup`][struct@crate::gtk::Widget#tooltip-markup] are set, the last one wins.

Readable | Writable


#### `valign`
 How to distribute vertical space if widget gets extra space.

Readable | Writable


#### `vexpand`
 Whether to expand vertically.

Readable | Writable


#### `vexpand-set`
 Whether to use the `vexpand` property.

Readable | Writable


#### `visible`
 Whether the widget is visible.

Readable | Writable


#### `width-request`
 Overrides for width request of the widget.

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

Readable | Writable
</details>
<details><summary><h4>Accessible</h4></summary>


#### `accessible-role`
 The accessible role of the given [`gtk::Accessible`][crate::gtk::Accessible] implementation.

The accessible role cannot be changed once set.

Readable | Writable
</details>

## Signals


#### `activated`
 Emitted when an item at @index has been activated.




#### `drop`
 Emitted when content is dropped onto the item at @index.

The content must be of one of the types set up via
[`Sidebar::setup_drop_target()`][crate::Sidebar::setup_drop_target()].

See [`drop`][struct@crate::Gtk::DropTarget#drop].




#### `drop-enter`
 Emitted when the pointer enters the item at @index.

Applications can use this to set their default drop action even when
[`drop-preload`][struct@crate::Sidebar#drop-preload] is set to `FALSE`.

See [`enter`][struct@crate::Gtk::DropTarget#enter].




#### `drop-value-loaded`
 Emitted when the dropped content is preloaded for the item at @index.

In order for data to be preloaded, [`drop-preload`][struct@crate::Sidebar#drop-preload]
must be set to `TRUE`.

The content must be of one of the types set up via
[`Sidebar::setup_drop_target()`][crate::Sidebar::setup_drop_target()].

See [`value`][struct@crate::Gtk::DropTarget#value].




#### `setup-menu`
 Emitted when a context menu is opened or closed for @item.

If the menu has been closed, @item will be set to `NULL`.

It can be used to set up menu actions before showing the menu, for example
disable actions not applicable to @item.


<details><summary><h4>Widget</h4></summary>


#### `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 [`WidgetExtManual::keynav_failed()`][crate::gtk::prelude::WidgetExtManual::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`][struct@crate::gtk::Widget#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`][struct@crate::gtk::Widget#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`
  to move backward.

Action


#### `query-tooltip`
 s tooltip is about to be shown.

This happens when the [`has-tooltip`][struct@crate::gtk::Widget#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 `GdkSurface`.

This means that [`WidgetExtManual::realize()`][crate::gtk::prelude::WidgetExtManual::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 [`WidgetExtManual::state_flags()`][crate::gtk::prelude::WidgetExtManual::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 `GdkSurface` associated with @widget is destroyed.

This means that [`WidgetExtManual::unrealize()`][crate::gtk::prelude::WidgetExtManual::unrealize()] has been called
or the widget has been unmapped (that is, it is going to be hidden).


</details>

# Implements

[`trait@gtk::prelude::WidgetExt`], [`trait@glib::ObjectExt`], [`trait@gtk::prelude::AccessibleExt`], [`trait@gtk::prelude::BuildableExt`], [`trait@gtk::prelude::ConstraintTargetExt`]

GLib type: GObject with reference counted clone semantics.

Implementations§

Source§

impl Sidebar

Source

pub fn new() -> Sidebar

Creates a new Sidebar.

§Returns

the newly created Sidebar

Source

pub fn builder() -> SidebarBuilder

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

This method returns an instance of SidebarBuilder which can be used to create Sidebar objects.

Source

pub fn append(&self, section: SidebarSection)

Appends @section to @self.

§section

a section to append

Source

pub fn is_drop_preload(&self) -> bool

Gets whether drop data should be preloaded on hover.

§Returns

whether drop data should be preloaded on hover

Source

pub fn filter(&self) -> Option<Filter>

Gets the item filter for @self.

§Returns

the item filter

Source

pub fn item(&self, index: u32) -> Option<SidebarItem>

Gets the item at @index within @self.

The index starts from 0 at the top of the sidebar, and is same as the one returned by SidebarItemExt::index().

Can return NULL if @index is larger or equal to the number of items.

§index

index of the item

§Returns

the item at @index

Source

pub fn items(&self) -> SelectionModel

Gets a list model with @self’s items.

This can be used to keep an up-to-date view.

The model implements Gtk::SectionModel and creates sections corresponding to the sidebar’s sections.

The model also implements gtk::SelectionModel and can be used to track and change the selection.

To only track sections, use sections instead.

§Returns

a model containing the items

Source

pub fn menu_model(&self) -> Option<MenuModel>

Gets the context menu model for @self’s items.

§Returns

the context menu model

Source

pub fn mode(&self) -> SidebarMode

Gets @self’s look and behavior.

§Returns

the current mode

Source

pub fn placeholder(&self) -> Option<Widget>

Gets the placeholder widget for @self.

§Returns

the placeholder widget

Source

pub fn prefix(&self) -> Option<Widget>

Available on crate feature v1_10 only.

Gets the widget displayed before the sidebar items.

§Returns

the prefix widget

Source

pub fn section(&self, index: u32) -> Option<SidebarSection>

Gets the section at @index within @self.

Can return NULL if @index is larger or equal to the number of sections.

§index

index of the section

§Returns

the section at @index

Source

pub fn sections(&self) -> ListModel

Gets a list model with @self’s sections.

This can be used to keep an up-to-date view.

To track items, use items instead.

§Returns

a model containing the sections

Source

pub fn selected(&self) -> u32

Gets the index of the currently selected item.

See also: selected_item().

§Returns

index of the currently selected item

Source

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

Gets the currently selected item.

This is a convenience method, equivalent to calling item() with selected provided as the index.

To change selection, use set_selected().

§Returns

the selected item

Source

pub fn suffix(&self) -> Option<Widget>

Available on crate feature v1_10 only.

Gets the widget displayed after sidebar items.

§Returns

the suffix widget

Source

pub fn insert(&self, section: SidebarSection, position: i32)

Inserts @section at @position to @self.

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

§section

a section to insert

§position

position to insert @section at

Source

pub fn prepend(&self, section: SidebarSection)

Prepends @section to @self.

§section

a section to prepend

Source

pub fn remove(&self, section: &SidebarSection)

Removes @section from @self.

§section

a section to remove

Source

pub fn remove_all(&self)

Removes all sections from @self.

Source

pub fn set_drop_preload(&self, preload: bool)

Sets whether drop data should be preloaded on hover.

See [preload][struct@crate::Gtk::DropTarget#preload].

§preload

whether to preload drop data

Source

pub fn set_filter(&self, filter: Option<&impl IsA<Filter>>)

Sets the item filter for @self.

Can be used to implement search within the sidebar.

Use placeholder to provide an empty state.

§filter

the item filter

Source

pub fn set_menu_model(&self, menu_model: Option<&impl IsA<MenuModel>>)

Sets the context menu model for @self’s items.

When a context menu is shown for an item, it will be constructed from the provided menu model. Use the setup-menu signal to set up the menu actions for the particular item.

menu-model will be preferred over this model if set.

a menu model

Source

pub fn set_mode(&self, mode: SidebarMode)

If set to [enum@Adw.SidebarMode.sidebar], behaves like a sidebar: with a sidebar style and a persistent selection.

If set to [enum@Adw.SidebarMode.page], behaves like a page of boxed lists. In this mode, the selection is invisible and only tracked to determine the initially selected item once switched back to sidebar mode.

The page mode is intended to be used with NavigationSplitView when collapsed, as the sidebar pane becomes a page there.

When used with OverlaySplitView, the sidebar should stay in sidebar mode, as the sidebar pane is still a sidebar when collapsed.

§mode

the new mode

Source

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

Sets the placeholder widget for @self.

This widget will be shown if @self has no items, or all of its items have been filtered out by filter.

§placeholder

the placeholder widget

Source

pub fn set_prefix(&self, prefix: Option<&impl IsA<Widget>>)

Available on crate feature v1_10 only.

Sets the widget to be displayed before the sidebar items.

§prefix

the prefix widget

Source

pub fn set_selected(&self, selected: u32)

Selects the item at @selected.

If set to Gtk::INVALID_LIST_POSITION, no item is selected.

If mode is set to [enum@Adw.SidebarMode.page], the selection is invisible, but still tracked, indicating which item will be selected once the mode is changed to [enum@Adw.SidebarMode.sidebar].

See also: selected-item.

§selected

index of the newly selected item

Source

pub fn set_suffix(&self, suffix: Option<&impl IsA<Widget>>)

Available on crate feature v1_10 only.

Sets the widget to be displayed after the sidebar items.

§suffix

the suffix widget

Source

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

Emitted when an item at @index has been activated.

§index

the item index

Source

pub fn connect_drop<F: Fn(&Self, u32, &Value, DragAction) -> bool + 'static>( &self, f: F, ) -> SignalHandlerId

Emitted when content is dropped onto the item at @index.

The content must be of one of the types set up via setup_drop_target().

See [drop][struct@crate::Gtk::DropTarget#drop].

§index

index of the item the content was dropped onto

§value

the GValue being dropped

§preferred_action

the preferred drop action

§Returns

whether the drop was accepted

SinceL 1.9

Source

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

Emitted when the pointer enters the item at @index.

Applications can use this to set their default drop action even when drop-preload is set to FALSE.

See [enter][struct@crate::Gtk::DropTarget#enter].

§index

index of the hovered item

§Returns

the preferred action for the drop

Source

pub fn connect_drop_value_loaded<F: Fn(&Self, u32, &Value) -> DragAction + 'static>( &self, f: F, ) -> SignalHandlerId

Emitted when the dropped content is preloaded for the item at @index.

In order for data to be preloaded, drop-preload must be set to TRUE.

The content must be of one of the types set up via setup_drop_target().

See [value][struct@crate::Gtk::DropTarget#value].

§index

index of the hovered item

§value

the GValue being dropped

§Returns

the preferred action for the drop

Source

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

Emitted when a context menu is opened or closed for @item.

If the menu has been closed, @item will be set to NULL.

It can be used to set up menu actions before showing the menu, for example disable actions not applicable to @item.

§item

an item in @self_

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Available on crate feature v1_10 only.
Source

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

Source

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

Source

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

Source

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

Available on crate feature v1_10 only.
Source§

impl Sidebar

Source

pub fn setup_drop_target(&self, actions: DragAction, types: &[Type])

Sets up a drop target on the items.

This allows to drag arbitrary content onto items.

The drop signal can be used to handle the drop.

§actions

the supported actions

§types

all supported GTypes that can be dropped

Trait Implementations§

Source§

impl Clone for Sidebar

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.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Sidebar

Source§

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

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

impl Default for Sidebar

Source§

fn default() -> Self

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

impl Eq for Sidebar

Source§

impl HasParamSpec for Sidebar

Source§

type ParamSpec = ParamSpecObject

Source§

type SetValue = Sidebar

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

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

Source§

fn param_spec_builder() -> Self::BuilderFn

Source§

impl Hash for Sidebar

Source§

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

Hashes the memory address of this object.

1.3.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 IsA<Accessible> for Sidebar

Source§

impl IsA<Buildable> for Sidebar

Source§

impl IsA<ConstraintTarget> for Sidebar

Source§

impl IsA<Widget> for Sidebar

Source§

impl Ord for Sidebar

Source§

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

1.21.0 (const: unstable) · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · 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 Sidebar

Source§

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

Source§

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

1.0.0 (const: unstable) · 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 Sidebar

Source§

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · 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.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · 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 Sidebar

Source§

fn static_type() -> Type

Returns the type identifier of Self.

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.
Source§

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

Available on crate feature v4_22 only.
Source§

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

Source§

fn accessible_role(&self) -> AccessibleRole

Source§

fn at_context(&self) -> ATContext

Source§

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

Source§

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

Source§

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

Source§

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

Source§

fn reset_property(&self, property: AccessibleProperty)

Source§

fn reset_relation(&self, relation: AccessibleRelation)

Source§

fn reset_state(&self, state: AccessibleState)

Source§

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

Source§

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

Source§

fn update_platform_state(&self, state: AccessiblePlatformState)

Available on crate feature v4_18 only.
Source§

fn set_accessible_role(&self, accessible_role: AccessibleRole)

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

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§

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, dest: *mut u8)

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

impl<O> ConstraintTargetExt for O

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<'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<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<Super, Sub> MayDowncastTo<Sub> for Super
where Super: IsA<Super>, Sub: IsA<Super>,

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) -> bool

Check if the object has a property property_name.
Source§

fn has_property_with_type(&self, property_name: &str, type_: Type) -> bool

Check if the object has a property property_name of the given type_.
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)

Source§

fn activate(&self) -> bool

Source§

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

Source§

fn activate_default(&self)

Source§

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

Source§

fn add_css_class(&self, css_class: &str)

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

fn create_pango_context(&self) -> Context

Source§

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

Source§

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

Source§

fn error_bell(&self)

Source§

fn allocated_baseline(&self) -> i32

👎Deprecated:

Since 4.12

Source§

fn allocated_height(&self) -> i32

👎Deprecated:

Since 4.12

Source§

fn allocated_width(&self) -> i32

👎Deprecated:

Since 4.12

Source§

fn allocation(&self) -> Rectangle

👎Deprecated:

Since 4.12

Source§

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

Source§

fn baseline(&self) -> i32

Available on crate feature v4_12 only.
Source§

fn can_focus(&self) -> bool

Source§

fn can_target(&self) -> bool

Source§

fn is_child_visible(&self) -> bool

Source§

fn clipboard(&self) -> Clipboard

Source§

fn color(&self) -> RGBA

Available on crate feature v4_10 only.
Source§

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

Source§

fn css_name(&self) -> GString

Source§

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

Source§

fn direction(&self) -> TextDirection

Source§

fn display(&self) -> Display

Source§

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

Source§

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

Source§

fn gets_focus_on_click(&self) -> bool

Source§

fn is_focusable(&self) -> bool

Source§

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

Source§

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

👎Deprecated:

Since 4.16

Source§

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

Source§

fn halign(&self) -> Align

Source§

fn has_tooltip(&self) -> bool

Source§

fn height(&self) -> i32

Source§

fn hexpands(&self) -> bool

Source§

fn is_hexpand_set(&self) -> bool

Source§

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

Source§

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

Source§

fn is_limit_events(&self) -> bool

Available on crate feature v4_18 only.
Source§

fn is_mapped(&self) -> bool

Source§

fn margin_bottom(&self) -> i32

Source§

fn margin_end(&self) -> i32

Source§

fn margin_start(&self) -> i32

Source§

fn margin_top(&self) -> i32

Source§

fn widget_name(&self) -> GString

Source§

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

Source§

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

Source§

fn opacity(&self) -> f64

Source§

fn overflow(&self) -> Overflow

Source§

fn pango_context(&self) -> Context

Source§

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

Source§

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

Source§

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

Source§

fn primary_clipboard(&self) -> Clipboard

Source§

fn is_realized(&self) -> bool

Source§

fn receives_default(&self) -> bool

Source§

fn request_mode(&self) -> SizeRequestMode

Source§

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

Source§

fn scale_factor(&self) -> i32

Source§

fn get_sensitive(&self) -> bool

Source§

fn settings(&self) -> Settings

Source§

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

Source§

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

Source§

fn state_flags(&self) -> StateFlags

Source§

fn style_context(&self) -> StyleContext

👎Deprecated:

Since 4.10

Source§

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

Source§

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

Source§

fn valign(&self) -> Align

Source§

fn vexpands(&self) -> bool

Source§

fn is_vexpand_set(&self) -> bool

Source§

fn get_visible(&self) -> bool

Source§

fn width(&self) -> i32

Source§

fn grab_focus(&self) -> bool

Source§

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

Source§

fn has_default(&self) -> bool

Source§

fn has_focus(&self) -> bool

Source§

fn has_visible_focus(&self) -> bool

Source§

fn hide(&self)

👎Deprecated:

Since 4.10

Source§

fn in_destruction(&self) -> bool

Source§

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

Source§

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

Source§

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

Source§

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

Source§

fn is_drawable(&self) -> bool

Source§

fn is_focus(&self) -> bool

Source§

fn is_sensitive(&self) -> bool

Source§

fn is_visible(&self) -> bool

Source§

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

Source§

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

Source§

fn map(&self)

Source§

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

Source§

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

Source§

fn observe_children(&self) -> ListModel

Source§

fn observe_controllers(&self) -> ListModel

Source§

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

Source§

fn queue_allocate(&self)

Source§

fn queue_draw(&self)

Source§

fn queue_resize(&self)

Source§

fn realize(&self)

Source§

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

Source§

fn remove_css_class(&self, css_class: &str)

Source§

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

Source§

fn set_can_focus(&self, can_focus: bool)

Source§

fn set_can_target(&self, can_target: bool)

Source§

fn set_child_visible(&self, child_visible: bool)

Source§

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

Source§

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

Source§

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

Source§

fn set_direction(&self, dir: TextDirection)

Source§

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

Source§

fn set_focus_on_click(&self, focus_on_click: bool)

Source§

fn set_focusable(&self, focusable: bool)

Source§

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

Source§

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

👎Deprecated:

Since 4.16

Source§

fn set_halign(&self, align: Align)

Source§

fn set_has_tooltip(&self, has_tooltip: bool)

Source§

fn set_hexpand(&self, expand: bool)

Source§

fn set_hexpand_set(&self, set: bool)

Source§

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

Source§

fn set_limit_events(&self, limit_events: bool)

Available on crate feature v4_18 only.
Source§

fn set_margin_bottom(&self, margin: i32)

Source§

fn set_margin_end(&self, margin: i32)

Source§

fn set_margin_start(&self, margin: i32)

Source§

fn set_margin_top(&self, margin: i32)

Source§

fn set_widget_name(&self, name: &str)

Source§

fn set_opacity(&self, opacity: f64)

Source§

fn set_overflow(&self, overflow: Overflow)

Source§

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

Source§

fn set_receives_default(&self, receives_default: bool)

Source§

fn set_sensitive(&self, sensitive: bool)

Source§

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

Source§

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

Source§

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

Source§

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

Source§

fn set_valign(&self, align: Align)

Source§

fn set_vexpand(&self, expand: bool)

Source§

fn set_vexpand_set(&self, set: bool)

Source§

fn set_visible(&self, visible: bool)

Source§

fn should_layout(&self) -> bool

Source§

fn show(&self)

👎Deprecated:

Since 4.10

Source§

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

Source§

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

Source§

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

👎Deprecated:

Since 4.12

Source§

fn trigger_tooltip_query(&self)

Source§

fn unmap(&self)

Source§

fn unparent(&self)

Source§

fn unrealize(&self)

Source§

fn unset_state_flags(&self, flags: StateFlags)

Source§

fn height_request(&self) -> i32

Source§

fn set_height_request(&self, height_request: i32)

Source§

fn width_request(&self) -> i32

Source§

fn set_width_request(&self, width_request: i32)

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

fn emit_move_focus(&self, direction: DirectionType)

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Available on crate feature v4_18 only.
Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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