1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files.git)
// DO NOT EDIT
use crate::Monitor;
use glib::object::IsA;
use glib::translate::*;
use std::mem;
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 [`ToplevelExt::present()`][crate::prelude::ToplevelExt::present()] to describe
/// how a toplevel surface should be placed and behave on-screen.
///
/// The size is in ”application pixels”, not
/// ”device pixels” (see [`SurfaceExt::scale_factor()`][crate::prelude::SurfaceExt::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()) }
}
/// Create a new [`ToplevelLayout`][crate::ToplevelLayout] and copy the contents of `self` into it.
///
/// # Returns
///
/// a copy of `self`.
#[doc(alias = "gdk_toplevel_layout_copy")]
pub fn copy(&self) -> Option<ToplevelLayout> {
unsafe { from_glib_full(ffi::gdk_toplevel_layout_copy(self.to_glib_none().0)) }
}
/// Check whether `self` and `other` has identical layout properties.
/// ## `other`
/// another [`ToplevelLayout`][crate::ToplevelLayout]
///
/// # Returns
///
/// [`true`] if `self` and `other` have identical layout properties,
/// otherwise [`false`].
#[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 = mem::MaybeUninit::uninit();
let ret = from_glib(ffi::gdk_toplevel_layout_get_fullscreen(
self.to_glib_none().0,
fullscreen.as_mut_ptr(),
));
let fullscreen = fullscreen.assume_init();
if ret {
Some(from_glib(fullscreen))
} 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 = mem::MaybeUninit::uninit();
let ret = from_glib(ffi::gdk_toplevel_layout_get_maximized(
self.to_glib_none().0,
maximized.as_mut_ptr(),
));
let maximized = maximized.assume_init();
if ret {
Some(from_glib(maximized))
} 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<P: IsA<Monitor>>(&self, fullscreen: bool, monitor: Option<&P>) {
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 {}