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

GI.Gtk.Objects.Window

Contents

Exported types
Methods
Properties
Signals

Description

A GtkWindow is a toplevel window which can contain other widgets. Windows normally have decorations that are under the control of the windowing system and allow the user to manipulate the window (resize it, move it, close it,...).

GtkWindow as GtkBuildable

The GtkWindow implementation of the Buildable interface supports a custom <accel-groups> element, which supports any number of <group> elements representing the AccelGroup objects you want to add to your window (synonymous with windowAddAccelGroup.

It also supports the <initial-focus> element, whose name property names the widget to receive the focus when the window is mapped.

An example of a UI definition fragment with accel groups:

xml code

<object class="GtkWindow">
  <accel-groups>
    <group name="accelgroup1"/>
  </accel-groups>
  <initial-focus name="thunderclap"/>
</object>

...

<object class="GtkAccelGroup" id="accelgroup1"/>

The GtkWindow implementation of the Buildable interface supports setting a child as the titlebar by specifying “titlebar” as the “type” attribute of a <child> element.

CSS nodes

plain code

window.background
├── decoration
├── <titlebar child>.titlebar [.default-decoration]
╰── <child>

GtkWindow has a main CSS node with name window and style class .background, and a subnode with name decoration.

Style classes that are typically used with the main CSS node are .csd (when client-side decorations are in use), .solid-csd (for client-side decorations without invisible borders), .ssd (used by mutter when rendering server-side decorations). GtkWindow also represents window states with the following style classes on the main node: .tiled, .maximized, .fullscreen. Specialized types of window often add their own discriminating style classes, such as .popup or .tooltip.

GtkWindow adds the .titlebar and .default-decoration style classes to the widget that is added as a titlebar child.

Synopsis

newtype Window = Window (ManagedPtr Window)
class (GObject o, IsDescendantOf Window o) => IsWindow o
toWindow :: (MonadIO m, IsWindow o) => o -> m Window
windowActivateDefault :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
windowActivateFocus :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
windowActivateKey :: (HasCallStack, MonadIO m, IsWindow a) => a -> EventKey -> m Bool
windowAddAccelGroup :: (HasCallStack, MonadIO m, IsWindow a, IsAccelGroup b) => a -> b -> m ()
windowAddMnemonic :: (HasCallStack, MonadIO m, IsWindow a, IsWidget b) => a -> Word32 -> b -> m ()
windowBeginMoveDrag :: (HasCallStack, MonadIO m, IsWindow a) => a -> Int32 -> Int32 -> Int32 -> Word32 -> m ()
windowBeginResizeDrag :: (HasCallStack, MonadIO m, IsWindow a) => a -> WindowEdge -> Int32 -> Int32 -> Int32 -> Word32 -> m ()
windowClose :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
windowDeiconify :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
windowFullscreen :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
windowFullscreenOnMonitor :: (HasCallStack, MonadIO m, IsWindow a, IsScreen b) => a -> b -> Int32 -> m ()
windowGetAcceptFocus :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
windowGetApplication :: (HasCallStack, MonadIO m, IsWindow a) => a -> m (Maybe Application)
windowGetAttachedTo :: (HasCallStack, MonadIO m, IsWindow a) => a -> m (Maybe Widget)
windowGetDecorated :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
windowGetDefaultIconList :: (HasCallStack, MonadIO m) => m [Pixbuf]
windowGetDefaultIconName :: (HasCallStack, MonadIO m) => m Text
windowGetDefaultSize :: (HasCallStack, MonadIO m, IsWindow a) => a -> m (Int32, Int32)
windowGetDefaultWidget :: (HasCallStack, MonadIO m, IsWindow a) => a -> m (Maybe Widget)
windowGetDeletable :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
windowGetDestroyWithParent :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
windowGetFocus :: (HasCallStack, MonadIO m, IsWindow a) => a -> m (Maybe Widget)
windowGetFocusOnMap :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
windowGetFocusVisible :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
windowGetGravity :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Gravity
windowGetGroup :: (HasCallStack, MonadIO m, IsWindow a) => a -> m WindowGroup
windowGetHasResizeGrip :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
windowGetHideTitlebarWhenMaximized :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
windowGetIcon :: (HasCallStack, MonadIO m, IsWindow a) => a -> m (Maybe Pixbuf)
windowGetIconList :: (HasCallStack, MonadIO m, IsWindow a) => a -> m [Pixbuf]
windowGetIconName :: (HasCallStack, MonadIO m, IsWindow a) => a -> m (Maybe Text)
windowGetMnemonicModifier :: (HasCallStack, MonadIO m, IsWindow a) => a -> m [ModifierType]
windowGetMnemonicsVisible :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
windowGetModal :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
windowGetOpacity :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Double
windowGetPosition :: (HasCallStack, MonadIO m, IsWindow a) => a -> m (Int32, Int32)
windowGetResizable :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
windowGetResizeGripArea :: (HasCallStack, MonadIO m, IsWindow a) => a -> m (Bool, Rectangle)
windowGetRole :: (HasCallStack, MonadIO m, IsWindow a) => a -> m (Maybe Text)
windowGetScreen :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Screen
windowGetSize :: (HasCallStack, MonadIO m, IsWindow a) => a -> m (Int32, Int32)
windowGetSkipPagerHint :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
windowGetSkipTaskbarHint :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
windowGetTitle :: (HasCallStack, MonadIO m, IsWindow a) => a -> m (Maybe Text)
windowGetTitlebar :: (HasCallStack, MonadIO m, IsWindow a) => a -> m (Maybe Widget)
windowGetTransientFor :: (HasCallStack, MonadIO m, IsWindow a) => a -> m (Maybe Window)
windowGetTypeHint :: (HasCallStack, MonadIO m, IsWindow a) => a -> m WindowTypeHint
windowGetUrgencyHint :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
windowGetWindowType :: (HasCallStack, MonadIO m, IsWindow a) => a -> m WindowType
windowHasGroup :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
windowHasToplevelFocus :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
windowIconify :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
windowIsActive :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
windowIsMaximized :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
windowListToplevels :: (HasCallStack, MonadIO m) => m [Widget]
windowMaximize :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
windowMnemonicActivate :: (HasCallStack, MonadIO m, IsWindow a) => a -> Word32 -> [ModifierType] -> m Bool
windowMove :: (HasCallStack, MonadIO m, IsWindow a) => a -> Int32 -> Int32 -> m ()
windowNew :: (HasCallStack, MonadIO m) => WindowType -> m Window
windowParseGeometry :: (HasCallStack, MonadIO m, IsWindow a) => a -> Text -> m Bool
windowPresent :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
windowPresentWithTime :: (HasCallStack, MonadIO m, IsWindow a) => a -> Word32 -> m ()
windowPropagateKeyEvent :: (HasCallStack, MonadIO m, IsWindow a) => a -> EventKey -> m Bool
windowRemoveAccelGroup :: (HasCallStack, MonadIO m, IsWindow a, IsAccelGroup b) => a -> b -> m ()
windowRemoveMnemonic :: (HasCallStack, MonadIO m, IsWindow a, IsWidget b) => a -> Word32 -> b -> m ()
windowReshowWithInitialSize :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
windowResize :: (HasCallStack, MonadIO m, IsWindow a) => a -> Int32 -> Int32 -> m ()
windowResizeGripIsVisible :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
windowResizeToGeometry :: (HasCallStack, MonadIO m, IsWindow a) => a -> Int32 -> Int32 -> m ()
windowSetAcceptFocus :: (HasCallStack, MonadIO m, IsWindow a) => a -> Bool -> m ()
windowSetApplication :: (HasCallStack, MonadIO m, IsWindow a, IsApplication b) => a -> Maybe b -> m ()
windowSetAttachedTo :: (HasCallStack, MonadIO m, IsWindow a, IsWidget b) => a -> Maybe b -> m ()
windowSetAutoStartupNotification :: (HasCallStack, MonadIO m) => Bool -> m ()
windowSetDecorated :: (HasCallStack, MonadIO m, IsWindow a) => a -> Bool -> m ()
windowSetDefault :: (HasCallStack, MonadIO m, IsWindow a, IsWidget b) => a -> Maybe b -> m ()
windowSetDefaultGeometry :: (HasCallStack, MonadIO m, IsWindow a) => a -> Int32 -> Int32 -> m ()
windowSetDefaultIcon :: (HasCallStack, MonadIO m, IsPixbuf a) => a -> m ()
windowSetDefaultIconFromFile :: (HasCallStack, MonadIO m) => [Char] -> m ()
windowSetDefaultIconList :: (HasCallStack, MonadIO m, IsPixbuf a) => [a] -> m ()
windowSetDefaultIconName :: (HasCallStack, MonadIO m) => Text -> m ()
windowSetDefaultSize :: (HasCallStack, MonadIO m, IsWindow a) => a -> Int32 -> Int32 -> m ()
windowSetDeletable :: (HasCallStack, MonadIO m, IsWindow a) => a -> Bool -> m ()
windowSetDestroyWithParent :: (HasCallStack, MonadIO m, IsWindow a) => a -> Bool -> m ()
windowSetFocus :: (HasCallStack, MonadIO m, IsWindow a, IsWidget b) => a -> Maybe b -> m ()
windowSetFocusOnMap :: (HasCallStack, MonadIO m, IsWindow a) => a -> Bool -> m ()
windowSetFocusVisible :: (HasCallStack, MonadIO m, IsWindow a) => a -> Bool -> m ()
windowSetGeometryHints :: (HasCallStack, MonadIO m, IsWindow a, IsWidget b) => a -> Maybe b -> Maybe Geometry -> [WindowHints] -> m ()
windowSetGravity :: (HasCallStack, MonadIO m, IsWindow a) => a -> Gravity -> m ()
windowSetHasResizeGrip :: (HasCallStack, MonadIO m, IsWindow a) => a -> Bool -> m ()
windowSetHasUserRefCount :: (HasCallStack, MonadIO m, IsWindow a) => a -> Bool -> m ()
windowSetHideTitlebarWhenMaximized :: (HasCallStack, MonadIO m, IsWindow a) => a -> Bool -> m ()
windowSetIcon :: (HasCallStack, MonadIO m, IsWindow a, IsPixbuf b) => a -> Maybe b -> m ()
windowSetIconFromFile :: (HasCallStack, MonadIO m, IsWindow a) => a -> [Char] -> m ()
windowSetIconList :: (HasCallStack, MonadIO m, IsWindow a, IsPixbuf b) => a -> [b] -> m ()
windowSetIconName :: (HasCallStack, MonadIO m, IsWindow a) => a -> Maybe Text -> m ()
windowSetInteractiveDebugging :: (HasCallStack, MonadIO m) => Bool -> m ()
windowSetKeepAbove :: (HasCallStack, MonadIO m, IsWindow a) => a -> Bool -> m ()
windowSetKeepBelow :: (HasCallStack, MonadIO m, IsWindow a) => a -> Bool -> m ()
windowSetMnemonicModifier :: (HasCallStack, MonadIO m, IsWindow a) => a -> [ModifierType] -> m ()
windowSetMnemonicsVisible :: (HasCallStack, MonadIO m, IsWindow a) => a -> Bool -> m ()
windowSetModal :: (HasCallStack, MonadIO m, IsWindow a) => a -> Bool -> m ()
windowSetOpacity :: (HasCallStack, MonadIO m, IsWindow a) => a -> Double -> m ()
windowSetPosition :: (HasCallStack, MonadIO m, IsWindow a) => a -> WindowPosition -> m ()
windowSetResizable :: (HasCallStack, MonadIO m, IsWindow a) => a -> Bool -> m ()
windowSetRole :: (HasCallStack, MonadIO m, IsWindow a) => a -> Text -> m ()
windowSetScreen :: (HasCallStack, MonadIO m, IsWindow a, IsScreen b) => a -> b -> m ()
windowSetSkipPagerHint :: (HasCallStack, MonadIO m, IsWindow a) => a -> Bool -> m ()
windowSetSkipTaskbarHint :: (HasCallStack, MonadIO m, IsWindow a) => a -> Bool -> m ()
windowSetStartupId :: (HasCallStack, MonadIO m, IsWindow a) => a -> Text -> m ()
windowSetTitle :: (HasCallStack, MonadIO m, IsWindow a) => a -> Text -> m ()
windowSetTitlebar :: (HasCallStack, MonadIO m, IsWindow a, IsWidget b) => a -> Maybe b -> m ()
windowSetTransientFor :: (HasCallStack, MonadIO m, IsWindow a, IsWindow b) => a -> Maybe b -> m ()
windowSetTypeHint :: (HasCallStack, MonadIO m, IsWindow a) => a -> WindowTypeHint -> m ()
windowSetUrgencyHint :: (HasCallStack, MonadIO m, IsWindow a) => a -> Bool -> m ()
windowSetWmclass :: (HasCallStack, MonadIO m, IsWindow a) => a -> Text -> Text -> m ()
windowStick :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
windowUnfullscreen :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
windowUnmaximize :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
windowUnstick :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
constructWindowAcceptFocus :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o)
getWindowAcceptFocus :: (MonadIO m, IsWindow o) => o -> m Bool
setWindowAcceptFocus :: (MonadIO m, IsWindow o) => o -> Bool -> m ()
clearWindowApplication :: (MonadIO m, IsWindow o) => o -> m ()
constructWindowApplication :: (IsWindow o, MonadIO m, IsApplication a) => a -> m (GValueConstruct o)
getWindowApplication :: (MonadIO m, IsWindow o) => o -> m (Maybe Application)
setWindowApplication :: (MonadIO m, IsWindow o, IsApplication a) => o -> a -> m ()
clearWindowAttachedTo :: (MonadIO m, IsWindow o) => o -> m ()
constructWindowAttachedTo :: (IsWindow o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)
getWindowAttachedTo :: (MonadIO m, IsWindow o) => o -> m (Maybe Widget)
setWindowAttachedTo :: (MonadIO m, IsWindow o, IsWidget a) => o -> a -> m ()
constructWindowDecorated :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o)
getWindowDecorated :: (MonadIO m, IsWindow o) => o -> m Bool
setWindowDecorated :: (MonadIO m, IsWindow o) => o -> Bool -> m ()
constructWindowDefaultHeight :: (IsWindow o, MonadIO m) => Int32 -> m (GValueConstruct o)
getWindowDefaultHeight :: (MonadIO m, IsWindow o) => o -> m Int32
setWindowDefaultHeight :: (MonadIO m, IsWindow o) => o -> Int32 -> m ()
constructWindowDefaultWidth :: (IsWindow o, MonadIO m) => Int32 -> m (GValueConstruct o)
getWindowDefaultWidth :: (MonadIO m, IsWindow o) => o -> m Int32
setWindowDefaultWidth :: (MonadIO m, IsWindow o) => o -> Int32 -> m ()
constructWindowDeletable :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o)
getWindowDeletable :: (MonadIO m, IsWindow o) => o -> m Bool
setWindowDeletable :: (MonadIO m, IsWindow o) => o -> Bool -> m ()
constructWindowDestroyWithParent :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o)
getWindowDestroyWithParent :: (MonadIO m, IsWindow o) => o -> m Bool
setWindowDestroyWithParent :: (MonadIO m, IsWindow o) => o -> Bool -> m ()
constructWindowFocusOnMap :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o)
getWindowFocusOnMap :: (MonadIO m, IsWindow o) => o -> m Bool
setWindowFocusOnMap :: (MonadIO m, IsWindow o) => o -> Bool -> m ()
constructWindowFocusVisible :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o)
getWindowFocusVisible :: (MonadIO m, IsWindow o) => o -> m Bool
setWindowFocusVisible :: (MonadIO m, IsWindow o) => o -> Bool -> m ()
constructWindowGravity :: (IsWindow o, MonadIO m) => Gravity -> m (GValueConstruct o)
getWindowGravity :: (MonadIO m, IsWindow o) => o -> m Gravity
setWindowGravity :: (MonadIO m, IsWindow o) => o -> Gravity -> m ()
constructWindowHasResizeGrip :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o)
getWindowHasResizeGrip :: (MonadIO m, IsWindow o) => o -> m Bool
setWindowHasResizeGrip :: (MonadIO m, IsWindow o) => o -> Bool -> m ()
getWindowHasToplevelFocus :: (MonadIO m, IsWindow o) => o -> m Bool
constructWindowHideTitlebarWhenMaximized :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o)
getWindowHideTitlebarWhenMaximized :: (MonadIO m, IsWindow o) => o -> m Bool
setWindowHideTitlebarWhenMaximized :: (MonadIO m, IsWindow o) => o -> Bool -> m ()
clearWindowIcon :: (MonadIO m, IsWindow o) => o -> m ()
constructWindowIcon :: (IsWindow o, MonadIO m, IsPixbuf a) => a -> m (GValueConstruct o)
getWindowIcon :: (MonadIO m, IsWindow o) => o -> m (Maybe Pixbuf)
setWindowIcon :: (MonadIO m, IsWindow o, IsPixbuf a) => o -> a -> m ()
clearWindowIconName :: (MonadIO m, IsWindow o) => o -> m ()
constructWindowIconName :: (IsWindow o, MonadIO m) => Text -> m (GValueConstruct o)
getWindowIconName :: (MonadIO m, IsWindow o) => o -> m (Maybe Text)
setWindowIconName :: (MonadIO m, IsWindow o) => o -> Text -> m ()
getWindowIsActive :: (MonadIO m, IsWindow o) => o -> m Bool
getWindowIsMaximized :: (MonadIO m, IsWindow o) => o -> m Bool
constructWindowMnemonicsVisible :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o)
getWindowMnemonicsVisible :: (MonadIO m, IsWindow o) => o -> m Bool
setWindowMnemonicsVisible :: (MonadIO m, IsWindow o) => o -> Bool -> m ()
constructWindowModal :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o)
getWindowModal :: (MonadIO m, IsWindow o) => o -> m Bool
setWindowModal :: (MonadIO m, IsWindow o) => o -> Bool -> m ()
constructWindowResizable :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o)
getWindowResizable :: (MonadIO m, IsWindow o) => o -> m Bool
setWindowResizable :: (MonadIO m, IsWindow o) => o -> Bool -> m ()
getWindowResizeGripVisible :: (MonadIO m, IsWindow o) => o -> m Bool
constructWindowRole :: (IsWindow o, MonadIO m) => Text -> m (GValueConstruct o)
getWindowRole :: (MonadIO m, IsWindow o) => o -> m (Maybe Text)
setWindowRole :: (MonadIO m, IsWindow o) => o -> Text -> m ()
constructWindowScreen :: (IsWindow o, MonadIO m, IsScreen a) => a -> m (GValueConstruct o)
getWindowScreen :: (MonadIO m, IsWindow o) => o -> m Screen
setWindowScreen :: (MonadIO m, IsWindow o, IsScreen a) => o -> a -> m ()
constructWindowSkipPagerHint :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o)
getWindowSkipPagerHint :: (MonadIO m, IsWindow o) => o -> m Bool
setWindowSkipPagerHint :: (MonadIO m, IsWindow o) => o -> Bool -> m ()
constructWindowSkipTaskbarHint :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o)
getWindowSkipTaskbarHint :: (MonadIO m, IsWindow o) => o -> m Bool
setWindowSkipTaskbarHint :: (MonadIO m, IsWindow o) => o -> Bool -> m ()
constructWindowStartupId :: (IsWindow o, MonadIO m) => Text -> m (GValueConstruct o)
setWindowStartupId :: (MonadIO m, IsWindow o) => o -> Text -> m ()
constructWindowTitle :: (IsWindow o, MonadIO m) => Text -> m (GValueConstruct o)
getWindowTitle :: (MonadIO m, IsWindow o) => o -> m (Maybe Text)
setWindowTitle :: (MonadIO m, IsWindow o) => o -> Text -> m ()
clearWindowTransientFor :: (MonadIO m, IsWindow o) => o -> m ()
constructWindowTransientFor :: (IsWindow o, MonadIO m, IsWindow a) => a -> m (GValueConstruct o)
getWindowTransientFor :: (MonadIO m, IsWindow o) => o -> m (Maybe Window)
setWindowTransientFor :: (MonadIO m, IsWindow o, IsWindow a) => o -> a -> m ()
constructWindowType :: (IsWindow o, MonadIO m) => WindowType -> m (GValueConstruct o)
getWindowType :: (MonadIO m, IsWindow o) => o -> m WindowType
constructWindowTypeHint :: (IsWindow o, MonadIO m) => WindowTypeHint -> m (GValueConstruct o)
getWindowTypeHint :: (MonadIO m, IsWindow o) => o -> m WindowTypeHint
setWindowTypeHint :: (MonadIO m, IsWindow o) => o -> WindowTypeHint -> m ()
constructWindowUrgencyHint :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o)
getWindowUrgencyHint :: (MonadIO m, IsWindow o) => o -> m Bool
setWindowUrgencyHint :: (MonadIO m, IsWindow o) => o -> Bool -> m ()
constructWindowWindowPosition :: (IsWindow o, MonadIO m) => WindowPosition -> m (GValueConstruct o)
getWindowWindowPosition :: (MonadIO m, IsWindow o) => o -> m WindowPosition
setWindowWindowPosition :: (MonadIO m, IsWindow o) => o -> WindowPosition -> m ()
type WindowActivateDefaultCallback = IO ()
afterWindowActivateDefault :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowActivateDefaultCallback) -> m SignalHandlerId
onWindowActivateDefault :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowActivateDefaultCallback) -> m SignalHandlerId
type WindowActivateFocusCallback = IO ()
afterWindowActivateFocus :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowActivateFocusCallback) -> m SignalHandlerId
onWindowActivateFocus :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowActivateFocusCallback) -> m SignalHandlerId
type WindowEnableDebuggingCallback = Bool -> IO Bool
afterWindowEnableDebugging :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowEnableDebuggingCallback) -> m SignalHandlerId
onWindowEnableDebugging :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowEnableDebuggingCallback) -> m SignalHandlerId
type WindowKeysChangedCallback = IO ()
afterWindowKeysChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowKeysChangedCallback) -> m SignalHandlerId
onWindowKeysChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowKeysChangedCallback) -> m SignalHandlerId
type WindowSetFocusCallback = Maybe Widget -> IO ()
afterWindowSetFocus :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowSetFocusCallback) -> m SignalHandlerId
onWindowSetFocus :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowSetFocusCallback) -> m SignalHandlerId

