Struct RoomHistory

pub struct RoomHistory {

    sender_menu_model: TemplateChild<Menu>,
    pub(super) header_bar: TemplateChild<HeaderBar>,
    room_menu: TemplateChild<MenuButton>,
    listview: TemplateChild<ListView>,
    content: TemplateChild<Widget>,
    scrolled_window: TemplateChild<ScrolledWindow>,
    scroll_btn: TemplateChild<Button>,
    scroll_btn_revealer: TemplateChild<Revealer>,
    pub(super) message_toolbar: TemplateChild<MessageToolbar>,
    loading: TemplateChild<Spinner>,
    error: TemplateChild<StatusPage>,
    stack: TemplateChild<Stack>,
    tombstoned_banner: TemplateChild<Banner>,
    drag_overlay: TemplateChild<DragOverlay>,
    item_context_menu: OnceCell<ItemRowContextMenu>,
    sender_context_menu: OnceCell<PopoverMenu>,
    room: BoundObject<Room>,
    is_only_view: Cell<bool>,
    is_empty: PhantomData<bool>,
    room_members: RefCell<Option<MemberList>>,
    timeline_handlers: RefCell<Vec<SignalHandlerId>>,
    is_auto_scrolling: Cell<bool>,
    is_sticky: Cell<bool>,
    selection_model: OnceCell<NoSelection>,
    scroll_timeout: RefCell<Option<SourceId>>,
    read_timeout: RefCell<Option<SourceId>>,
    can_invite_handler: RefCell<Option<SignalHandlerId>>,
    membership_handler: RefCell<Option<SignalHandlerId>>,
    join_rule_handler: RefCell<Option<SignalHandlerId>>,
}

Fields

sender_menu_model: TemplateChild<Menu>

header_bar: TemplateChild<HeaderBar>

room_menu: TemplateChild<MenuButton>

listview: TemplateChild<ListView>

content: TemplateChild<Widget>

scrolled_window: TemplateChild<ScrolledWindow>

scroll_btn: TemplateChild<Button>

scroll_btn_revealer: TemplateChild<Revealer>

message_toolbar: TemplateChild<MessageToolbar>

loading: TemplateChild<Spinner>

error: TemplateChild<StatusPage>

stack: TemplateChild<Stack>

tombstoned_banner: TemplateChild<Banner>

drag_overlay: TemplateChild<DragOverlay>

item_context_menu: OnceCell<ItemRowContextMenu>

sender_context_menu: OnceCell<PopoverMenu>

room: BoundObject<Room>

The room currently displayed.

is_only_view: Cell<bool>

Whether this is the only view visible, i.e. there is no sidebar.

is_empty: PhantomData<bool>

Whether this RoomHistory is empty, aka no room is currently displayed.

room_members: RefCell<Option<MemberList>>

The members of the current room.

We hold a strong reference here to keep the list in memory as long as the room is opened.

timeline_handlers: RefCell<Vec<SignalHandlerId>>

is_auto_scrolling: Cell<bool>

Whether the current room history scrolling is automatic.

is_sticky: Cell<bool>

Whether the room history should stick to the newest message in the timeline.

selection_model: OnceCell<NoSelection>

The GtkSelectionModel used in the list view.

scroll_timeout: RefCell<Option<SourceId>>

read_timeout: RefCell<Option<SourceId>>

can_invite_handler: RefCell<Option<SignalHandlerId>>

membership_handler: RefCell<Option<SignalHandlerId>>

join_rule_handler: RefCell<Option<SignalHandlerId>>

Implementations

impl RoomHistory

fn register_type()

Registers the type only once.

impl RoomHistory

pub fn downgrade(&self) -> <Self as Downgrade>::Weak

impl RoomHistory

fn init_listview(&self)

Initialize the list view.

fn init_drop_target(&self)

Initialize the drop target.

fn disconnect_all(&self)

Disconnect all the signals.

fn set_room(&self, room: Option<Room>)

Set the room currently displayed.

fn selection_model(&self) -> &NoSelection

The GtkSelectionModel used in the list view.

fn is_empty(&self) -> bool

Whether this RoomHistory is empty, aka no room is currently displayed.

fn scroll_value_changed(&self)

Handle when the scroll value changed.

fn scroll_max_value_changed(&self)

Handle when the maximum scroll value changed.

pub(super) fn set_sticky(&self, is_sticky: bool)

Set whether the room history should stick to the newest message in the timeline.

fn set_is_auto_scrolling(&self, is_auto: bool)

Set whether the current room history scrolling is automatic.

fn scroll_down(&self)

Scroll to the bottom of the timeline.

pub(super) fn is_at_bottom(&self) -> bool

Whether the list view is scrolled at the bottom.

fn update_scroll_btn(&self)

Update the visibility of the scroll button.

fn update_room_menu(&self)

Update the room menu for the current state.

fn update_view(&self)

Update the view for the current state.

fn needs_more_events(&self) -> bool

Whether we need to load more events.

fn load_more_events_if_needed(&self)

