Trait ScreenshotExt

Help

pub trait ScreenshotExt:
    IsA<Screenshot>
    + Sealed
    + 'static {
Show 18 methods    // Provided methods
    fn add_image(&self, image: &impl IsA<Image>) { ... }
    fn add_video(&self, video: &impl IsA<Video>) { ... }
    fn clear_images(&self) { ... }
    fn caption(&self) -> Option<GString> { ... }
    fn context(&self) -> Option<Context> { ... }
    fn environment(&self) -> Option<GString> { ... }
    fn image(&self, width: u32, height: u32, scale: u32) -> Option<Image> { ... }
    fn images(&self) -> Vec<Image> { ... }
    fn images_all(&self) -> Vec<Image> { ... }
    fn kind(&self) -> ScreenshotKind { ... }
    fn media_kind(&self) -> ScreenshotMediaKind { ... }
    fn videos(&self) -> Vec<Video> { ... }
    fn videos_all(&self) -> Vec<Video> { ... }
    fn is_valid(&self) -> bool { ... }
    fn set_caption(&self, caption: &str, locale: &str) { ... }
    fn set_context(&self, context: &impl IsA<Context>) { ... }
    fn set_environment(&self, env_id: Option<&str>) { ... }
    fn set_kind(&self, kind: ScreenshotKind) { ... }
}

Expand description

Trait containing all Screenshot methods.

§Implementors

Screenshot

Provided Methods§

source

fn add_image(&self, image: &impl IsA<Image>)

Adds an image to the screenshot.

§`image`

a Image instance.

source

fn add_video(&self, video: &impl IsA<Video>)

Adds a video to the screenshot.

§`video`

a Video instance.

source

fn clear_images(&self)

Remove all images associated with this screenshot.

source

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

Gets the image caption

§Returns

the caption

source

fn context(&self) -> Option<Context>

Returns the Context associated with this screenshot. This function may return None if no context is set.

§Returns

the Context used by this screenshot.

source

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

Get the GUI environment ID of this screenshot, if any is associated with it. E.g. “plasma-mobile” or “gnome:dark”.

§Returns

The GUI environment ID the screenshot was recorded in, or None if none set.

source

fn image(&self, width: u32, height: u32, scale: u32) -> Option<Image>

Gets the AsImage closest to the target size. The Image may not actually be the requested size, and the application may have to pad / rescale the image to make it fit. Only images for the current active locale (or fallback, if images are not localized) are considered.