Exported types

newtype Window Source #

Memory-managed wrapper type.

Constructors

Window (ManagedPtr Window)

Instances

Instances details

Eq Window Source #
Instance details Defined in GI.Gtk.Objects.Window Methods (==) :: Window -> Window -> Bool # (/=) :: Window -> Window -> Bool #
GObject Window Source #
Instance details Defined in GI.Gtk.Objects.Window
ManagedPtrNewtype Window Source #
Instance details Defined in GI.Gtk.Objects.Window Methods toManagedPtr :: Window -> ManagedPtr Window
TypedObject Window Source #
Instance details Defined in GI.Gtk.Objects.Window Methods glibType :: IO GType
HasParentTypes Window Source #
Instance details Defined in GI.Gtk.Objects.Window
IsGValue (Maybe Window) Source #	Convert `Window` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Objects.Window Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Window -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Window)
type ParentTypes Window Source #
Instance details Defined in GI.Gtk.Objects.Window type ParentTypes Window = '[Bin, Container, Widget, Object, ImplementorIface, Buildable]

class (GObject o, IsDescendantOf Window o) => IsWindow o Source #

Type class for types which can be safely cast to Window, for instance with toWindow.

Instances

Instances details

(GObject o, IsDescendantOf Window o) => IsWindow o Source #
Instance details Defined in GI.Gtk.Objects.Window

toWindow :: (MonadIO m, IsWindow o) => o -> m Window Source #

Cast to Window, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Expand

activateDefault

