libappstream/auto/
screenshot.rs

Help
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from
// from gir-files (https://github.com/gtk-rs/gir-files.git)
// DO NOT EDIT

use crate::{ffi, Context, Image, ScreenshotKind, ScreenshotMediaKind, Video};
use glib::{prelude::*, translate::*};

glib::wrapper! {
    ///
    ///
    /// # Implements
    ///
    /// [`ScreenshotExt`][trait@crate::prelude::ScreenshotExt]
    #[doc(alias = "AsScreenshot")]
    pub struct Screenshot(Object<ffi::AsScreenshot, ffi::AsScreenshotClass>);

    match fn {
        type_ => || ffi::as_screenshot_get_type(),
    }
}

impl Screenshot {
    pub const NONE: Option<&'static Screenshot> = None;

    /// Creates a new [`Screenshot`][crate::Screenshot].
    ///
    /// # Returns
    ///
    /// a [`Screenshot`][crate::Screenshot]
    #[doc(alias = "as_screenshot_new")]
    pub fn new() -> Screenshot {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::as_screenshot_new()) }
    }
}

impl Default for Screenshot {
    fn default() -> Self {
        Self::new()
    }
}

mod sealed {
    pub trait Sealed {}
    impl<T: super::IsA<super::Screenshot>> Sealed for T {}
}

