Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | None |
Language | Haskell2010 |
GI.Gdk.Structs.ToplevelLayout
Description
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).
Synopsis
- newtype ToplevelLayout = ToplevelLayout (ManagedPtr ToplevelLayout)
- toplevelLayoutCopy :: (HasCallStack, MonadIO m) => ToplevelLayout -> m ToplevelLayout
- toplevelLayoutEqual :: (HasCallStack, MonadIO m) => ToplevelLayout -> ToplevelLayout -> m Bool
- toplevelLayoutGetFullscreen :: (HasCallStack, MonadIO m) => ToplevelLayout -> m (Bool, Bool)
- toplevelLayoutGetFullscreenMonitor :: (HasCallStack, MonadIO m) => ToplevelLayout -> m (Maybe Monitor)
- toplevelLayoutGetMaximized :: (HasCallStack, MonadIO m) => ToplevelLayout -> m (Bool, Bool)
- toplevelLayoutGetResizable :: (HasCallStack, MonadIO m) => ToplevelLayout -> m Bool
- toplevelLayoutNew :: (HasCallStack, MonadIO m) => m ToplevelLayout
- toplevelLayoutRef :: (HasCallStack, MonadIO m) => ToplevelLayout -> m ToplevelLayout
- toplevelLayoutSetFullscreen :: (HasCallStack, MonadIO m, IsMonitor a) => ToplevelLayout -> Bool -> Maybe a -> m ()
- toplevelLayoutSetMaximized :: (HasCallStack, MonadIO m) => ToplevelLayout -> Bool -> m ()
- toplevelLayoutSetResizable :: (HasCallStack, MonadIO m) => ToplevelLayout -> Bool -> m ()
- toplevelLayoutUnref :: (HasCallStack, MonadIO m) => ToplevelLayout -> m ()
Exported types
newtype ToplevelLayout Source #
Memory-managed wrapper type.
Constructors
ToplevelLayout (ManagedPtr ToplevelLayout) |
Instances
Eq ToplevelLayout Source # | |
Defined in GI.Gdk.Structs.ToplevelLayout Methods (==) :: ToplevelLayout -> ToplevelLayout -> Bool (/=) :: ToplevelLayout -> ToplevelLayout -> Bool | |
GBoxed ToplevelLayout Source # | |
Defined in GI.Gdk.Structs.ToplevelLayout | |
ManagedPtrNewtype ToplevelLayout Source # | |
Defined in GI.Gdk.Structs.ToplevelLayout Methods toManagedPtr :: ToplevelLayout -> ManagedPtr ToplevelLayout # | |
TypedObject ToplevelLayout Source # | |
Defined in GI.Gdk.Structs.ToplevelLayout | |
HasParentTypes ToplevelLayout Source # | |
Defined in GI.Gdk.Structs.ToplevelLayout | |
IsGValue (Maybe ToplevelLayout) Source # | Convert |
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 Source # | |
Defined in GI.Gdk.Structs.ToplevelLayout type ParentTypes ToplevelLayout = '[] :: [Type] |
Methods
Click to display all available methods, including inherited ones
copy
Arguments
:: (HasCallStack, MonadIO m) | |
=> ToplevelLayout |
|
-> m ToplevelLayout | Returns: a copy of |
Create a new GdkToplevelLayout
and copy the contents of layout
into it.
equal
Arguments
:: (HasCallStack, MonadIO m) | |
=> ToplevelLayout |
|
-> ToplevelLayout |
|
-> m Bool | Returns: true if |
Check whether layout
and other
has identical layout properties.
getFullscreen
toplevelLayoutGetFullscreen Source #
Arguments
:: (HasCallStack, MonadIO m) | |
=> ToplevelLayout |
|
-> m (Bool, Bool) | Returns: whether the |
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 Source #
Arguments
:: (HasCallStack, MonadIO m) | |
=> ToplevelLayout |
|
-> m (Maybe Monitor) | Returns: the monitor on which |
Returns the monitor that the layout is fullscreening the surface on.
getMaximized
toplevelLayoutGetMaximized Source #
Arguments
:: (HasCallStack, MonadIO m) | |
=> ToplevelLayout |
|
-> m (Bool, Bool) | Returns: whether the |
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
maximized, or false, if it should go unmaximized.
getResizable
toplevelLayoutGetResizable Source #
Arguments
:: (HasCallStack, MonadIO m) | |
=> ToplevelLayout |
|
-> m Bool | Returns: true if the layout is resizable |
Returns whether the layout should allow the user to resize the surface.
new
Arguments
:: (HasCallStack, MonadIO m) | |
=> m ToplevelLayout | Returns: newly created instance of |
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 surfaceGetScale
).
ref
Arguments
:: (HasCallStack, MonadIO m) | |
=> ToplevelLayout |
|
-> m ToplevelLayout | Returns: the same |
Increases the reference count of layout
.
setFullscreen
toplevelLayoutSetFullscreen Source #
Arguments
:: (HasCallStack, MonadIO m, IsMonitor a) | |
=> ToplevelLayout |
|
-> Bool |
|
-> Maybe a |
|
-> m () |
Sets whether the layout should cause the surface to be fullscreen when presented.
setMaximized
toplevelLayoutSetMaximized Source #
Arguments
:: (HasCallStack, MonadIO m) | |
=> ToplevelLayout |
|
-> Bool |
|
-> m () |
Sets whether the layout should cause the surface to be maximized when presented.
setResizable
toplevelLayoutSetResizable Source #
Arguments
:: (HasCallStack, MonadIO m) | |
=> ToplevelLayout |
|
-> Bool |
|
-> m () |
Sets whether the layout should allow the user to resize the surface after it has been presented.
unref
Arguments
:: (HasCallStack, MonadIO m) | |
=> ToplevelLayout |
|
-> m () |
Decreases the reference count of layout
.