windowActivateDefault Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m Bool	Returns: `True` if a widget got activated.

Activates the default widget for the window, unless the current focused widget has been configured to receive the default action (see widgetSetReceivesDefault), in which case the focused widget is activated.

activateFocus

windowActivateFocus Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m Bool	Returns: `True` if a widget got activated.

Activates the current focused widget within the window.

activateKey

windowActivateKey Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> EventKey	`event`: a `EventKey`
-> m Bool	Returns: `True` if a mnemonic or accelerator was found and activated.

Activates mnemonics and accelerators for this Window. This is normally called by the default key_press_event handler for toplevel windows, however in some cases it may be useful to call this directly when overriding the standard key handling for a toplevel window.

Since: 2.4

addAccelGroup

windowAddAccelGroup Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a, IsAccelGroup b)
=> a	`window`: window to attach accelerator group to
-> b	`accelGroup`: a `AccelGroup`
-> m ()

Associate accelGroup with window, such that calling accelGroupsActivate on window will activate accelerators in accelGroup.

addMnemonic

windowAddMnemonic Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a, IsWidget b)
=> a	`window`: a `Window`
-> Word32	`keyval`: the mnemonic
-> b	`target`: the widget that gets activated by the mnemonic
-> m ()

Adds a mnemonic to this window.

beginMoveDrag

windowBeginMoveDrag Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Int32	`button`: mouse button that initiated the drag
-> Int32	`rootX`: X position where the user clicked to initiate the drag, in root window coordinates
-> Int32	`rootY`: Y position where the user clicked to initiate the drag
-> Word32	`timestamp`: timestamp from the click event that initiated the drag
-> m ()

Starts moving a window. This function is used if an application has window movement grips. When GDK can support it, the window movement will be done using the standard mechanism for the [window manager][gtk-X11-arch] or windowing system. Otherwise, GDK will try to emulate window movement, potentially not all that well, depending on the windowing system.

beginResizeDrag

windowBeginResizeDrag Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> WindowEdge	`edge`: position of the resize control
-> Int32	`button`: mouse button that initiated the drag
-> Int32	`rootX`: X position where the user clicked to initiate the drag, in root window coordinates
-> Int32	`rootY`: Y position where the user clicked to initiate the drag
-> Word32	`timestamp`: timestamp from the click event that initiated the drag
-> m ()

Starts resizing a window. This function is used if an application has window resizing controls. When GDK can support it, the resize will be done using the standard mechanism for the [window manager][gtk-X11-arch] or windowing system. Otherwise, GDK will try to emulate window resizing, potentially not all that well, depending on the windowing system.

close

windowClose Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m ()

Requests that the window is closed, similar to what happens when a window manager close button is clicked.

This function can be used with close buttons in custom titlebars.

Since: 3.10

deiconify

windowDeiconify Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m ()

Asks to deiconify (i.e. unminimize) the specified window. Note that you shouldn’t assume the window is definitely deiconified afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch])) could iconify it again before your code which assumes deiconification gets to run.

You can track iconification via the “window-state-event” signal on Widget.

fullscreen

windowFullscreen Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m ()

Asks to place window in the fullscreen state. Note that you shouldn’t assume the window is definitely full screen afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could unfullscreen it again, and not all window managers honor requests to fullscreen windows. But normally the window will end up fullscreen. Just don’t write code that crashes if not.

You can track the fullscreen state via the “window-state-event” signal on Widget.

Since: 2.2

fullscreenOnMonitor

windowFullscreenOnMonitor Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a, IsScreen b)
=> a	`window`: a `Window`
-> b	`screen`: a `Screen` to draw to
-> Int32	`monitor`: which monitor to go fullscreen on
-> m ()

Asks to place window in the fullscreen state. Note that you shouldn't assume the window is definitely full screen afterward.

You can track the fullscreen state via the "window-state-event" signal on Widget.

Since: 3.18

getAcceptFocus

windowGetAcceptFocus Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m Bool	Returns: `True` if window should receive the input focus

Gets the value set by windowSetAcceptFocus.

Since: 2.4

getApplication

windowGetApplication Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m (Maybe Application)	Returns: a `Application`, or `Nothing`

Gets the Application associated with the window (if any).

Since: 3.0

getAttachedTo

windowGetAttachedTo Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m (Maybe Widget)	Returns: the widget where the window is attached, or `Nothing` if the window is not attached to any widget.

Fetches the attach widget for this window. See windowSetAttachedTo.

Since: 3.4

getDecorated

windowGetDecorated Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m Bool	Returns: `True` if the window has been set to have decorations

Returns whether the window has been set to have decorations such as a title bar via windowSetDecorated.

getDefaultIconList

windowGetDefaultIconList Source #

Arguments

:: (HasCallStack, MonadIO m)
=> m [Pixbuf]	Returns: copy of default icon list

Gets the value set by windowSetDefaultIconList. The list is a copy and should be freed with g_list_free(), but the pixbufs in the list have not had their reference count incremented.

getDefaultIconName

windowGetDefaultIconName Source #

Arguments

:: (HasCallStack, MonadIO m)
=> m Text	Returns: the fallback icon name for windows

Returns the fallback icon name for windows that has been set with windowSetDefaultIconName. The returned string is owned by GTK+ and should not be modified. It is only valid until the next call to windowSetDefaultIconName.

Since: 2.16

getDefaultSize

windowGetDefaultSize Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m (Int32, Int32)

Gets the default size of the window. A value of -1 for the width or height indicates that a default size has not been explicitly set for that dimension, so the “natural” size of the window will be used.

getDefaultWidget

windowGetDefaultWidget Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m (Maybe Widget)	Returns: the default widget, or `Nothing` if there is none.

Returns the default widget for window. See windowSetDefault for more details.

Since: 2.14

getDeletable

windowGetDeletable Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m Bool	Returns: `True` if the window has been set to have a close button

Returns whether the window has been set to have a close button via windowSetDeletable.

Since: 2.10

getDestroyWithParent

windowGetDestroyWithParent Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m Bool	Returns: `True` if the window will be destroyed with its transient parent.

Returns whether the window will be destroyed with its transient parent. See gtk_window_set_destroy_with_parent ().

getFocus

windowGetFocus Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m (Maybe Widget)	Returns: the currently focused widget, or `Nothing` if there is none.

Retrieves the current focused widget within the window. Note that this is the widget that would have the focus if the toplevel window focused; if the toplevel window is not focused then gtk_widget_has_focus (widget) will not be True for the widget.

getFocusOnMap

windowGetFocusOnMap Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m Bool	Returns: `True` if window should receive the input focus when mapped.

Gets the value set by windowSetFocusOnMap.

Since: 2.6

getFocusVisible

windowGetFocusVisible Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m Bool	Returns: `True` if “focus rectangles” are supposed to be visible in this window.

Gets the value of the Window:focusVisible property.

Since: 3.2

getGravity

windowGetGravity Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m Gravity	Returns: window gravity

Gets the value set by windowSetGravity.

getGroup

windowGetGroup Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`, or `Nothing`
-> m WindowGroup	Returns: the `WindowGroup` for a window or the default group

Returns the group for window or the default group, if window is Nothing or if window does not have an explicit window group.

Since: 2.10

getHasResizeGrip

windowGetHasResizeGrip Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m Bool	Returns: `True` if the window has a resize grip

Deprecated: (Since version 3.14)Resize grips have been removed.

Determines whether the window may have a resize grip.

Since: 3.0

getHideTitlebarWhenMaximized

windowGetHideTitlebarWhenMaximized Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m Bool	Returns: `True` if the window has requested to have its titlebar hidden when maximized

Returns whether the window has requested to have its titlebar hidden when maximized. See gtk_window_set_hide_titlebar_when_maximized ().

Since: 3.4

getIcon

windowGetIcon Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m (Maybe Pixbuf)	Returns: icon for window or `Nothing` if none

Gets the value set by windowSetIcon (or if you've called windowSetIconList, gets the first icon in the icon list).

getIconList

windowGetIconList Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m [Pixbuf]	Returns: copy of window’s icon list

Retrieves the list of icons set by windowSetIconList. The list is copied, but the reference count on each member won’t be incremented.

getIconName

windowGetIconName Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m (Maybe Text)	Returns: the icon name or `Nothing` if the window has no themed icon

Returns the name of the themed icon for the window, see windowSetIconName.

Since: 2.6

getMnemonicModifier

windowGetMnemonicModifier Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m [ModifierType]	Returns: the modifier mask used to activate mnemonics on this window.

Returns the mnemonic modifier for this window. See windowSetMnemonicModifier.

getMnemonicsVisible

windowGetMnemonicsVisible Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m Bool	Returns: `True` if mnemonics are supposed to be visible in this window.

Gets the value of the Window:mnemonicsVisible property.

Since: 2.20

getModal

windowGetModal Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m Bool	Returns: `True` if the window is set to be modal and establishes a grab when shown

Returns whether the window is modal. See windowSetModal.

getOpacity

windowGetOpacity Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m Double	Returns: the requested opacity for this window.

Deprecated: (Since version 3.8)Use gtk_widget_get_opacity instead.

Fetches the requested opacity for this window. See windowSetOpacity.

Since: 2.12

getPosition

windowGetPosition Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m (Int32, Int32)

This function returns the position you need to pass to windowMove to keep window in its current position. This means that the meaning of the returned value varies with window gravity. See windowMove for more details.

The reliability of this function depends on the windowing system currently in use. Some windowing systems, such as Wayland, do not support a global coordinate system, and thus the position of the window will always be (0, 0). Others, like X11, do not have a reliable way to obtain the geometry of the decorations of a window if they are provided by the window manager. Additionally, on X11, window manager have been known to mismanage window gravity, which result in windows moving even if you use the coordinates of the current position as returned by this function.

If you haven’t changed the window gravity, its gravity will be GDK_GRAVITY_NORTH_WEST. This means that windowGetPosition gets the position of the top-left corner of the window manager frame for the window. windowMove sets the position of this same top-left corner.

If a window has gravity GDK_GRAVITY_STATIC the window manager frame is not relevant, and thus windowGetPosition will always produce accurate results. However you can’t use static gravity to do things like place a window in a corner of the screen, because static gravity ignores the window manager decorations.

Ideally, this function should return appropriate values if the window has client side decorations, assuming that the windowing system supports global coordinates.

In practice, saving the window position should not be left to applications, as they lack enough knowledge of the windowing system and the window manager state to effectively do so. The appropriate way to implement saving the window position is to use a platform-specific protocol, wherever that is available.

getResizable

windowGetResizable Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m Bool	Returns: `True` if the user can resize the window

Gets the value set by windowSetResizable.

getResizeGripArea

windowGetResizeGripArea Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m (Bool, Rectangle)	Returns: `True` if the resize grip’s area was retrieved

Deprecated: (Since version 3.14)Resize grips have been removed.

If a window has a resize grip, this will retrieve the grip position, width and height into the specified Rectangle.

Since: 3.0

getRole

windowGetRole Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m (Maybe Text)	Returns: the role of the window if set, or `Nothing`. The returned is owned by the widget and must not be modified or freed.

Returns the role of the window. See windowSetRole for further explanation.

getScreen

windowGetScreen Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`.
-> m Screen	Returns: a `Screen`.

Returns the Screen associated with window.

Since: 2.2

getSize

windowGetSize Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m (Int32, Int32)

Obtains the current size of window.

If window is not visible on screen, this function return the size GTK+ will suggest to the [window manager][gtk-X11-arch] for the initial window size (but this is not reliably the same as the size the window manager will actually select). See: windowSetDefaultSize.

Depending on the windowing system and the window manager constraints, the size returned by this function may not match the size set using windowResize; additionally, since windowResize may be implemented as an asynchronous operation, GTK+ cannot guarantee in any way that this code:

C code

 // width and height are set elsewhere
 gtk_window_resize (window, width, height);

 int new_width, new_height;
 gtk_window_get_size (window, &new_width, &new_height);

will result in new_width and new_height matching width and height, respectively.

This function will return the logical size of the Window, excluding the widgets used in client side decorations; there is, however, no guarantee that the result will be completely accurate because client side decoration may include widgets that depend on the user preferences and that may not be visibile at the time you call this function.

