Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	Safe-Inferred
Language	Haskell2010

GI.Gdk.Structs.ToplevelSize

Contents

Exported types
Methods

Description

The GdkToplevelSIze struct contains information that may be useful for users of GdkToplevel to compute a surface size. It also carries information back with the computational result.

Synopsis

newtype ToplevelSize = ToplevelSize (ManagedPtr ToplevelSize)
toplevelSizeGetBounds :: (HasCallStack, MonadIO m) => ToplevelSize -> m (Int32, Int32)
toplevelSizeSetMinSize :: (HasCallStack, MonadIO m) => ToplevelSize -> Int32 -> Int32 -> m ()
toplevelSizeSetShadowWidth :: (HasCallStack, MonadIO m) => ToplevelSize -> Int32 -> Int32 -> Int32 -> Int32 -> m ()
toplevelSizeSetSize :: (HasCallStack, MonadIO m) => ToplevelSize -> Int32 -> Int32 -> m ()

Exported types

newtype ToplevelSize Source #

Memory-managed wrapper type.

Constructors

ToplevelSize (ManagedPtr ToplevelSize)

Instances

Instances details

Eq ToplevelSize Source #
Instance details Defined in GI.Gdk.Structs.ToplevelSize Methods (==) :: ToplevelSize -> ToplevelSize -> Bool # (/=) :: ToplevelSize -> ToplevelSize -> Bool #
BoxedPtr ToplevelSize Source #
Instance details Defined in GI.Gdk.Structs.ToplevelSize Methods boxedPtrCopy :: ToplevelSize -> IO ToplevelSize boxedPtrFree :: ToplevelSize -> IO ()
ManagedPtrNewtype ToplevelSize Source #
Instance details Defined in GI.Gdk.Structs.ToplevelSize Methods toManagedPtr :: ToplevelSize -> ManagedPtr ToplevelSize

Methods

Click to display all available methods, including inherited ones

Expand

Methods

None.

Getters

getBounds.

Setters

setMinSize, setShadowWidth, setSize.

getBounds

toplevelSizeGetBounds Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ToplevelSize	`size`: a `ToplevelSize`
-> m (Int32, Int32)

Retrieves the bounds the toplevel is placed within.

The bounds represent the largest size a toplevel may have while still being able to fit within some type of boundary. Depending on the backend, this may be equivalent to the dimensions of the work area or the monitor on which the window is being presented on, or something else that limits the way a toplevel can be presented.

setMinSize

toplevelSizeSetMinSize Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ToplevelSize	`size`: a `ToplevelSize`
-> Int32	`minWidth`: the minimum width
-> Int32	`minHeight`: the minimum height
-> m ()

The minimum size corresponds to the limitations the toplevel can be shrunk to, without resulting in incorrect painting. A user of a Toplevel should calculate these given both the existing size, and the bounds retrieved from the ToplevelSize object.

The minimum size should be within the bounds (see toplevelSizeGetBounds).

setShadowWidth

toplevelSizeSetShadowWidth Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ToplevelSize	`size`: a `ToplevelSize`
-> Int32	`left`: width of the left part of the shadow
-> Int32	`right`: width of the right part of the shadow
-> Int32	`top`: height of the top part of the shadow
-> Int32	`bottom`: height of the bottom part of the shadow
-> m ()

The shadow width corresponds to the part of the computed surface size that would consist of the shadow margin surrounding the window, would there be any.

setSize

toplevelSizeSetSize Source #

Arguments

:: (HasCallStack, MonadIO m)
=> ToplevelSize	`size`: a `ToplevelSize`
-> Int32	`width`: the width
-> Int32	`height`: the height
-> m ()

Sets the size the toplevel prefers to be resized to. The size should be within the bounds (see toplevelSizeGetBounds). The set size should be considered as a hint, and should not be assumed to be respected by the windowing system, or backend.