Struct gdk4::ToplevelLayout

pub struct ToplevelLayout(_);

The ToplevelLayout struct contains information that is necessary to present a sovereign window on screen.

The ToplevelLayout struct is necessary for using ToplevelExt::present().

Toplevel surfaces are sovereign windows that can be presented to the user in various states (maximized, on all workspaces, etc).

Implementations

impl ToplevelLayout

pub fn new() -> ToplevelLayout

Create a toplevel layout description.

Used together with 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()).

Returns

newly created instance of ToplevelLayout

pub fn copy(&self) -> Option<ToplevelLayout>

Create a new ToplevelLayout and copy the contents of self into it.

Returns

a copy of self.

pub fn fullscreen(&self) -> Option<bool>

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

pub fn fullscreen_monitor(&self) -> Option<Monitor>

Returns the monitor that the layout is fullscreening the surface on.

Returns

the monitor on which self fullscreens

pub fn maximized(&self) -> Option<bool>

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

pub fn is_resizable(&self) -> bool

Returns whether the layout should allow the user to resize the surface.

Returns

true if the layout is resizable

pub fn set_fullscreen<P: IsA<Monitor>>(
    &self,
    fullscreen: bool,
    monitor: Option<&P>
)

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

pub fn set_maximized(&self, maximized: bool)

Sets whether the layout should cause the surface to be maximized when presented.

maximized

true to maximize

pub fn set_resizable(&self, resizable: bool)

Sets whether the layout should allow the user to resize the surface after it has been presented.

resizable

true to allow resizing

Trait Implementations

impl Clone for ToplevelLayout

fn clone(&self) -> ToplevelLayout

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ToplevelLayout

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

Formats the value using the given formatter.

impl Default for ToplevelLayout

fn default() -> Self

Returns the “default value” for a type.

impl Hash for ToplevelLayout

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for ToplevelLayout

fn cmp(&self, other: &ToplevelLayout) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<ToplevelLayout> for ToplevelLayout

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<ToplevelLayout> for ToplevelLayout

fn partial_cmp(&self, other: &ToplevelLayout) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for ToplevelLayout

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ToplevelLayout