The dimensions returned by this function are suitable for being stored across sessions; use windowSetDefaultSize to restore them when before showing the window.

To avoid potential race conditions, you should only call this function in response to a size change notification, for instance inside a handler for the Widget::sizeAllocate signal, or inside a handler for the Widget::configureEvent signal:

C code

static void
on_size_allocate (GtkWidget *widget, GtkAllocation *allocation)
{
  int new_width, new_height;

  gtk_window_get_size (GTK_WINDOW (widget), &new_width, &new_height);

  ...
}

Note that, if you connect to the Widget::sizeAllocate signal, you should not use the dimensions of the GtkAllocation passed to the signal handler, as the allocation may contain client side decorations added by GTK+, depending on the windowing system in use.

If you are getting a window size in order to position the window on the screen, you should, instead, simply set the window’s semantic type with windowSetTypeHint, which allows the window manager to e.g. center dialogs. Also, if you set the transient parent of dialogs with windowSetTransientFor window managers will often center the dialog over its parent window. It's much preferred to let the window manager handle these cases rather than doing it yourself, because all apps will behave consistently and according to user or system preferences, if the window manager handles it. Also, the window manager can take into account the size of the window decorations and border that it may add, and of which GTK+ has no knowledge. Additionally, positioning windows in global screen coordinates may not be allowed by the windowing system. For more information, see: windowSetPosition.

getSkipPagerHint

windowGetSkipPagerHint Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m Bool	Returns: `True` if window shouldn’t be in pager

Gets the value set by windowSetSkipPagerHint.

Since: 2.2

getSkipTaskbarHint

windowGetSkipTaskbarHint Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m Bool	Returns: `True` if window shouldn’t be in taskbar

Gets the value set by windowSetSkipTaskbarHint

Since: 2.2

getTitle

windowGetTitle Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m (Maybe Text)	Returns: the title of the window, or `Nothing` if none has been set explicitly. The returned string is owned by the widget and must not be modified or freed.

Retrieves the title of the window. See windowSetTitle.

getTitlebar

windowGetTitlebar Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m (Maybe Widget)	Returns: the custom titlebar, or `Nothing`

Returns the custom titlebar that has been set with windowSetTitlebar.

Since: 3.16

getTransientFor

windowGetTransientFor Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m (Maybe Window)	Returns: the transient parent for this window, or `Nothing` if no transient parent has been set.

Fetches the transient parent for this window. See windowSetTransientFor.

getTypeHint

windowGetTypeHint Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m WindowTypeHint	Returns: the type hint for `window`.

Gets the type hint for this window. See windowSetTypeHint.

getUrgencyHint

windowGetUrgencyHint Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m Bool	Returns: `True` if window is urgent

Gets the value set by windowSetUrgencyHint

Since: 2.8

getWindowType

windowGetWindowType Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m WindowType	Returns: the type of the window

Gets the type of the window. See WindowType.

Since: 2.20

hasGroup

windowHasGroup Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)

=> a

window: a Window

-> m Bool

Returns: True if window has an explicit window group.

Since 2.22

Returns whether window has an explicit window group.

hasToplevelFocus

windowHasToplevelFocus Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m Bool	Returns: `True` if the input focus is within this GtkWindow

Returns whether the input focus is within this GtkWindow. For real toplevel windows, this is identical to windowIsActive, but for embedded windows, like Plug, the results will differ.

Since: 2.4

iconify

windowIconify Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m ()

Asks to iconify (i.e. minimize) the specified window. Note that you shouldn’t assume the window is definitely iconified afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could deiconify it again, or there may not be a window manager in which case iconification isn’t possible, etc. But normally the window will end up iconified. Just don’t write code that crashes if not.

It’s permitted to call this function before showing a window, in which case the window will be iconified before it ever appears onscreen.

You can track iconification via the “window-state-event” signal on Widget.

isActive

windowIsActive Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m Bool	Returns: `True` if the window part of the current active window.

Returns whether the window is part of the current active toplevel. (That is, the toplevel window receiving keystrokes.) The return value is True if the window is active toplevel itself, but also if it is, say, a Plug embedded in the active toplevel. You might use this function if you wanted to draw a widget differently in an active window from a widget in an inactive window. See windowHasToplevelFocus

Since: 2.4

isMaximized

windowIsMaximized Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m Bool	Returns: whether the window has a maximized state.

Retrieves the current maximized state of window.

Note that since maximization is ultimately handled by the window manager and happens asynchronously to an application request, you shouldn’t assume the return value of this function changing immediately (or at all), as an effect of calling windowMaximize or windowUnmaximize.

Since: 3.12

listToplevels

windowListToplevels Source #

Arguments

:: (HasCallStack, MonadIO m)
=> m [Widget]	Returns: list of toplevel widgets

Returns a list of all existing toplevel windows. The widgets in the list are not individually referenced. If you want to iterate through the list and perform actions involving callbacks that might destroy the widgets, you must call g_list_foreach (result, (GFunc)g_object_ref, NULL) first, and then unref all the widgets afterwards.

maximize

windowMaximize Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m ()

Asks to maximize window, so that it becomes full-screen. Note that you shouldn’t assume the window is definitely maximized afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could unmaximize it again, and not all window managers support maximization. But normally the window will end up maximized. Just don’t write code that crashes if not.

It’s permitted to call this function before showing a window, in which case the window will be maximized when it appears onscreen initially.

You can track maximization via the “window-state-event” signal on Widget, or by listening to notifications on the Window:isMaximized property.

mnemonicActivate

windowMnemonicActivate Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Word32	`keyval`: the mnemonic
-> [ModifierType]	`modifier`: the modifiers
-> m Bool	Returns: `True` if the activation is done.

Activates the targets associated with the mnemonic.

move

windowMove Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Int32	`x`: X coordinate to move window to
-> Int32	`y`: Y coordinate to move window to
-> m ()

Asks the [window manager][gtk-X11-arch] to move window to the given position. Window managers are free to ignore this; most window managers ignore requests for initial window positions (instead using a user-defined placement algorithm) and honor requests after the window has already been shown.

Note: the position is the position of the gravity-determined reference point for the window. The gravity determines two things: first, the location of the reference point in root window coordinates; and second, which point on the window is positioned at the reference point.

By default the gravity is GDK_GRAVITY_NORTH_WEST, so the reference point is simply the x, y supplied to windowMove. The top-left corner of the window decorations (aka window frame or border) will be placed at x, y. Therefore, to position a window at the top left of the screen, you want to use the default gravity (which is GDK_GRAVITY_NORTH_WEST) and move the window to 0,0.

To position a window at the bottom right corner of the screen, you would set GDK_GRAVITY_SOUTH_EAST, which means that the reference point is at x + the window width and y + the window height, and the bottom-right corner of the window border will be placed at that reference point. So, to place a window in the bottom right corner you would first set gravity to south east, then write: gtk_window_move (window, gdk_screen_width () - window_width, gdk_screen_height () - window_height) (note that this example does not take multi-head scenarios into account).

The Extended Window Manager Hints Specification has a nice table of gravities in the “implementation notes” section.

The windowGetPosition documentation may also be relevant.

new

windowNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> WindowType	`type`: type of window
-> m Window	Returns: a new `Window`.

Creates a new Window, which is a toplevel window that can contain other widgets. Nearly always, the type of the window should be GTK_WINDOW_TOPLEVEL. If you’re implementing something like a popup menu from scratch (which is a bad idea, just use Menu), you might use GTK_WINDOW_POPUP. GTK_WINDOW_POPUP is not for dialogs, though in some other toolkits dialogs are called “popups”. In GTK+, GTK_WINDOW_POPUP means a pop-up menu or pop-up tooltip. On X11, popup windows are not controlled by the [window manager][gtk-X11-arch].

If you simply want an undecorated window (no window borders), use windowSetDecorated, don’t use GTK_WINDOW_POPUP.

All top-level windows created by windowNew are stored in an internal top-level window list. This list can be obtained from windowListToplevels. Due to Gtk+ keeping a reference to the window internally, windowNew does not return a reference to the caller.

To delete a Window, call widgetDestroy.

parseGeometry

windowParseGeometry Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Text	`geometry`: geometry string
-> m Bool	Returns: `True` if string was parsed successfully

Deprecated: (Since version 3.20)Geometry handling in GTK is deprecated.

Parses a standard X Window System geometry string - see the manual page for X (type “man X”) for details on this. windowParseGeometry does work on all GTK+ ports including Win32 but is primarily intended for an X environment.

If either a size or a position can be extracted from the geometry string, windowParseGeometry returns True and calls windowSetDefaultSize and/or windowMove to resize/move the window.

If windowParseGeometry returns True, it will also set the GDK_HINT_USER_POS and/or GDK_HINT_USER_SIZE hints indicating to the window manager that the size/position of the window was user-specified. This causes most window managers to honor the geometry.

Note that for windowParseGeometry to work as expected, it has to be called when the window has its “final” size, i.e. after calling widgetShowAll on the contents and windowSetGeometryHints on the window.

C code

#include <gtk/gtk.h>

static void
fill_with_content (GtkWidget *vbox)
{
  // fill with content...
}

int
main (int argc, char *argv[])
{
  GtkWidget *window, *vbox;
  GdkGeometry size_hints = {
    100, 50, 0, 0, 100, 50, 10,
    10, 0.0, 0.0, GDK_GRAVITY_NORTH_WEST
  };

  gtk_init (&argc, &argv);

  window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
  vbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);

  gtk_container_add (GTK_CONTAINER (window), vbox);
  fill_with_content (vbox);
  gtk_widget_show_all (vbox);

  gtk_window_set_geometry_hints (GTK_WINDOW (window),
	  			    NULL,
				    &size_hints,
				    GDK_HINT_MIN_SIZE |
				    GDK_HINT_BASE_SIZE |
				    GDK_HINT_RESIZE_INC);

  if (argc > 1)
    {
      gboolean res;
      res = gtk_window_parse_geometry (GTK_WINDOW (window),
                                       argv[1]);
      if (! res)
        fprintf (stderr,
                 "Failed to parse “%s”\n",
                 argv[1]);
    }

  gtk_widget_show_all (window);
  gtk_main ();

  return 0;
}

present

windowPresent Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m ()

Presents a window to the user. This function should not be used as when it is called, it is too late to gather a valid timestamp to allow focus stealing prevention to work correctly.

presentWithTime

windowPresentWithTime Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Word32	`timestamp`: the timestamp of the user interaction (typically a button or key press event) which triggered this call
-> m ()

Presents a window to the user. This may mean raising the window in the stacking order, deiconifying it, moving it to the current desktop, and/or giving it the keyboard focus, possibly dependent on the user’s platform, window manager, and preferences.

If window is hidden, this function calls widgetShow as well.

This function should be used when the user tries to open a window that’s already open. Say for example the preferences dialog is currently open, and the user chooses Preferences from the menu a second time; use windowPresent to move the already-open dialog where the user can see it.

Presents a window to the user in response to a user interaction. The timestamp should be gathered when the window was requested to be shown (when clicking a link for example), rather than once the window is ready to be shown.

Since: 2.8

propagateKeyEvent

windowPropagateKeyEvent Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> EventKey	`event`: a `EventKey`
-> m Bool	Returns: `True` if a widget in the focus chain handled the event.

Propagate a key press or release event to the focus widget and up the focus container chain until a widget handles event. This is normally called by the default key_press_event and key_release_event handlers for toplevel windows, however in some cases it may be useful to call this directly when overriding the standard key handling for a toplevel window.

Since: 2.4

removeAccelGroup

windowRemoveAccelGroup Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a, IsAccelGroup b)
=> a	`window`: a `Window`
-> b	`accelGroup`: a `AccelGroup`
-> m ()

Reverses the effects of windowAddAccelGroup.

removeMnemonic

windowRemoveMnemonic Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a, IsWidget b)
=> a	`window`: a `Window`
-> Word32	`keyval`: the mnemonic
-> b	`target`: the widget that gets activated by the mnemonic
-> m ()

