GI.Gdk.Structs.ToplevelLayout

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

The GdkToplevelLayout struct is necessary for using toplevelPresent.

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

Exported types

newtype ToplevelLayout

Memory-managed wrapper type.

Constructors

ToplevelLayout (ManagedPtr ToplevelLayout)

Instances

Eq ToplevelLayout

Defined in GI.Gdk.Structs.ToplevelLayout

Methods

(==) :: ToplevelLayout -> ToplevelLayout -> Bool

(/=) :: ToplevelLayout -> ToplevelLayout -> Bool

GBoxed ToplevelLayout

Defined in GI.Gdk.Structs.ToplevelLayout

ManagedPtrNewtype ToplevelLayout

Defined in GI.Gdk.Structs.ToplevelLayout

Methods

toManagedPtr :: ToplevelLayout -> ManagedPtr ToplevelLayout

TypedObject ToplevelLayout

Defined in GI.Gdk.Structs.ToplevelLayout

Methods

glibType :: IO GType

HasParentTypes ToplevelLayout

Defined in GI.Gdk.Structs.ToplevelLayout

IsGValue (Maybe ToplevelLayout)

Convert ToplevelLayout to and from GValue. See toGValue and fromGValue.

Defined in GI.Gdk.Structs.ToplevelLayout

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe ToplevelLayout -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe ToplevelLayout)

type ParentTypes ToplevelLayout

Defined in GI.Gdk.Structs.ToplevelLayout

type ParentTypes ToplevelLayout = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Methods

copy, equal, ref, unref.

Getters

getFullscreen, getFullscreenMonitor, getMaximized, getResizable.

Setters

setFullscreen, setMaximized, setResizable.

copy

toplevelLayoutCopy

Arguments

:: (HasCallStack, MonadIO m)

=> ToplevelLayout

layout: a GdkToplevelLayout

-> m ToplevelLayout

Returns: a copy of layout.

Create a new GdkToplevelLayout and copy the contents of layout into it.

equal

toplevelLayoutEqual

Arguments

:: (HasCallStack, MonadIO m)

=> ToplevelLayout

layout: a GdkToplevelLayout

-> ToplevelLayout

other: another GdkToplevelLayout

-> m Bool

Returns: True if layout and other have identical layout properties, otherwise False.

Check whether layout and other has identical layout properties.

getFullscreen

toplevelLayoutGetFullscreen

Arguments

:: (HasCallStack, MonadIO m)

=> ToplevelLayout

layout: a `GdkToplevelLayout

-> m (Bool, Bool)

Returns: whether the layout specifies the fullscreen state for the toplevel

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.

getFullscreenMonitor

toplevelLayoutGetFullscreenMonitor

Arguments

:: (HasCallStack, MonadIO m)

=> ToplevelLayout

layout: a GdkToplevelLayout

-> m (Maybe Monitor)

Returns: the monitor on which layout fullscreens

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

getMaximized

toplevelLayoutGetMaximized

Arguments

:: (HasCallStack, MonadIO m)

=> ToplevelLayout

layout: a GdkToplevelLayout

-> m (Bool, Bool)

Returns: whether the layout specifies the maximized state for the toplevel

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.

getResizable

toplevelLayoutGetResizable

Arguments

:: (HasCallStack, MonadIO m)

=> ToplevelLayout

layout: a GdkToplevelLayout

-> m Bool

Returns: True if the layout is resizable

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

new

toplevelLayoutNew

Arguments

:: (HasCallStack, MonadIO m)

=> m ToplevelLayout

Returns: newly created instance of GdkToplevelLayout

Create a toplevel layout description.

Used together with toplevelPresent to describe how a toplevel surface should be placed and behave on-screen.

The size is in ”application pixels”, not ”device pixels” (see surfaceGetScaleFactor).

ref

toplevelLayoutRef

Arguments

:: (HasCallStack, MonadIO m)

=> ToplevelLayout

layout: a GdkToplevelLayout

-> m ToplevelLayout

Returns: the same layout

Increases the reference count of layout.

setFullscreen

toplevelLayoutSetFullscreen

Arguments

:: (HasCallStack, MonadIO m, IsMonitor a)

=> ToplevelLayout

layout: a GdkToplevelLayout

-> Bool

fullscreen: True to fullscreen the surface

-> Maybe a

monitor: the monitor to fullscreen on

-> m ()

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

setMaximized

toplevelLayoutSetMaximized

Arguments

:: (HasCallStack, MonadIO m)

=> ToplevelLayout

layout: a GdkToplevelLayout

-> Bool

maximized: True to maximize

-> m ()

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

setResizable

toplevelLayoutSetResizable

Arguments

:: (HasCallStack, MonadIO m)

=> ToplevelLayout

layout: a GdkToplevelLayout

-> Bool

resizable: True to allow resizing

-> m ()

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

unref

toplevelLayoutUnref

Arguments

:: (HasCallStack, MonadIO m)

=> ToplevelLayout

layout: a GdkToplevelLayout

-> m ()

Decreases the reference count of layout.