Struct Sidebar 

#[repr(transparent)]
pub struct Sidebar {
    inner: TypedObjectRef<Sidebar, <Sidebar as ObjectSubclass>::ParentType>,
    phantom: PhantomData<()>,
}

The sidebar of the session view, displaying the list of rooms available for the current session, among other things.

GLib type: GObject with reference counted clone semantics.

Fields

inner: TypedObjectRef<Sidebar, <Sidebar as ObjectSubclass>::ParentType>

phantom: PhantomData<()>

Implementations

impl Sidebar

pub fn user(&self) -> <RefCell<Option<User>> as Property>::Value

The logged-in user.

pub fn set_user<'a>( &self, value: Option<impl Borrow<<<RefCell<Option<User>> as Property>::Value as HasParamSpec>::SetValue>>, )

The logged-in user.

pub fn list_model(&self) -> <WeakRef<SidebarListModel> as Property>::Value

The list model of this sidebar.

pub fn set_list_model<'a>( &self, value: Option<impl Borrow<<<WeakRef<SidebarListModel> as Property>::Value as HasParamSpec>::SetValue>>, )

The list model of this sidebar.

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

Listen for notifications of a change in the user property

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

Listen for notifications of a change in the list-model property

pub fn notify_user(&self)

Notify listeners of a change in the user property

pub fn notify_list_model(&self)

Notify listeners of a change in the list-model property

impl Sidebar

pub fn new() -> Self

pub(crate) fn room_search_bar(&self) -> SearchBar

The search bar allowing to filter rooms in the sidebar.

fn drop_source_category(&self) -> Option<RoomCategory>

The category of the source that activated drop mode.

fn set_drop_source_category(&self, source_category: Option<RoomCategory>)

Set the category of the source that activated drop mode.

fn drop_active_target_category(&self) -> Option<TargetRoomCategory>

The category of the drop target that is currently hovered.

fn set_drop_active_target_category( &self, target_category: Option<TargetRoomCategory>, )

Set the category of the drop target that is currently hovered.

fn room_row_popover(&self) -> &PopoverMenu

The shared popover for a room row in the sidebar.

pub(crate) fn header_bar(&self) -> &HeaderBar

The AdwHeaderBar of the sidebar.

pub(crate) fn scroll_to_selection(&self)

Scroll to the currently selected item of the sidebar.

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

Connect to the signal emitted when the drop source category changed.

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

Connect to the signal emitted when the drop active target category changed.

Trait Implementations

impl Clone for Sidebar

fn clone(&self) -> Self

Makes a clone of this shared reference.

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

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

Performs copy-assignment from source.

impl CompositeTemplateCallbacks for Sidebar

const CALLBACKS: &'static [TemplateCallback]

fn bind_template_callbacks<T>(klass: &mut T)

where T: WidgetClassExt,

Binds the template callbacks from this type into the default template scope for klass.

fn bind_template_callbacks_prefixed<T>(klass: &mut T, prefix: &str)

where T: WidgetClassExt,

Binds the template callbacks from this type into the default template scope for klass, prepending prefix to each callback name.

fn add_callbacks_to_scope(scope: &BuilderRustScope)

Binds the template callbacks from this type into scope.

fn add_callbacks_to_scope_prefixed(scope: &BuilderRustScope, prefix: &str)

Binds the template callbacks from this type into scope, prepending prefix to each callback name.

impl Debug for Sidebar

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

Formats the value using the given formatter.

impl HasParamSpec for Sidebar

type ParamSpec = ParamSpecObject

type SetValue = Sidebar

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Sidebar

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

where H: Hasher,

Hashes the memory address of this object.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl ObjectSubclassIs for Sidebar

type Subclass = Sidebar

impl Ord for Sidebar

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for Sidebar

type Parent = Widget

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

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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

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

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

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

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

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

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

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

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

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

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

impl StaticType for Sidebar

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Sidebar

impl IsA<Accessible> for Sidebar

impl IsA<Buildable> for Sidebar

impl IsA<ConstraintTarget> for Sidebar

impl IsA<NavigationPage> for Sidebar

impl IsA<Widget> for Sidebar