Removes a mnemonic from this window.

reshowWithInitialSize

windowReshowWithInitialSize Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m ()

Deprecated: (Since version 3.10)GUI builders can call widgetHide, widgetUnrealize and then widgetShow on window themselves, if they still need this functionality.

Hides window, then reshows it, resetting the default size and position of the window. Used by GUI builders only.

resize

windowResize Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Int32	`width`: width in pixels to resize the window to
-> Int32	`height`: height in pixels to resize the window to
-> m ()

Resizes the window as if the user had done so, obeying geometry constraints. The default geometry constraint is that windows may not be smaller than their size request; to override this constraint, call widgetSetSizeRequest to set the window's request to a smaller value.

If windowResize is called before showing a window for the first time, it overrides any default size set with windowSetDefaultSize.

Windows may not be resized smaller than 1 by 1 pixels.

When using client side decorations, GTK+ will do its best to adjust the given size so that the resulting window size matches the requested size without the title bar, borders and shadows added for the client side decorations, but there is no guarantee that the result will be totally accurate because these widgets added for client side decorations depend on the theme and may not be realized or visible at the time windowResize is issued.

If the GtkWindow has a titlebar widget (see windowSetTitlebar), then typically, windowResize will compensate for the height of the titlebar widget only if the height is known when the resulting GtkWindow configuration is issued. For example, if new widgets are added after the GtkWindow configuration and cause the titlebar widget to grow in height, this will result in a window content smaller that specified by windowResize and not a larger window.

resizeGripIsVisible

windowResizeGripIsVisible Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m Bool	Returns: `True` if a resize grip exists and is visible

Deprecated: (Since version 3.14)Resize grips have been removed.

Determines whether a resize grip is visible for the specified window.

Since: 3.0

resizeToGeometry

windowResizeToGeometry Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Int32	`width`: width in resize increments to resize the window to
-> Int32	`height`: height in resize increments to resize the window to
-> m ()

Deprecated: (Since version 3.20)This function does nothing. Use windowResize and compute the geometry yourself.

Like windowResize, but width and height are interpreted in terms of the base size and increment set with gtk_window_set_geometry_hints.

Since: 3.0

setAcceptFocus

windowSetAcceptFocus Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Bool	`setting`: `True` to let this window receive input focus
-> m ()

Windows may set a hint asking the desktop environment not to receive the input focus. This function sets this hint.

Since: 2.4

setApplication

windowSetApplication Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a, IsApplication b)
=> a	`window`: a `Window`
-> Maybe b	`application`: a `Application`, or `Nothing` to unset
-> m ()

Sets or unsets the Application associated with the window.

The application will be kept alive for at least as long as it has any windows associated with it (see applicationHold for a way to keep it alive without windows).

Normally, the connection between the application and the window will remain until the window is destroyed, but you can explicitly remove it by setting the application to Nothing.

This is equivalent to calling applicationRemoveWindow and/or applicationAddWindow on the old/new applications as relevant.

Since: 3.0

setAttachedTo

windowSetAttachedTo Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a, IsWidget b)
=> a	`window`: a `Window`
-> Maybe b	`attachWidget`: a `Widget`, or `Nothing`
-> m ()

Marks window as attached to attachWidget. This creates a logical binding between the window and the widget it belongs to, which is used by GTK+ to propagate information such as styling or accessibility to window as if it was a children of attachWidget.

Examples of places where specifying this relation is useful are for instance a Menu created by a ComboBox, a completion popup window created by Entry or a typeahead search entry created by TreeView.

Note that this function should not be confused with windowSetTransientFor, which specifies a window manager relation between two toplevels instead.

Passing Nothing for attachWidget detaches the window.

Since: 3.4

setAutoStartupNotification

windowSetAutoStartupNotification Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Bool	`setting`: `True` to automatically do startup notification
-> m ()

By default, after showing the first Window, GTK+ calls notifyStartupComplete. Call this function to disable the automatic startup notification. You might do this if your first window is a splash screen, and you want to delay notification until after your real main window has been shown, for example.

In that example, you would disable startup notification temporarily, show your splash screen, then re-enable it so that showing the main window would automatically result in notification.

Since: 2.2

setDecorated

windowSetDecorated Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Bool	`setting`: `True` to decorate the window
-> m ()

By default, windows are decorated with a title bar, resize controls, etc. Some [window managers][gtk-X11-arch] allow GTK+ to disable these decorations, creating a borderless window. If you set the decorated property to False using this function, GTK+ will do its best to convince the window manager not to decorate the window. Depending on the system, this function may not have any effect when called on a window that is already visible, so you should call it before calling widgetShow.

On Windows, this function always works, since there’s no window manager policy involved.

setDefault

windowSetDefault Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a, IsWidget b)
=> a	`window`: a `Window`
-> Maybe b	`defaultWidget`: widget to be the default, or `Nothing` to unset the default widget for the toplevel
-> m ()

The default widget is the widget that’s activated when the user presses Enter in a dialog (for example). This function sets or unsets the default widget for a Window. When setting (rather than unsetting) the default widget it’s generally easier to call widgetGrabDefault on the widget. Before making a widget the default widget, you must call widgetSetCanDefault on the widget you’d like to make the default.

setDefaultGeometry

windowSetDefaultGeometry Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Int32	`width`: width in resize increments, or -1 to unset the default width
-> Int32	`height`: height in resize increments, or -1 to unset the default height
-> m ()

Deprecated: (Since version 3.20)This function does nothing. If you want to set a default size, use windowSetDefaultSize instead.

Like windowSetDefaultSize, but width and height are interpreted in terms of the base size and increment set with gtk_window_set_geometry_hints.

Since: 3.0

setDefaultIcon

windowSetDefaultIcon Source #

Arguments

:: (HasCallStack, MonadIO m, IsPixbuf a)
=> a	`icon`: the icon
-> m ()

Sets an icon to be used as fallback for windows that haven't had windowSetIcon called on them from a pixbuf.

Since: 2.4

setDefaultIconFromFile

windowSetDefaultIconFromFile Source #

Arguments

:: (HasCallStack, MonadIO m)
=> [Char]	`filename`: location of icon file
-> m ()	(Can throw `GError`)

Sets an icon to be used as fallback for windows that haven't had windowSetIconList called on them from a file on disk. Warns on failure if err is Nothing.

Since: 2.2

setDefaultIconList

windowSetDefaultIconList Source #

Arguments

:: (HasCallStack, MonadIO m, IsPixbuf a)
=> [a]	`list`: a list of `Pixbuf`
-> m ()

Sets an icon list to be used as fallback for windows that haven't had windowSetIconList called on them to set up a window-specific icon list. This function allows you to set up the icon for all windows in your app at once.

See windowSetIconList for more details.

setDefaultIconName

windowSetDefaultIconName Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Text	`name`: the name of the themed icon
-> m ()

Sets an icon to be used as fallback for windows that haven't had windowSetIconList called on them from a named themed icon, see windowSetIconName.

Since: 2.6

setDefaultSize

windowSetDefaultSize Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Int32	`width`: width in pixels, or -1 to unset the default width
-> Int32	`height`: height in pixels, or -1 to unset the default height
-> m ()

Sets the default size of a window. If the window’s “natural” size (its size request) is larger than the default, the default will be ignored. More generally, if the default size does not obey the geometry hints for the window (windowSetGeometryHints can be used to set these explicitly), the default size will be clamped to the nearest permitted size.

Unlike widgetSetSizeRequest, which sets a size request for a widget and thus would keep users from shrinking the window, this function only sets the initial size, just as if the user had resized the window themselves. Users can still shrink the window again as they normally would. Setting a default size of -1 means to use the “natural” default size (the size request of the window).

For more control over a window’s initial size and how resizing works, investigate windowSetGeometryHints.

For some uses, windowResize is a more appropriate function. windowResize changes the current size of the window, rather than the size to be used on initial display. windowResize always affects the window itself, not the geometry widget.

The default size of a window only affects the first time a window is shown; if a window is hidden and re-shown, it will remember the size it had prior to hiding, rather than using the default size.

Windows can’t actually be 0x0 in size, they must be at least 1x1, but passing 0 for width and height is OK, resulting in a 1x1 default size.

If you use this function to reestablish a previously saved window size, note that the appropriate size to save is the one returned by windowGetSize. Using the window allocation directly will not work in all circumstances and can lead to growing or shrinking windows.

setDeletable

windowSetDeletable Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Bool	`setting`: `True` to decorate the window as deletable
-> m ()

By default, windows have a close button in the window frame. Some [window managers][gtk-X11-arch] allow GTK+ to disable this button. If you set the deletable property to False using this function, GTK+ will do its best to convince the window manager not to show a close button. Depending on the system, this function may not have any effect when called on a window that is already visible, so you should call it before calling widgetShow.

On Windows, this function always works, since there’s no window manager policy involved.

Since: 2.10

setDestroyWithParent

windowSetDestroyWithParent Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Bool	`setting`: whether to destroy `window` with its transient parent
-> m ()

If setting is True, then destroying the transient parent of window will also destroy window itself. This is useful for dialogs that shouldn’t persist beyond the lifetime of the main window they're associated with, for example.

setFocus

windowSetFocus Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a, IsWidget b)
=> a	`window`: a `Window`
-> Maybe b	`focus`: widget to be the new focus widget, or `Nothing` to unset any focus widget for the toplevel window.
-> m ()

If focus is not the current focus widget, and is focusable, sets it as the focus widget for the window. If focus is Nothing, unsets the focus widget for this window. To set the focus to a particular widget in the toplevel, it is usually more convenient to use widgetGrabFocus instead of this function.

setFocusOnMap

windowSetFocusOnMap Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Bool	`setting`: `True` to let this window receive input focus on map
-> m ()

Windows may set a hint asking the desktop environment not to receive the input focus when the window is mapped. This function sets this hint.

Since: 2.6

setFocusVisible

windowSetFocusVisible Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Bool	`setting`: the new value
-> m ()

Sets the Window:focusVisible property.

Since: 3.2

setGeometryHints

windowSetGeometryHints Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a, IsWidget b)
=> a	`window`: a `Window`
-> Maybe b	`geometryWidget`: widget the geometry hints used to be applied to or `Nothing`. Since 3.20 this argument is ignored and GTK behaves as if `Nothing` was set.
-> Maybe Geometry	`geometry`: struct containing geometry information or `Nothing`
-> [WindowHints]	`geomMask`: mask indicating which struct fields should be paid attention to
-> m ()

This function sets up hints about how a window can be resized by the user. You can set a minimum and maximum size; allowed resize increments (e.g. for xterm, you can only resize by the size of a character); aspect ratios; and more. See the Geometry struct.

setGravity

windowSetGravity Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Gravity	`gravity`: window gravity
-> m ()

Window gravity defines the meaning of coordinates passed to windowMove. See windowMove and Gravity for more details.

The default window gravity is GDK_GRAVITY_NORTH_WEST which will typically “do what you mean.”

setHasResizeGrip

windowSetHasResizeGrip Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Bool	`value`: `True` to allow a resize grip
-> m ()

Deprecated: (Since version 3.14)Resize grips have been removed.

Sets whether window has a corner resize grip.

Note that the resize grip is only shown if the window is actually resizable and not maximized. Use windowResizeGripIsVisible to find out if the resize grip is currently shown.

Since: 3.0

setHasUserRefCount

windowSetHasUserRefCount Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Bool	`setting`: the new value
-> m ()

Tells GTK+ whether to drop its extra reference to the window when widgetDestroy is called.

This function is only exported for the benefit of language bindings which may need to keep the window alive until their wrapper object is garbage collected. There is no justification for ever calling this function in an application.

Since: 3.0

setHideTitlebarWhenMaximized

windowSetHideTitlebarWhenMaximized Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Bool	`setting`: whether to hide the titlebar when `window` is maximized
-> m ()

If setting is True, then window will request that it’s titlebar should be hidden when maximized. This is useful for windows that don’t convey any information other than the application name in the titlebar, to put the available screen space to better use. If the underlying window system does not support the request, the setting will not have any effect.

