Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | None |
Language | Haskell2010 |
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).
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.
Instances
Eq ToplevelLayout Source # | |
Defined in GI.Gdk.Structs.ToplevelLayout (==) :: ToplevelLayout -> ToplevelLayout -> Bool # (/=) :: ToplevelLayout -> ToplevelLayout -> Bool # | |
GBoxed ToplevelLayout Source # | |
Defined in GI.Gdk.Structs.ToplevelLayout | |
ManagedPtrNewtype ToplevelLayout Source # | |
Defined in GI.Gdk.Structs.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 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 |
Methods
Click to display all available methods, including inherited ones
copy
:: (HasCallStack, MonadIO m) | |
=> ToplevelLayout |
|
-> m ToplevelLayout | Returns: a copy of |
Create a new GdkToplevelLayout
and copy the contents of layout
into it.
equal
:: (HasCallStack, MonadIO m) | |
=> ToplevelLayout |
|
-> ToplevelLayout |
|
-> m Bool | Returns: |
Check whether layout
and other
has identical layout properties.
getFullscreen
toplevelLayoutGetFullscreen Source #
:: (HasCallStack, MonadIO m) | |
=> ToplevelLayout |
|
-> m (Bool, Bool) | Returns: whether the |
getFullscreenMonitor
toplevelLayoutGetFullscreenMonitor Source #
:: (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 #
:: (HasCallStack, MonadIO m) | |
=> ToplevelLayout |
|
-> m (Bool, Bool) | Returns: whether the |
getResizable
toplevelLayoutGetResizable Source #
:: (HasCallStack, MonadIO m) | |
=> ToplevelLayout |
|
-> m Bool | Returns: |
Returns whether the layout should allow the user to resize the surface.
new
:: (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 surfaceGetScaleFactor
).
ref
:: (HasCallStack, MonadIO m) | |
=> ToplevelLayout |
|
-> m ToplevelLayout | Returns: the same |
Increases the reference count of layout
.
setFullscreen
toplevelLayoutSetFullscreen Source #
:: (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 #
:: (HasCallStack, MonadIO m) | |
=> ToplevelLayout |
|
-> Bool |
|
-> m () |
Sets whether the layout should cause the surface to be maximized when presented.
setResizable
toplevelLayoutSetResizable Source #
:: (HasCallStack, MonadIO m) | |
=> ToplevelLayout |
|
-> Bool |
|
-> m () |
Sets whether the layout should allow the user to resize the surface after it has been presented.
unref
:: (HasCallStack, MonadIO m) | |
=> ToplevelLayout |
|
-> m () |
Decreases the reference count of layout
.