Load more events at the beginning of the history if needed.

fn load_more_events(&self)

Load more events at the beginning of the history.

fn scroll_to_event(&self, key: &TimelineEventItemId)

Scroll to the event with the given identifier.

fn trigger_read_receipts_update(&self)

Trigger the process to update read receipts.

fn update_read_receipts(&self)

Update the read receipts.

fn update_read_marker(&self)

Update the read marker.

fn receipt_position(&self) -> Option<ReceiptPosition>

The position where a receipt should point to.

fn last_visible_event_id(&self) -> Option<OwnedEventId>

Get the ID of the last visible event in the room history.

fn update_tombstoned_banner(&self)

Update the tombstoned banner according to the state of the current room.

async fn leave(&self)

Leave the room.

async fn join(&self)

Join the room.

async fn forget(&self)

Forget the room.

fn update_invite_action(&self)

async fn join_or_view_successor(&self)

Join or view the successor of the room, if possible.

pub(super) fn item_context_menu(&self) -> &ItemRowContextMenu

The context menu for the item rows.

pub(super) fn sender_context_menu(&self) -> &PopoverMenu

The context menu for the sender avatars.

Trait Implementations

impl CompositeTemplate for RoomHistory

fn bind_template(klass: &mut Self::Class)

fn check_template_children(widget: &<Self as ObjectSubclass>::Type)

impl CompositeTemplateCallbacks for RoomHistory

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 RoomHistory

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

Formats the value using the given formatter.

impl Default for RoomHistory

fn default() -> RoomHistory

Returns the “default value” for a type.

impl DerivedObjectProperties for RoomHistory

fn derived_properties() -> &'static [ParamSpec]

Properties installed for this type.

fn derived_property(&self, id: usize, pspec: &ParamSpec) -> Value

Similar to ObjectImpl but auto-generated by the Properties macro to allow handling more complex use-cases.

fn derived_set_property(&self, id: usize, value: &Value, pspec: &ParamSpec)

Similar to ObjectImpl but auto-generated by the Properties macro to allow handling more complex use-cases.

impl ObjectImpl for RoomHistory

fn constructed(&self)

Constructed.

fn dispose(&self)

Disposes of the object.

fn properties() -> &'static [ParamSpec]

Properties installed for this type.

fn set_property(&self, id: usize, value: &Value, pspec: &ParamSpec)

Property setter.

fn property(&self, id: usize, pspec: &ParamSpec) -> Value

Property getter.

fn signals() -> &'static [Signal]

Signals installed for this type.

fn notify(&self, pspec: &ParamSpec)

Function to be called when property change is notified for with self.notify("property").

fn dispatch_properties_changed(&self, pspecs: &[ParamSpec])

impl ObjectSubclass for RoomHistory

const NAME: &'static str = "ContentRoomHistory"

GObject type name.

type Interfaces = ()

List of interfaces implemented by this type.

type Class = ClassStruct<RoomHistory>

The C class struct.

type Instance = InstanceStruct<RoomHistory>

The C instance struct.

type Type = RoomHistory

Wrapper around this subclass defined with wrapper!

type ParentType = Bin

Parent Rust type to inherit from.

fn new() -> Self

Constructor.

fn class_init(klass: &mut Self::Class)

Class initialization.

fn instance_init(obj: &InitializingObject<Self>)

Performs additional instance initialization.

const ABSTRACT: bool = false

If this subclass is an abstract class or not.

const ALLOW_NAME_CONFLICT: bool = false

Allow name conflicts for this class.

fn type_init(_type_: &mut InitializingType<Self>)

Additional type initialization.

fn with_class(_klass: &Self::Class) -> Self

Constructor.

impl ObjectSubclassType for RoomHistory

fn type_data() -> NonNull<TypeData>

Storage for the type-specific data used during registration.

fn type_() -> Type

Returns the glib::Type ID of the subclass.

impl WidgetImpl for RoomHistory

fn compute_expand(&self, hexpand: &mut bool, vexpand: &mut bool)

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

fn direction_changed(&self, previous_direction: TextDirection)

fn focus(&self, direction_type: DirectionType) -> bool

fn request_mode(&self) -> SizeRequestMode

fn grab_focus(&self) -> bool

fn hide(&self)

👎Deprecated: Since 4.10

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

fn map(&self)

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

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

fn move_focus(&self, direction_type: DirectionType)

fn query_tooltip( &self, x: i32, y: i32, keyboard_tooltip: bool, tooltip: &Tooltip, ) -> bool

fn realize(&self)

fn root(&self)

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

fn show(&self)

👎Deprecated: Since 4.10

fn size_allocate(&self, width: i32, height: i32, baseline: i32)

fn snapshot(&self, snapshot: &Snapshot)

fn state_flags_changed(&self, state_flags: &StateFlags)

fn system_setting_changed(&self, settings: &SystemSetting)

fn unmap(&self)

fn unrealize(&self)

fn unroot(&self)

impl BinImpl for RoomHistory