Note that custom titlebars set with windowSetTitlebar are not affected by this. The application is in full control of their content and visibility anyway.

Since: 3.4

setIcon

windowSetIcon Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a, IsPixbuf b)
=> a	`window`: a `Window`
-> Maybe b	`icon`: icon image, or `Nothing`
-> m ()

Sets up the icon representing a Window. This icon is used when the window is minimized (also known as iconified). Some window managers or desktop environments may also place it in the window frame, or display it in other contexts. On others, the icon is not used at all, so your mileage may vary.

The icon should be provided in whatever size it was naturally drawn; that is, don’t scale the image before passing it to GTK+. Scaling is postponed until the last minute, when the desired final size is known, to allow best quality.

If you have your icon hand-drawn in multiple sizes, use windowSetIconList. Then the best size will be used.

This function is equivalent to calling windowSetIconList with a 1-element list.

See also windowSetDefaultIconList to set the icon for all windows in your application in one go.

setIconFromFile

windowSetIconFromFile Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> [Char]	`filename`: location of icon file
-> m ()	(Can throw `GError`)

Sets the icon for window. Warns on failure if err is Nothing.

This function is equivalent to calling windowSetIcon with a pixbuf created by loading the image from filename.

Since: 2.2

setIconList

windowSetIconList Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a, IsPixbuf b)
=> a	`window`: a `Window`
-> [b]	`list`: list of `Pixbuf`
-> m ()

Sets up the icon representing a Window. The icon is used when the window is minimized (also known as iconified). Some window managers or desktop environments may also place it in the window frame, or display it in other contexts. On others, the icon is not used at all, so your mileage may vary.

windowSetIconList allows you to pass in the same icon in several hand-drawn sizes. The list should contain the natural sizes your icon is available in; that is, don’t scale the image before passing it to GTK+. Scaling is postponed until the last minute, when the desired final size is known, to allow best quality.

By passing several sizes, you may improve the final image quality of the icon, by reducing or eliminating automatic image scaling.

Recommended sizes to provide: 16x16, 32x32, 48x48 at minimum, and larger images (64x64, 128x128) if you have them.

See also windowSetDefaultIconList to set the icon for all windows in your application in one go.

Note that transient windows (those who have been set transient for another window using windowSetTransientFor) will inherit their icon from their transient parent. So there’s no need to explicitly set the icon on transient windows.

setIconName

windowSetIconName Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Maybe Text	`name`: the name of the themed icon
-> m ()

Sets the icon for the window from a named themed icon. See the docs for IconTheme for more details. On some platforms, the window icon is not used at all.

Note that this has nothing to do with the WM_ICON_NAME property which is mentioned in the ICCCM.

Since: 2.6

setInteractiveDebugging

windowSetInteractiveDebugging Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Bool	`enable`: `True` to enable interactive debugging
-> m ()

Opens or closes the [interactive debugger][interactive-debugging], which offers access to the widget hierarchy of the application and to useful debugging tools.

Since: 3.14

setKeepAbove

windowSetKeepAbove Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Bool	`setting`: whether to keep `window` above other windows
-> m ()

Asks to keep window above, so that it stays on top. Note that you shouldn’t assume the window is definitely above afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could not keep it above, and not all window managers support keeping windows above. But normally the window will end kept above. Just don’t write code that crashes if not.

It’s permitted to call this function before showing a window, in which case the window will be kept above when it appears onscreen initially.

You can track the above state via the “window-state-event” signal on Widget.

Note that, according to the Extended Window Manager Hints Specification, the above state is mainly meant for user preferences and should not be used by applications e.g. for drawing attention to their dialogs.

Since: 2.4

setKeepBelow

windowSetKeepBelow Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Bool	`setting`: whether to keep `window` below other windows
-> m ()

Asks to keep window below, so that it stays in bottom. Note that you shouldn’t assume the window is definitely below afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could not keep it below, and not all window managers support putting windows below. But normally the window will be kept below. Just don’t write code that crashes if not.

It’s permitted to call this function before showing a window, in which case the window will be kept below when it appears onscreen initially.

You can track the below state via the “window-state-event” signal on Widget.

Note that, according to the Extended Window Manager Hints Specification, the above state is mainly meant for user preferences and should not be used by applications e.g. for drawing attention to their dialogs.

Since: 2.4

setMnemonicModifier

windowSetMnemonicModifier Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> [ModifierType]	`modifier`: the modifier mask used to activate mnemonics on this window.
-> m ()

Sets the mnemonic modifier for this window.

setMnemonicsVisible

windowSetMnemonicsVisible Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Bool	`setting`: the new value
-> m ()

Sets the Window:mnemonicsVisible property.

Since: 2.20

setModal

windowSetModal Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Bool	`modal`: whether the window is modal
-> m ()

Sets a window modal or non-modal. Modal windows prevent interaction with other windows in the same application. To keep modal dialogs on top of main application windows, use windowSetTransientFor to make the dialog transient for the parent; most [window managers][gtk-X11-arch] will then disallow lowering the dialog below the parent.

setOpacity

windowSetOpacity Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Double	`opacity`: desired opacity, between 0 and 1
-> m ()

Deprecated: (Since version 3.8)Use gtk_widget_set_opacity instead.

Request the windowing system to make window partially transparent, with opacity 0 being fully transparent and 1 fully opaque. (Values of the opacity parameter are clamped to the [0,1] range.) On X11 this has any effect only on X screens with a compositing manager running. See widgetIsComposited. On Windows it should work always.

Note that setting a window’s opacity after the window has been shown causes it to flicker once on Windows.

Since: 2.12

setPosition