/// Trait containing all [`struct@Screenshot`] methods.
///
/// # Implementors
///
/// [`Screenshot`][struct@crate::Screenshot]
pub trait ScreenshotExt: IsA<Screenshot> + sealed::Sealed + 'static {
    /// Adds an image to the screenshot.
    /// ## `image`
    /// a [`Image`][crate::Image] instance.
    #[doc(alias = "as_screenshot_add_image")]
    fn add_image(&self, image: &impl IsA<Image>) {
        unsafe {
            ffi::as_screenshot_add_image(
                self.as_ref().to_glib_none().0,
                image.as_ref().to_glib_none().0,
            );
        }
    }

    /// Adds a video to the screenshot.
    /// ## `video`
    /// a [`Video`][crate::Video] instance.
    #[doc(alias = "as_screenshot_add_video")]
    fn add_video(&self, video: &impl IsA<Video>) {
        unsafe {
            ffi::as_screenshot_add_video(
                self.as_ref().to_glib_none().0,
                video.as_ref().to_glib_none().0,
            );
        }
    }

    /// Remove all images associated with this screenshot.
    #[doc(alias = "as_screenshot_clear_images")]
    fn clear_images(&self) {
        unsafe {
            ffi::as_screenshot_clear_images(self.as_ref().to_glib_none().0);
        }
    }

    /// Gets the image caption
    ///
    /// # Returns
    ///
    /// the caption
    #[doc(alias = "as_screenshot_get_caption")]
    #[doc(alias = "get_caption")]
    fn caption(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::as_screenshot_get_caption(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Returns the [`Context`][crate::Context] associated with this screenshot.
    /// This function may return [`None`] if no context is set.
    ///
    /// # Returns
    ///
    /// the [`Context`][crate::Context] used by this screenshot.
    #[doc(alias = "as_screenshot_get_context")]
    #[doc(alias = "get_context")]
    fn context(&self) -> Option<Context> {
        unsafe {
            from_glib_none(ffi::as_screenshot_get_context(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// 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.
    #[doc(alias = "as_screenshot_get_environment")]
    #[doc(alias = "get_environment")]
    fn environment(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::as_screenshot_get_environment(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Gets the AsImage closest to the target size. The [`Image`][crate::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.
    /// ## `width`
    /// target width
    /// ## `height`
    /// target height
    /// ## `scale`
    /// the target scaling factor.
    ///
    /// # Returns
    ///
    /// an [`Image`][crate::Image], or [`None`]
    #[doc(alias = "as_screenshot_get_image")]
    #[doc(alias = "get_image")]
    fn image(&self, width: u32, height: u32, scale: u32) -> Option<Image> {
        unsafe {
            from_glib_none(ffi::as_screenshot_get_image(
                self.as_ref().to_glib_none().0,
                width,
                height,
                scale,
            ))
        }
    }

    /// Gets the images for this screenshots. Only images valid for the current
    /// language are returned. We return all sizes.
    ///
    /// # Returns
    ///
    /// an array
    #[doc(alias = "as_screenshot_get_images")]
    #[doc(alias = "get_images")]
    fn images(&self) -> Vec<Image> {
        unsafe {
            FromGlibPtrContainer::from_glib_none(ffi::as_screenshot_get_images(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Returns an array of all images we have, regardless of their
    /// size and language.
    ///
    /// # Returns
    ///
    /// an array
    #[doc(alias = "as_screenshot_get_images_all")]
    #[doc(alias = "get_images_all")]
    fn images_all(&self) -> Vec<Image> {
        unsafe {
            FromGlibPtrContainer::from_glib_none(ffi::as_screenshot_get_images_all(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Gets the screenshot kind.
    ///
    /// # Returns
    ///
    /// a [`ScreenshotKind`][crate::ScreenshotKind]
    #[doc(alias = "as_screenshot_get_kind")]
    #[doc(alias = "get_kind")]
    fn kind(&self) -> ScreenshotKind {
        unsafe { from_glib(ffi::as_screenshot_get_kind(self.as_ref().to_glib_none().0)) }
    }

    /// Gets the screenshot media kind.
    ///
    /// # Returns
    ///
    /// a [`ScreenshotMediaKind`][crate::ScreenshotMediaKind]
    #[doc(alias = "as_screenshot_get_media_kind")]
    #[doc(alias = "get_media_kind")]
    fn media_kind(&self) -> ScreenshotMediaKind {
        unsafe {
            from_glib(ffi::as_screenshot_get_media_kind(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Gets the videos for this screenshots. Only videos valid for the current
    /// language selection are returned. We return all sizes.
    ///
    /// # Returns
    ///
    /// an array
    #[doc(alias = "as_screenshot_get_videos")]
    #[doc(alias = "get_videos")]
    fn videos(&self) -> Vec<Video> {
        unsafe {
            FromGlibPtrContainer::from_glib_none(ffi::as_screenshot_get_videos(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Returns an array of all screencast videos we have, regardless of their
    /// size and locale.
    ///
    /// # Returns
    ///
    /// an array
    #[doc(alias = "as_screenshot_get_videos_all")]
    #[doc(alias = "get_videos_all")]
    fn videos_all(&self) -> Vec<Video> {
        unsafe {
            FromGlibPtrContainer::from_glib_none(ffi::as_screenshot_get_videos_all(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Performs a quick validation on this screenshot
    ///
    /// # Returns
    ///
    /// TRUE if the screenshot is a complete [`Screenshot`][crate::Screenshot]
    #[doc(alias = "as_screenshot_is_valid")]
    fn is_valid(&self) -> bool {
        unsafe { from_glib(ffi::as_screenshot_is_valid(self.as_ref().to_glib_none().0)) }
    }

    /// Sets a caption on the screenshot
    /// ## `caption`
    /// the caption text.
    #[doc(alias = "as_screenshot_set_caption")]
    fn set_caption(&self, caption: &str, locale: &str) {
        unsafe {
            ffi::as_screenshot_set_caption(
                self.as_ref().to_glib_none().0,
                caption.to_glib_none().0,
                locale.to_glib_none().0,
            );
        }
    }

    /// Sets the document context this screenshot is associated
    /// with.
    /// ## `context`
    /// the [`Context`][crate::Context].
    #[doc(alias = "as_screenshot_set_context")]
    fn set_context(&self, context: &impl IsA<Context>) {
        unsafe {
            ffi::as_screenshot_set_context(
                self.as_ref().to_glib_none().0,
                context.as_ref().to_glib_none().0,
            );
        }
    }

    /// Sets the GUI environment ID of this screenshot.
    /// ## `env_id`
    /// the GUI environment ID, e.g. "plasma-mobile" or "gnome:dark"
    #[doc(alias = "as_screenshot_set_environment")]
    fn set_environment(&self, env_id: Option<&str>) {
        unsafe {
            ffi::as_screenshot_set_environment(
                self.as_ref().to_glib_none().0,
                env_id.to_glib_none().0,
            );
        }
    }

    /// Sets the screenshot kind.
    /// ## `kind`
    /// the [`ScreenshotKind`][crate::ScreenshotKind].
    #[doc(alias = "as_screenshot_set_kind")]
    fn set_kind(&self, kind: ScreenshotKind) {
        unsafe {
            ffi::as_screenshot_set_kind(self.as_ref().to_glib_none().0, kind.into_glib());
        }
    }
}

impl<O: IsA<Screenshot>> ScreenshotExt for O {}
libappstream/auto/screenshot.rs

libappstream/auto/
screenshot.rs
