Struct MessageVisualMedia

pub struct MessageVisualMedia {
    overlay: TemplateChild<Overlay>,
    stack: TemplateChild<Stack>,
    spinner: TemplateChild<Spinner>,
    error: TemplateChild<Image>,
    dimensions: Cell<Option<FrameDimensions>>,
    state: Cell<LoadingState>,
    compact: Cell<bool>,
    activatable: Cell<bool>,
    gesture_click: WeakRef<GestureClick>,
    cache_key: RefCell<MessageCacheKey>,
    file: RefCell<Option<File>>,
    paintable_animation_ref: RefCell<Option<CountedRef>>,
}

Fields

overlay: TemplateChild<Overlay>

stack: TemplateChild<Stack>

spinner: TemplateChild<Spinner>

error: TemplateChild<Image>

dimensions: Cell<Option<FrameDimensions>>

The supposed dimensions of the media.

state: Cell<LoadingState>

The loading state of the media.

compact: Cell<bool>

Whether to display this media in a compact format.

activatable: Cell<bool>

Whether the media can be activated.

If the media is activatable and it is not using the compact format, clicking on the media opens the media viewer.

gesture_click: WeakRef<GestureClick>

cache_key: RefCell<MessageCacheKey>

The cache key for the current media message.

We only try to reload the media if the key changes. This is to avoid reloading the media when a local echo changes to a remote echo.

file: RefCell<Option<File>>

The current video file, if any.

paintable_animation_ref: RefCell<Option<CountedRef>>

Implementations

impl MessageVisualMedia

fn register_type()

Registers the type only once.

impl MessageVisualMedia

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

impl MessageVisualMedia

pub(super) fn media_child<T: IsA<Widget>>(&self) -> Option<T>

The media child of the given type, if any.

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

Set the media child.

Removes the previous media child if one was set.

fn set_state(&self, state: LoadingState)

Set the state of the media.

fn update_animated_paintable_state(&self)

Update the state of the animated paintable, if any.

fn set_compact(&self, compact: bool)

Set whether to display this media in a compact format.

fn set_activatable(&self, activatable: bool)

Set whether the media can be activated.

fn update_gesture_click(&self)

Add or remove the click controller given the current state.

fn set_cache_key(&self, key: MessageCacheKey) -> bool

Set the cache key with the given value.

Returns true if the media should be reloaded.

pub(super) fn build( &self, media_message: VisualMediaMessage, session: &Session, format: ContentFormat, cache_key: MessageCacheKey, )

Build the content for the given media message.

async fn build_image(&self, media_message: &VisualMediaMessage, client: Client)

Build the content for the image in the given media message.

fn enable_copy_image_action(&self, enable: bool)

Enable or disable the context menu action to copy the image.

async fn build_video(&self, media_message: VisualMediaMessage, client: &Client)

Build the content for the video in the given media message.

fn set_error(&self, message: &str)

Set the given error message for this media.

fn video_state_changed(&self, player: &VideoPlayer)

Handle when the state of the video changed.

Trait Implementations

impl CompositeTemplate for MessageVisualMedia

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

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

impl Debug for MessageVisualMedia

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

Formats the value using the given formatter.

impl Default for MessageVisualMedia

fn default() -> MessageVisualMedia

Returns the “default value” for a type.

impl DerivedObjectProperties for MessageVisualMedia

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 MessageVisualMedia

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 constructed(&self)

Constructed.

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 MessageVisualMedia

const NAME: &'static str = "ContentMessageVisualMedia"

GObject type name.

type Interfaces = ()

List of interfaces implemented by this type.

type Class = ClassStruct<MessageVisualMedia>

The C class struct.

type Instance = InstanceStruct<MessageVisualMedia>

The C instance struct.

type Type = MessageVisualMedia

Wrapper around this subclass defined with wrapper!

type ParentType = Widget

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 MessageVisualMedia

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 MessageVisualMedia

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

fn request_mode(&self) -> SizeRequestMode

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

fn map(&self)

fn unmap(&self)

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 grab_focus(&self) -> bool

fn hide(&self)

👎Deprecated: Since 4.10

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

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 snapshot(&self, snapshot: &Snapshot)

fn state_flags_changed(&self, state_flags: &StateFlags)

fn system_setting_changed(&self, settings: &SystemSetting)

fn unrealize(&self)

fn unroot(&self)