gdk4/auto/

toplevel_layout.rs

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

use crate::{ffi, Monitor};
use glib::{prelude::*, translate::*};

glib::wrapper! {
    /// The [`ToplevelLayout`][crate::ToplevelLayout] struct contains information that
    /// is necessary to present a sovereign window on screen.
    ///
    /// The [`ToplevelLayout`][crate::ToplevelLayout] struct is necessary for using
    /// [`ToplevelExt::present()`][crate::prelude::ToplevelExt::present()].
    ///
    /// Toplevel surfaces are sovereign windows that can be presented
    /// to the user in various states (maximized, on all workspaces,
    /// etc).
    #[derive(Debug, PartialOrd, Ord, Hash)]
    pub struct ToplevelLayout(Shared<ffi::GdkToplevelLayout>);

    match fn {
        ref => |ptr| ffi::gdk_toplevel_layout_ref(ptr),
        unref => |ptr| ffi::gdk_toplevel_layout_unref(ptr),
        type_ => || ffi::gdk_toplevel_layout_get_type(),
    }
}

impl ToplevelLayout {
    /// Create a toplevel layout description.
    ///
    /// Used together with gdk_toplevel_present() to describe
    /// how a toplevel surface should be placed and behave on-screen.
    ///
    /// The size is in ”application pixels”, not
    /// ”device pixels” (see gdk_surface_get_scale_factor()).
    ///
    /// # Returns
    ///
    /// newly created instance of [`ToplevelLayout`][crate::ToplevelLayout]
    #[doc(alias = "gdk_toplevel_layout_new")]
    pub fn new() -> ToplevelLayout {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gdk_toplevel_layout_new()) }
    }

    #[doc(alias = "gdk_toplevel_layout_copy")]
    #[must_use]
    pub fn copy(&self) -> ToplevelLayout {
        unsafe { from_glib_full(ffi::gdk_toplevel_layout_copy(self.to_glib_none().0)) }
    }

    #[doc(alias = "gdk_toplevel_layout_equal")]
    fn equal(&self, other: &ToplevelLayout) -> bool {
        unsafe {
            from_glib(ffi::gdk_toplevel_layout_equal(
                self.to_glib_none().0,
                other.to_glib_none().0,
            ))
        }
    }

    /// If the layout specifies whether to the toplevel should go fullscreen,
    /// the value pointed to by @fullscreen is set to [`true`] if it should go
    /// fullscreen, or [`false`], if it should go unfullscreen.
    ///
    /// # Returns
    ///
    /// whether the @self specifies the fullscreen state for the toplevel
    ///
    /// ## `fullscreen`
    /// location to store whether the toplevel should be fullscreen
    #[doc(alias = "gdk_toplevel_layout_get_fullscreen")]
    #[doc(alias = "get_fullscreen")]
    pub fn fullscreen(&self) -> Option<bool> {
        unsafe {
            let mut fullscreen = std::mem::MaybeUninit::uninit();
            let ret = from_glib(ffi::gdk_toplevel_layout_get_fullscreen(
                self.to_glib_none().0,
                fullscreen.as_mut_ptr(),
            ));
            if ret {
                Some(from_glib(fullscreen.assume_init()))
            } else {
                None
            }
        }
    }

    /// Returns the monitor that the layout is fullscreening
    /// the surface on.
    ///
    /// # Returns
    ///
    /// the monitor on which @self fullscreens
    #[doc(alias = "gdk_toplevel_layout_get_fullscreen_monitor")]
    #[doc(alias = "get_fullscreen_monitor")]
    pub fn fullscreen_monitor(&self) -> Option<Monitor> {
        unsafe {
            from_glib_none(ffi::gdk_toplevel_layout_get_fullscreen_monitor(
                self.to_glib_none().0,
            ))
        }
    }

    /// If the layout specifies whether to the toplevel should go maximized,
    /// the value pointed to by @maximized is set to [`true`] if it should go
    /// fullscreen, or [`false`], if it should go unmaximized.
    ///
    /// # Returns
    ///
    /// whether the @self specifies the maximized state for the toplevel
    ///
    /// ## `maximized`
    /// set to [`true`] if the toplevel should be maximized
    #[doc(alias = "gdk_toplevel_layout_get_maximized")]
    #[doc(alias = "get_maximized")]
    pub fn maximized(&self) -> Option<bool> {
        unsafe {
            let mut maximized = std::mem::MaybeUninit::uninit();
            let ret = from_glib(ffi::gdk_toplevel_layout_get_maximized(
                self.to_glib_none().0,
                maximized.as_mut_ptr(),
            ));
            if ret {
                Some(from_glib(maximized.assume_init()))
            } else {
                None
            }
        }
    }

    /// Returns whether the layout should allow the user
    /// to resize the surface.
    ///
    /// # Returns
    ///
    /// [`true`] if the layout is resizable
    #[doc(alias = "gdk_toplevel_layout_get_resizable")]
    #[doc(alias = "get_resizable")]
    pub fn is_resizable(&self) -> bool {
        unsafe {
            from_glib(ffi::gdk_toplevel_layout_get_resizable(
                self.to_glib_none().0,
            ))
        }
    }

    /// Sets whether the layout should cause the surface
    /// to be fullscreen when presented.
    /// ## `fullscreen`
    /// [`true`] to fullscreen the surface
    /// ## `monitor`
    /// the monitor to fullscreen on
    #[doc(alias = "gdk_toplevel_layout_set_fullscreen")]
    pub fn set_fullscreen(&self, fullscreen: bool, monitor: Option<&impl IsA<Monitor>>) {
        unsafe {
            ffi::gdk_toplevel_layout_set_fullscreen(
                self.to_glib_none().0,
                fullscreen.into_glib(),
                monitor.map(|p| p.as_ref()).to_glib_none().0,
            );
        }
    }

    /// Sets whether the layout should cause the surface
    /// to be maximized when presented.
    /// ## `maximized`
    /// [`true`] to maximize
    #[doc(alias = "gdk_toplevel_layout_set_maximized")]
    pub fn set_maximized(&self, maximized: bool) {
        unsafe {
            ffi::gdk_toplevel_layout_set_maximized(self.to_glib_none().0, maximized.into_glib());
        }
    }

    /// Sets whether the layout should allow the user
    /// to resize the surface after it has been presented.
    /// ## `resizable`
    /// [`true`] to allow resizing
    #[doc(alias = "gdk_toplevel_layout_set_resizable")]
    pub fn set_resizable(&self, resizable: bool) {
        unsafe {
            ffi::gdk_toplevel_layout_set_resizable(self.to_glib_none().0, resizable.into_glib());
        }
    }
}

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

impl PartialEq for ToplevelLayout {
    #[inline]
    fn eq(&self, other: &Self) -> bool {
        self.equal(other)
    }
}

impl Eq for ToplevelLayout {}