Struct MediaViewer

pub struct MediaViewer {

    toolbar_view: TemplateChild<ToolbarView>,
    header_bar: TemplateChild<HeaderBar>,
    menu: TemplateChild<MenuButton>,
    revealer: TemplateChild<ScaleRevealer>,
    media: TemplateChild<MediaContentViewer>,
    fullscreened: Cell<bool>,
    room: WeakRef<Room>,
    event_id: RefCell<Option<OwnedEventId>>,
    message: RefCell<Option<VisualMediaMessage>>,
    filename: RefCell<Option<String>>,
    animation: OnceCell<TimedAnimation>,
    swipe_tracker: OnceCell<SwipeTracker>,
    swipe_progress: Cell<f64>,
    actions_expression_watches: RefCell<HashMap<&'static str, ExpressionWatch>>,
}

Fields

toolbar_view: TemplateChild<ToolbarView>

header_bar: TemplateChild<HeaderBar>

menu: TemplateChild<MenuButton>

revealer: TemplateChild<ScaleRevealer>

media: TemplateChild<MediaContentViewer>

fullscreened: Cell<bool>

Whether the viewer is fullscreened.

room: WeakRef<Room>

The room containing the media message.

event_id: RefCell<Option<OwnedEventId>>

The ID of the event containing the media message.

message: RefCell<Option<VisualMediaMessage>>

The media message to display.

filename: RefCell<Option<String>>

The filename of the media.

animation: OnceCell<TimedAnimation>

The API to keep track of the animation to fade the background.

swipe_tracker: OnceCell<SwipeTracker>

swipe_progress: Cell<f64>

actions_expression_watches: RefCell<HashMap<&'static str, ExpressionWatch>>

Implementations

impl MediaViewer

fn register_type()

Registers the type only once.

impl MediaViewer

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

impl MediaViewer

fn set_fullscreened(&self, fullscreened: bool)

Set whether the viewer is fullscreened.

pub(super) fn set_message( &self, room: &Room, event_id: OwnedEventId, message: VisualMediaMessage, )

Set the media message to display.

fn set_filename(&self, filename: String)

Set the filename of the media.

fn animation(&self) -> &TimedAnimation

The API to keep track of the animation to fade the background.

fn init_swipe_tracker(&self)

Initialize the swipe tracker.

fn update_menu_actions(&self)

Update the actions of the menu according to the current message.

async fn build(&self)

Build the content of this viewer.

fn close(&self)

Close the viewer.

pub(super) fn reveal(&self, source_widget: &Widget)

Reveal this widget by transitioning from source_widget.

fn reveal_headerbar(&self, reveal: bool)

Reveal or hide the headerbar.

fn toggle_headerbar(&self)

Toggle whether the header bar is revealed.

fn handle_motion(&self, _x: f64, y: f64)

Handle when motion was detected in the viewer.

fn handle_click(&self, n_pressed: i32)

Handle a click in the viewer.

fn copy_image(&self)

Copy the current image to the clipboard.

async fn save_file(&self)

Save the current file to the clipboard.

async fn copy_permalink(&self)

Copy the permalink of the event of the media message to the clipboard.

Trait Implementations

impl CompositeTemplate for MediaViewer

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

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

impl CompositeTemplateCallbacks for MediaViewer

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 MediaViewer

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

Formats the value using the given formatter.

impl Default for MediaViewer

fn default() -> MediaViewer

Returns the “default value” for a type.

impl DerivedObjectProperties for MediaViewer

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 MediaViewer

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 MediaViewer

const NAME: &'static str = "MediaViewer"

GObject type name.

type Class = ClassStruct<MediaViewer>

The C class struct.

type Instance = InstanceStruct<MediaViewer>

The C instance struct.

type Type = MediaViewer

Wrapper around this subclass defined with wrapper!

type ParentType = Widget

Parent Rust type to inherit from.

type Interfaces = (Swipeable,)

List of interfaces implemented by this type.

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 MediaViewer

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 SwipeableImpl for MediaViewer

fn cancel_progress(&self) -> f64

fn distance(&self) -> f64

fn progress(&self) -> f64

fn snap_points(&self) -> Vec<f64>

fn swipe_area(&self, _: NavigationDirection, _: bool) -> Rectangle

impl WidgetImpl for MediaViewer

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

fn snapshot(&self, snapshot: &Snapshot)

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 state_flags_changed(&self, state_flags: &StateFlags)

fn system_setting_changed(&self, settings: &SystemSetting)

fn unmap(&self)

fn unrealize(&self)

fn unroot(&self)