windowSetPosition Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`.
-> WindowPosition	`position`: a position constraint.
-> m ()

Sets a position constraint for this window. If the old or new constraint is WindowPositionCenterAlways, this will also cause the window to be repositioned to satisfy the new constraint.

setResizable

windowSetResizable Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Bool	`resizable`: `True` if the user can resize this window
-> m ()

Sets whether the user can resize a window. Windows are user resizable by default.

setRole

windowSetRole Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Text	`role`: unique identifier for the window to be used when restoring a session
-> m ()

This function is only useful on X11, not with other GTK+ targets.

In combination with the window title, the window role allows a [window manager][gtk-X11-arch] to identify "the same" window when an application is restarted. So for example you might set the “toolbox” role on your app’s toolbox window, so that when the user restarts their session, the window manager can put the toolbox back in the same place.

If a window already has a unique title, you don’t need to set the role, since the WM can use the title to identify the window when restoring the session.

setScreen

windowSetScreen Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a, IsScreen b)
=> a	`window`: a `Window`.
-> b	`screen`: a `Screen`.
-> m ()

Sets the Screen where the window is displayed; if the window is already mapped, it will be unmapped, and then remapped on the new screen.

Since: 2.2

setSkipPagerHint

windowSetSkipPagerHint Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Bool	`setting`: `True` to keep this window from appearing in the pager
-> m ()

Windows may set a hint asking the desktop environment not to display the window in the pager. This function sets this hint. (A "pager" is any desktop navigation tool such as a workspace switcher that displays a thumbnail representation of the windows on the screen.)

Since: 2.2

setSkipTaskbarHint

windowSetSkipTaskbarHint Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Bool	`setting`: `True` to keep this window from appearing in the task bar
-> m ()

Windows may set a hint asking the desktop environment not to display the window in the task bar. This function sets this hint.

Since: 2.2

setStartupId

windowSetStartupId Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Text	`startupId`: a string with startup-notification identifier
-> m ()

Startup notification identifiers are used by desktop environment to track application startup, to provide user feedback and other features. This function changes the corresponding property on the underlying GdkWindow. Normally, startup identifier is managed automatically and you should only use this function in special cases like transferring focus from other processes. You should use this function before calling windowPresent or any equivalent function generating a window map event.

This function is only useful on X11, not with other GTK+ targets.

Since: 2.12

setTitle

windowSetTitle Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Text	`title`: title of the window
-> m ()

Sets the title of the Window. The title of a window will be displayed in its title bar; on the X Window System, the title bar is rendered by the [window manager][gtk-X11-arch], so exactly how the title appears to users may vary according to a user’s exact configuration. The title should help a user distinguish this window from other windows they may have open. A good title might include the application name and current document filename, for example.

setTitlebar

windowSetTitlebar Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a, IsWidget b)
=> a	`window`: a `Window`
-> Maybe b	`titlebar`: the widget to use as titlebar
-> m ()

Sets a custom titlebar for window.

A typical widget used here is HeaderBar, as it provides various features expected of a titlebar while allowing the addition of child widgets to it.

If you set a custom titlebar, GTK+ will do its best to convince the window manager not to put its own titlebar on the window. Depending on the system, this function may not work for a window that is already visible, so you set the titlebar before calling widgetShow.

Since: 3.10

setTransientFor

windowSetTransientFor Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a, IsWindow b)
=> a	`window`: a `Window`
-> Maybe b	`parent`: parent window, or `Nothing`
-> m ()

Dialog windows should be set transient for the main application window they were spawned from. This allows [window managers][gtk-X11-arch] to e.g. keep the dialog on top of the main window, or center the dialog over the main window. gtk_dialog_new_with_buttons() and other convenience functions in GTK+ will sometimes call windowSetTransientFor on your behalf.

Passing Nothing for parent unsets the current transient window.

On Wayland, this function can also be used to attach a new GTK_WINDOW_POPUP to a GTK_WINDOW_TOPLEVEL parent already mapped on screen so that the GTK_WINDOW_POPUP will be created as a subsurface-based window GDK_WINDOW_SUBSURFACE which can be positioned at will relatively to the GTK_WINDOW_TOPLEVEL surface.

On Windows, this function puts the child window on top of the parent, much as the window manager would have done on X.

setTypeHint

windowSetTypeHint Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> WindowTypeHint	`hint`: the window type
-> m ()

By setting the type hint for the window, you allow the window manager to decorate and handle the window in a way which is suitable to the function of the window in your application.

This function should be called before the window becomes visible.

gtk_dialog_new_with_buttons() and other convenience functions in GTK+ will sometimes call windowSetTypeHint on your behalf.

setUrgencyHint

windowSetUrgencyHint Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Bool	`setting`: `True` to mark this window as urgent
-> m ()

Windows may set a hint asking the desktop environment to draw the users attention to the window. This function sets this hint.

Since: 2.8

setWmclass

windowSetWmclass Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> Text	`wmclassName`: window name hint
-> Text	`wmclassClass`: window class hint
-> m ()

Deprecated: (Since version 3.22)

Don’t use this function. It sets the X Window System “class” and “name” hints for a window. According to the ICCCM, you should always set these to the same value for all windows in an application, and GTK+ sets them to that value by default, so calling this function is sort of pointless. However, you may want to call windowSetRole on each window in your application, for the benefit of the session manager. Setting the role allows the window manager to restore window positions when loading a saved session.

stick

windowStick Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m ()

Asks to stick window, which means that it will appear on all user desktops. Note that you shouldn’t assume the window is definitely stuck afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch] could unstick it again, and some window managers do not support sticking windows. But normally the window will end up stuck. Just don't write code that crashes if not.

It’s permitted to call this function before showing a window.

You can track stickiness via the “window-state-event” signal on Widget.

unfullscreen

windowUnfullscreen Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m ()

Asks to toggle off the fullscreen state for window. Note that you shouldn’t assume the window is definitely not full screen afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could fullscreen it again, and not all window managers honor requests to unfullscreen windows. But normally the window will end up restored to its normal state. Just don’t write code that crashes if not.

You can track the fullscreen state via the “window-state-event” signal on Widget.

Since: 2.2

unmaximize

windowUnmaximize Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m ()

Asks to unmaximize window. Note that you shouldn’t assume the window is definitely unmaximized afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could maximize it again, and not all window managers honor requests to unmaximize. But normally the window will end up unmaximized. Just don’t write code that crashes if not.

You can track maximization via the “window-state-event” signal on Widget.

unstick

windowUnstick Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a)
=> a	`window`: a `Window`
-> m ()

Asks to unstick window, which means that it will appear on only one of the user’s desktops. Note that you shouldn’t assume the window is definitely unstuck afterward, because other entities (e.g. the user or [window manager][gtk-X11-arch]) could stick it again. But normally the window will end up unstuck. Just don’t write code that crashes if not.

You can track stickiness via the “window-state-event” signal on Widget.

Properties

acceptFocus

Whether the window should receive the input focus.

Since: 2.4

constructWindowAcceptFocus :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “accept-focus” property. This is rarely needed directly, but it is used by new.

getWindowAcceptFocus :: (MonadIO m, IsWindow o) => o -> m Bool Source #

Get the value of the “accept-focus” property. When overloading is enabled, this is equivalent to

get window #acceptFocus

setWindowAcceptFocus :: (MonadIO m, IsWindow o) => o -> Bool -> m () Source #

Set the value of the “accept-focus” property. When overloading is enabled, this is equivalent to

set window [ #acceptFocus := value ]

application

The Application associated with the window.

The application will be kept alive for at least as long as it has any windows associated with it (see applicationHold for a way to keep it alive without windows).

Normally, the connection between the application and the window will remain until the window is destroyed, but you can explicitly remove it by setting the :application property to Nothing.

Since: 3.0

clearWindowApplication :: (MonadIO m, IsWindow o) => o -> m () Source #

Set the value of the “application” property to Nothing. When overloading is enabled, this is equivalent to

clear #application

constructWindowApplication :: (IsWindow o, MonadIO m, IsApplication a) => a -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “application” property. This is rarely needed directly, but it is used by new.

getWindowApplication :: (MonadIO m, IsWindow o) => o -> m (Maybe Application) Source #

Get the value of the “application” property. When overloading is enabled, this is equivalent to

get window #application

setWindowApplication :: (MonadIO m, IsWindow o, IsApplication a) => o -> a -> m () Source #

Set the value of the “application” property. When overloading is enabled, this is equivalent to

set window [ #application := value ]

attachedTo

The widget to which this window is attached. See windowSetAttachedTo.

Examples of places where specifying this relation is useful are for instance a Menu created by a ComboBox, a completion popup window created by Entry or a typeahead search entry created by TreeView.

Since: 3.4

clearWindowAttachedTo :: (MonadIO m, IsWindow o) => o -> m () Source #

Set the value of the “attached-to” property to Nothing. When overloading is enabled, this is equivalent to

clear #attachedTo

constructWindowAttachedTo :: (IsWindow o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “attached-to” property. This is rarely needed directly, but it is used by new.

getWindowAttachedTo :: (MonadIO m, IsWindow o) => o -> m (Maybe Widget) Source #

Get the value of the “attached-to” property. When overloading is enabled, this is equivalent to

get window #attachedTo

setWindowAttachedTo :: (MonadIO m, IsWindow o, IsWidget a) => o -> a -> m () Source #

Set the value of the “attached-to” property. When overloading is enabled, this is equivalent to

set window [ #attachedTo := value ]

decorated

Whether the window should be decorated by the window manager.

Since: 2.4

constructWindowDecorated :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “decorated” property. This is rarely needed directly, but it is used by new.

getWindowDecorated :: (MonadIO m, IsWindow o) => o -> m Bool Source #

Get the value of the “decorated” property. When overloading is enabled, this is equivalent to

get window #decorated

setWindowDecorated :: (MonadIO m, IsWindow o) => o -> Bool -> m () Source #

Set the value of the “decorated” property. When overloading is enabled, this is equivalent to

set window [ #decorated := value ]

defaultHeight

No description available in the introspection data.

constructWindowDefaultHeight :: (IsWindow o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “default-height” property. This is rarely needed directly, but it is used by new.

getWindowDefaultHeight :: (MonadIO m, IsWindow o) => o -> m Int32 Source #

Get the value of the “default-height” property. When overloading is enabled, this is equivalent to

get window #defaultHeight

setWindowDefaultHeight :: (MonadIO m, IsWindow o) => o -> Int32 -> m () Source #

Set the value of the “default-height” property. When overloading is enabled, this is equivalent to

set window [ #defaultHeight := value ]

defaultWidth

No description available in the introspection data.

constructWindowDefaultWidth :: (IsWindow o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “default-width” property. This is rarely needed directly, but it is used by new.

getWindowDefaultWidth :: (MonadIO m, IsWindow o) => o -> m Int32 Source #

Get the value of the “default-width” property. When overloading is enabled, this is equivalent to

get window #defaultWidth

setWindowDefaultWidth :: (MonadIO m, IsWindow o) => o -> Int32 -> m () Source #

Set the value of the “default-width” property. When overloading is enabled, this is equivalent to

set window [ #defaultWidth := value ]

deletable

Whether the window frame should have a close button.

Since: 2.10

constructWindowDeletable :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “deletable” property. This is rarely needed directly, but it is used by new.

getWindowDeletable :: (MonadIO m, IsWindow o) => o -> m Bool Source #

Get the value of the “deletable” property. When overloading is enabled, this is equivalent to

get window #deletable

setWindowDeletable :: (MonadIO m, IsWindow o) => o -> Bool -> m () Source #

Set the value of the “deletable” property. When overloading is enabled, this is equivalent to

set window [ #deletable := value ]

destroyWithParent

No description available in the introspection data.

constructWindowDestroyWithParent :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “destroy-with-parent” property. This is rarely needed directly, but it is used by new.

getWindowDestroyWithParent :: (MonadIO m, IsWindow o) => o -> m Bool Source #

Get the value of the “destroy-with-parent” property. When overloading is enabled, this is equivalent to

get window #destroyWithParent

setWindowDestroyWithParent :: (MonadIO m, IsWindow o) => o -> Bool -> m () Source #

Set the value of the “destroy-with-parent” property. When overloading is enabled, this is equivalent to

set window [ #destroyWithParent := value ]

focusOnMap

Whether the window should receive the input focus when mapped.

Since: 2.6

constructWindowFocusOnMap :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “focus-on-map” property. This is rarely needed directly, but it is used by new.

getWindowFocusOnMap :: (MonadIO m, IsWindow o) => o -> m Bool Source #

Get the value of the “focus-on-map” property. When overloading is enabled, this is equivalent to

get window #focusOnMap

setWindowFocusOnMap :: (MonadIO m, IsWindow o) => o -> Bool -> m () Source #

Set the value of the “focus-on-map” property. When overloading is enabled, this is equivalent to

set window [ #focusOnMap := value ]

focusVisible

Whether 'focus rectangles' are currently visible in this window.

This property is maintained by GTK+ based on user input and should not be set by applications.

Since: 2.20

constructWindowFocusVisible :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “focus-visible” property. This is rarely needed directly, but it is used by new.

getWindowFocusVisible :: (MonadIO m, IsWindow o) => o -> m Bool Source #

Get the value of the “focus-visible” property. When overloading is enabled, this is equivalent to

get window #focusVisible

setWindowFocusVisible :: (MonadIO m, IsWindow o) => o -> Bool -> m () Source #

Set the value of the “focus-visible” property. When overloading is enabled, this is equivalent to

set window [ #focusVisible := value ]

gravity

The window gravity of the window. See windowMove and Gravity for more details about window gravity.

Since: 2.4

constructWindowGravity :: (IsWindow o, MonadIO m) => Gravity -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “gravity” property. This is rarely needed directly, but it is used by new.

getWindowGravity :: (MonadIO m, IsWindow o) => o -> m Gravity Source #

Get the value of the “gravity” property. When overloading is enabled, this is equivalent to

get window #gravity

setWindowGravity :: (MonadIO m, IsWindow o) => o -> Gravity -> m () Source #

Set the value of the “gravity” property. When overloading is enabled, this is equivalent to

set window [ #gravity := value ]

hasResizeGrip

Whether the window has a corner resize grip.

Note that the resize grip is only shown if the window is actually resizable and not maximized. Use Window:resizeGripVisible to find out if the resize grip is currently shown.

Since: 3.0

constructWindowHasResizeGrip :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “has-resize-grip” property. This is rarely needed directly, but it is used by new.

getWindowHasResizeGrip :: (MonadIO m, IsWindow o) => o -> m Bool Source #

Get the value of the “has-resize-grip” property. When overloading is enabled, this is equivalent to

get window #hasResizeGrip

setWindowHasResizeGrip :: (MonadIO m, IsWindow o) => o -> Bool -> m () Source #

Set the value of the “has-resize-grip” property. When overloading is enabled, this is equivalent to

set window [ #hasResizeGrip := value ]

hasToplevelFocus

No description available in the introspection data.

getWindowHasToplevelFocus :: (MonadIO m, IsWindow o) => o -> m Bool Source #

Get the value of the “has-toplevel-focus” property. When overloading is enabled, this is equivalent to

get window #hasToplevelFocus

hideTitlebarWhenMaximized

Whether the titlebar should be hidden during maximization.

Since: 3.4

constructWindowHideTitlebarWhenMaximized :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “hide-titlebar-when-maximized” property. This is rarely needed directly, but it is used by new.

getWindowHideTitlebarWhenMaximized :: (MonadIO m, IsWindow o) => o -> m Bool Source #

Get the value of the “hide-titlebar-when-maximized” property. When overloading is enabled, this is equivalent to

get window #hideTitlebarWhenMaximized

setWindowHideTitlebarWhenMaximized :: (MonadIO m, IsWindow o) => o -> Bool -> m () Source #

Set the value of the “hide-titlebar-when-maximized” property. When overloading is enabled, this is equivalent to

set window [ #hideTitlebarWhenMaximized := value ]

icon

No description available in the introspection data.

clearWindowIcon :: (MonadIO m, IsWindow o) => o -> m () Source #

Set the value of the “icon” property to Nothing. When overloading is enabled, this is equivalent to

clear #icon

constructWindowIcon :: (IsWindow o, MonadIO m, IsPixbuf a) => a -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “icon” property. This is rarely needed directly, but it is used by new.

getWindowIcon :: (MonadIO m, IsWindow o) => o -> m (Maybe Pixbuf) Source #

Get the value of the “icon” property. When overloading is enabled, this is equivalent to

get window #icon

setWindowIcon :: (MonadIO m, IsWindow o, IsPixbuf a) => o -> a -> m () Source #

Set the value of the “icon” property. When overloading is enabled, this is equivalent to

set window [ #icon := value ]

iconName

The :icon-name property specifies the name of the themed icon to use as the window icon. See IconTheme for more details.

Since: 2.6

clearWindowIconName :: (MonadIO m, IsWindow o) => o -> m () Source #

Set the value of the “icon-name” property to Nothing. When overloading is enabled, this is equivalent to

clear #iconName

constructWindowIconName :: (IsWindow o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “icon-name” property. This is rarely needed directly, but it is used by new.

getWindowIconName :: (MonadIO m, IsWindow o) => o -> m (Maybe Text) Source #

Get the value of the “icon-name” property. When overloading is enabled, this is equivalent to

get window #iconName

setWindowIconName :: (MonadIO m, IsWindow o) => o -> Text -> m () Source #

Set the value of the “icon-name” property. When overloading is enabled, this is equivalent to

set window [ #iconName := value ]

isActive

No description available in the introspection data.

getWindowIsActive :: (MonadIO m, IsWindow o) => o -> m Bool Source #

Get the value of the “is-active” property. When overloading is enabled, this is equivalent to

get window #isActive

isMaximized

No description available in the introspection data.

getWindowIsMaximized :: (MonadIO m, IsWindow o) => o -> m Bool Source #

Get the value of the “is-maximized” property. When overloading is enabled, this is equivalent to

get window #isMaximized

mnemonicsVisible

Whether mnemonics are currently visible in this window.

This property is maintained by GTK+ based on user input, and should not be set by applications.

Since: 2.20

constructWindowMnemonicsVisible :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “mnemonics-visible” property. This is rarely needed directly, but it is used by new.

getWindowMnemonicsVisible :: (MonadIO m, IsWindow o) => o -> m Bool Source #

Get the value of the “mnemonics-visible” property. When overloading is enabled, this is equivalent to

get window #mnemonicsVisible

setWindowMnemonicsVisible :: (MonadIO m, IsWindow o) => o -> Bool -> m () Source #

Set the value of the “mnemonics-visible” property. When overloading is enabled, this is equivalent to

set window [ #mnemonicsVisible := value ]

No description available in the introspection data.

constructWindowModal :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “modal” property. This is rarely needed directly, but it is used by new.

getWindowModal :: (MonadIO m, IsWindow o) => o -> m Bool Source #

Get the value of the “modal” property. When overloading is enabled, this is equivalent to

get window #modal

setWindowModal :: (MonadIO m, IsWindow o) => o -> Bool -> m () Source #

Set the value of the “modal” property. When overloading is enabled, this is equivalent to

set window [ #modal := value ]

resizable

No description available in the introspection data.

constructWindowResizable :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “resizable” property. This is rarely needed directly, but it is used by new.

getWindowResizable :: (MonadIO m, IsWindow o) => o -> m Bool Source #

Get the value of the “resizable” property. When overloading is enabled, this is equivalent to

get window #resizable

setWindowResizable :: (MonadIO m, IsWindow o) => o -> Bool -> m () Source #

Set the value of the “resizable” property. When overloading is enabled, this is equivalent to

set window [ #resizable := value ]

resizeGripVisible

Whether a corner resize grip is currently shown.

Since: 3.0

getWindowResizeGripVisible :: (MonadIO m, IsWindow o) => o -> m Bool Source #

Get the value of the “resize-grip-visible” property. When overloading is enabled, this is equivalent to

get window #resizeGripVisible

role

No description available in the introspection data.

constructWindowRole :: (IsWindow o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “role” property. This is rarely needed directly, but it is used by new.

getWindowRole :: (MonadIO m, IsWindow o) => o -> m (Maybe Text) Source #

Get the value of the “role” property. When overloading is enabled, this is equivalent to

get window #role

setWindowRole :: (MonadIO m, IsWindow o) => o -> Text -> m () Source #

Set the value of the “role” property. When overloading is enabled, this is equivalent to

set window [ #role := value ]

screen

No description available in the introspection data.

constructWindowScreen :: (IsWindow o, MonadIO m, IsScreen a) => a -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “screen” property. This is rarely needed directly, but it is used by new.

getWindowScreen :: (MonadIO m, IsWindow o) => o -> m Screen Source #

Get the value of the “screen” property. When overloading is enabled, this is equivalent to

get window #screen

setWindowScreen :: (MonadIO m, IsWindow o, IsScreen a) => o -> a -> m () Source #

Set the value of the “screen” property. When overloading is enabled, this is equivalent to

set window [ #screen := value ]

skipPagerHint

No description available in the introspection data.

constructWindowSkipPagerHint :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “skip-pager-hint” property. This is rarely needed directly, but it is used by new.

getWindowSkipPagerHint :: (MonadIO m, IsWindow o) => o -> m Bool Source #

Get the value of the “skip-pager-hint” property. When overloading is enabled, this is equivalent to

get window #skipPagerHint

setWindowSkipPagerHint :: (MonadIO m, IsWindow o) => o -> Bool -> m () Source #

Set the value of the “skip-pager-hint” property. When overloading is enabled, this is equivalent to

set window [ #skipPagerHint := value ]

skipTaskbarHint

No description available in the introspection data.

constructWindowSkipTaskbarHint :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “skip-taskbar-hint” property. This is rarely needed directly, but it is used by new.

getWindowSkipTaskbarHint :: (MonadIO m, IsWindow o) => o -> m Bool Source #

Get the value of the “skip-taskbar-hint” property. When overloading is enabled, this is equivalent to

get window #skipTaskbarHint

setWindowSkipTaskbarHint :: (MonadIO m, IsWindow o) => o -> Bool -> m () Source #

Set the value of the “skip-taskbar-hint” property. When overloading is enabled, this is equivalent to

set window [ #skipTaskbarHint := value ]

startupId

The :startup-id is a write-only property for setting window's startup notification identifier. See windowSetStartupId for more details.

Since: 2.12

constructWindowStartupId :: (IsWindow o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “startup-id” property. This is rarely needed directly, but it is used by new.

setWindowStartupId :: (MonadIO m, IsWindow o) => o -> Text -> m () Source #

Set the value of the “startup-id” property. When overloading is enabled, this is equivalent to

set window [ #startupId := value ]

title

No description available in the introspection data.

constructWindowTitle :: (IsWindow o, MonadIO m) => Text -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “title” property. This is rarely needed directly, but it is used by new.

getWindowTitle :: (MonadIO m, IsWindow o) => o -> m (Maybe Text) Source #

Get the value of the “title” property. When overloading is enabled, this is equivalent to

get window #title

setWindowTitle :: (MonadIO m, IsWindow o) => o -> Text -> m () Source #

Set the value of the “title” property. When overloading is enabled, this is equivalent to

set window [ #title := value ]

transientFor

The transient parent of the window. See windowSetTransientFor for more details about transient windows.

Since: 2.10

clearWindowTransientFor :: (MonadIO m, IsWindow o) => o -> m () Source #

Set the value of the “transient-for” property to Nothing. When overloading is enabled, this is equivalent to

clear #transientFor

constructWindowTransientFor :: (IsWindow o, MonadIO m, IsWindow a) => a -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “transient-for” property. This is rarely needed directly, but it is used by new.

getWindowTransientFor :: (MonadIO m, IsWindow o) => o -> m (Maybe Window) Source #

Get the value of the “transient-for” property. When overloading is enabled, this is equivalent to

get window #transientFor

setWindowTransientFor :: (MonadIO m, IsWindow o, IsWindow a) => o -> a -> m () Source #

Set the value of the “transient-for” property. When overloading is enabled, this is equivalent to

set window [ #transientFor := value ]

type

No description available in the introspection data.

constructWindowType :: (IsWindow o, MonadIO m) => WindowType -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “type” property. This is rarely needed directly, but it is used by new.

getWindowType :: (MonadIO m, IsWindow o) => o -> m WindowType Source #

Get the value of the “type” property. When overloading is enabled, this is equivalent to

get window #type

typeHint

No description available in the introspection data.

constructWindowTypeHint :: (IsWindow o, MonadIO m) => WindowTypeHint -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “type-hint” property. This is rarely needed directly, but it is used by new.

getWindowTypeHint :: (MonadIO m, IsWindow o) => o -> m WindowTypeHint Source #

Get the value of the “type-hint” property. When overloading is enabled, this is equivalent to

get window #typeHint

setWindowTypeHint :: (MonadIO m, IsWindow o) => o -> WindowTypeHint -> m () Source #

Set the value of the “type-hint” property. When overloading is enabled, this is equivalent to

set window [ #typeHint := value ]

urgencyHint

No description available in the introspection data.

constructWindowUrgencyHint :: (IsWindow o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “urgency-hint” property. This is rarely needed directly, but it is used by new.

getWindowUrgencyHint :: (MonadIO m, IsWindow o) => o -> m Bool Source #

Get the value of the “urgency-hint” property. When overloading is enabled, this is equivalent to

get window #urgencyHint

setWindowUrgencyHint :: (MonadIO m, IsWindow o) => o -> Bool -> m () Source #

Set the value of the “urgency-hint” property. When overloading is enabled, this is equivalent to

set window [ #urgencyHint := value ]

windowPosition

No description available in the introspection data.

constructWindowWindowPosition :: (IsWindow o, MonadIO m) => WindowPosition -> m (GValueConstruct o) Source #

Construct a GValueConstruct with valid value for the “window-position” property. This is rarely needed directly, but it is used by new.

getWindowWindowPosition :: (MonadIO m, IsWindow o) => o -> m WindowPosition Source #

Get the value of the “window-position” property. When overloading is enabled, this is equivalent to

get window #windowPosition

setWindowWindowPosition :: (MonadIO m, IsWindow o) => o -> WindowPosition -> m () Source #

Set the value of the “window-position” property. When overloading is enabled, this is equivalent to

set window [ #windowPosition := value ]

Signals

activateDefault

type WindowActivateDefaultCallback = IO () Source #

The activateDefault signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user activates the default widget of window.

afterWindowActivateDefault :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowActivateDefaultCallback) -> m SignalHandlerId Source #

Connect a signal handler for the activateDefault signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after window #activateDefault callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWindowActivateDefault :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowActivateDefaultCallback) -> m SignalHandlerId Source #

Connect a signal handler for the activateDefault signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on window #activateDefault callback

activateFocus

type WindowActivateFocusCallback = IO () Source #

The activateFocus signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user activates the currently focused widget of window.

afterWindowActivateFocus :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowActivateFocusCallback) -> m SignalHandlerId Source #

Connect a signal handler for the activateFocus signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after window #activateFocus callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWindowActivateFocus :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowActivateFocusCallback) -> m SignalHandlerId Source #

Connect a signal handler for the activateFocus signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on window #activateFocus callback

enableDebugging

type WindowEnableDebuggingCallback Source #

Arguments

= Bool	`toggle`: toggle the debugger
-> IO Bool	Returns: `True` if the key binding was handled

The enableDebugging signal is a [keybinding signal][GtkBindingSignal] which gets emitted when the user enables or disables interactive debugging. When toggle is True, interactive debugging is toggled on or off, when it is False, the debugger will be pointed at the widget under the pointer.

The default bindings for this signal are Ctrl-Shift-I and Ctrl-Shift-D.

afterWindowEnableDebugging :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowEnableDebuggingCallback) -> m SignalHandlerId Source #

Connect a signal handler for the enableDebugging signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after window #enableDebugging callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWindowEnableDebugging :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowEnableDebuggingCallback) -> m SignalHandlerId Source #

Connect a signal handler for the enableDebugging signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on window #enableDebugging callback

keysChanged

type WindowKeysChangedCallback = IO () Source #

The keysChanged signal gets emitted when the set of accelerators or mnemonics that are associated with window changes.

afterWindowKeysChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowKeysChangedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the keysChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after window #keysChanged callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWindowKeysChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowKeysChangedCallback) -> m SignalHandlerId Source #

Connect a signal handler for the keysChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on window #keysChanged callback

setFocus

type WindowSetFocusCallback Source #

Arguments

= Maybe Widget	`widget`: the newly focused widget (or `Nothing` for no focus)
-> IO ()

This signal is emitted whenever the currently focused widget in this window changes.

Since: 2.24

afterWindowSetFocus :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowSetFocusCallback) -> m SignalHandlerId Source #

Connect a signal handler for the setFocus signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after window #setFocus callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWindowSetFocus :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowSetFocusCallback) -> m SignalHandlerId Source #

Connect a signal handler for the setFocus signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on window #setFocus callback

GtkWindow as GtkBuildable

xml code

CSS nodes

plain code

Exported types

Instances

Instances

Methods

Click to display all available methods, including inherited ones

Methods

Getters

Setters

activateDefault

activateFocus

activateKey

addAccelGroup

addMnemonic

beginMoveDrag

beginResizeDrag

close

deiconify

fullscreen

fullscreenOnMonitor

getAcceptFocus

getApplication

getAttachedTo

getDecorated

getDefaultIconList

getDefaultIconName

getDefaultSize

getDefaultWidget

getDeletable

getDestroyWithParent

getFocus

getFocusOnMap

getFocusVisible

getGravity

getGroup

getHasResizeGrip

getHideTitlebarWhenMaximized

getIcon

getIconList

getIconName

getMnemonicModifier

getMnemonicsVisible

getModal

getOpacity

getPosition

getResizable

getResizeGripArea

getRole

getScreen

getSize

C code

C code

getSkipPagerHint

getSkipTaskbarHint

getTitle

getTitlebar

getTransientFor

getTypeHint

getUrgencyHint

getWindowType

hasGroup

hasToplevelFocus

iconify

isActive

isMaximized

listToplevels

maximize

mnemonicActivate

move

new

parseGeometry

C code

present

presentWithTime

propagateKeyEvent

removeAccelGroup

removeMnemonic