| Gtk2Hs | Contents | Index

Graphics.UI.Gtk.Windows.Window

Portability | portable (depends on GHC)
Stability | provisional
Maintainer | gtk2hs-users@lists.sourceforge.net

Contents

Class Hierarchy
Types
Constructors
Methods
Attributes
Signals

Description
Toplevel which can contain other widgets
Synopsis

data Window
class BinClass o => WindowClass o
castToWindow :: GObjectClass obj => obj -> Window
toWindow :: WindowClass o => o -> Window

data WindowType

= WindowToplevel
| WindowPopup

data WindowEdge

= WindowEdgeNorthWest
| WindowEdgeNorth
| WindowEdgeNorthEast
| WindowEdgeWest
| WindowEdgeEast
| WindowEdgeSouthWest
| WindowEdgeSouth
| WindowEdgeSouthEast

data WindowTypeHint

= WindowTypeHintNormal
| WindowTypeHintDialog
| WindowTypeHintMenu
| WindowTypeHintToolbar
| WindowTypeHintSplashscreen
| WindowTypeHintUtility
| WindowTypeHintDock
| WindowTypeHintDesktop
| WindowTypeHintDropdownMenu
| WindowTypeHintPopupMenu
| WindowTypeHintTooltip
| WindowTypeHintNotification
| WindowTypeHintCombo
| WindowTypeHintDnd

data Gravity

= GravityNorthWest
| GravityNorth
| GravityNorthEast
| GravityWest
| GravityCenter
| GravityEast
| GravitySouthWest
| GravitySouth
| GravitySouthEast
| GravityStatic

windowNew :: IO Window
windowNewPopup :: IO Window
windowSetTitle :: WindowClass self => self -> String -> IO ()
windowGetTitle :: WindowClass self => self -> IO String
windowSetResizable :: WindowClass self => self -> Bool -> IO ()
windowGetResizable :: WindowClass self => self -> IO Bool
windowActivateFocus :: WindowClass self => self -> IO Bool
windowActivateDefault :: WindowClass self => self -> IO Bool
windowSetModal :: WindowClass self => self -> Bool -> IO ()
windowGetModal :: WindowClass self => self -> IO Bool
windowSetDefaultSize :: WindowClass self => self -> Int -> Int -> IO ()
windowGetDefaultSize :: WindowClass self => self -> IO (Int, Int)
windowSetPolicy :: WindowClass self => self -> Bool -> Bool -> Bool -> IO ()
windowSetPosition :: WindowClass self => self -> WindowPosition -> IO ()

data WindowPosition

= WinPosNone
| WinPosCenter
| WinPosMouse
| WinPosCenterAlways
| WinPosCenterOnParent

windowSetTransientFor :: (WindowClass self, WindowClass parent) => self -> parent -> IO ()
windowGetTransientFor :: WindowClass self => self -> IO (Maybe Window)
windowSetDestroyWithParent :: WindowClass self => self -> Bool -> IO ()
windowGetDestroyWithParent :: WindowClass self => self -> IO Bool
windowIsActive :: WindowClass self => self -> IO Bool
windowHasToplevelFocus :: WindowClass self => self -> IO Bool
windowListToplevels :: IO [Window]
windowGetFocus :: WindowClass self => self -> IO (Maybe Widget)
windowSetFocus :: (WindowClass self, WidgetClass widget) => self -> Maybe widget -> IO ()
windowSetDefault :: (WindowClass self, WidgetClass widget) => self -> Maybe widget -> IO ()
windowPresent :: WindowClass self => self -> IO ()
windowDeiconify :: WindowClass self => self -> IO ()
windowIconify :: WindowClass self => self -> IO ()
windowMaximize :: WindowClass self => self -> IO ()
windowUnmaximize :: WindowClass self => self -> IO ()
windowFullscreen :: WindowClass self => self -> IO ()
windowUnfullscreen :: WindowClass self => self -> IO ()
windowSetKeepAbove :: WindowClass self => self -> Bool -> IO ()
windowSetKeepBelow :: WindowClass self => self -> Bool -> IO ()
windowSetSkipTaskbarHint :: WindowClass self => self -> Bool -> IO ()
windowGetSkipTaskbarHint :: WindowClass self => self -> IO Bool
windowSetSkipPagerHint :: WindowClass self => self -> Bool -> IO ()
windowGetSkipPagerHint :: WindowClass self => self -> IO Bool
windowSetAcceptFocus :: WindowClass self => self -> Bool -> IO ()
windowGetAcceptFocus :: WindowClass self => self -> IO Bool
windowSetFocusOnMap :: WindowClass self => self -> Bool -> IO ()
windowGetFocusOnMap :: WindowClass self => self -> IO Bool
windowSetDecorated :: WindowClass self => self -> Bool -> IO ()
windowGetDecorated :: WindowClass self => self -> IO Bool
windowSetFrameDimensions :: WindowClass self => self -> Int -> Int -> Int -> Int -> IO ()
windowSetRole :: WindowClass self => self -> String -> IO ()
windowGetRole :: WindowClass self => self -> IO (Maybe String)
windowStick :: WindowClass self => self -> IO ()
windowUnstick :: WindowClass self => self -> IO ()
windowAddAccelGroup :: WindowClass self => self -> AccelGroup -> IO ()
windowRemoveAccelGroup :: WindowClass self => self -> AccelGroup -> IO ()
windowSetIcon :: WindowClass self => self -> Pixbuf -> IO ()
windowSetIconName :: WindowClass self => self -> String -> IO ()
windowGetIconName :: WindowClass self => self -> IO String
windowSetDefaultIconName :: String -> IO ()
windowSetGravity :: WindowClass self => self -> Gravity -> IO ()
windowGetGravity :: WindowClass self => self -> IO Gravity
windowSetScreen :: WindowClass self => self -> Screen -> IO ()
windowGetScreen :: WindowClass self => self -> IO Screen
windowBeginResizeDrag :: WindowClass self => self -> WindowEdge -> MouseButton -> Int -> Int -> TimeStamp -> IO ()
windowBeginMoveDrag :: WindowClass self => self -> MouseButton -> Int -> Int -> TimeStamp -> IO ()
windowSetTypeHint :: WindowClass self => self -> WindowTypeHint -> IO ()
windowGetTypeHint :: WindowClass self => self -> IO WindowTypeHint
windowGetIcon :: WindowClass self => self -> IO Pixbuf
windowGetPosition :: WindowClass self => self -> IO (Int, Int)
windowGetSize :: WindowClass self => self -> IO (Int, Int)
windowMove :: WindowClass self => self -> Int -> Int -> IO ()
windowResize :: WindowClass self => self -> Int -> Int -> IO ()
windowSetIconFromFile :: WindowClass self => self -> FilePath -> IO ()
windowSetAutoStartupNotification :: Bool -> IO ()
windowPresentWithTime :: WindowClass self => self -> TimeStamp -> IO ()
windowSetUrgencyHint :: WindowClass self => self -> Bool -> IO ()
windowGetUrgencyHint :: WindowClass self => self -> IO Bool
windowSetGeometryHints :: (WindowClass self, WidgetClass widget) => self -> Maybe widget -> Maybe (Int, Int) -> Maybe (Int, Int) -> Maybe (Int, Int) -> Maybe (Int, Int) -> Maybe (Double, Double) -> IO ()
windowTitle :: WindowClass self => Attr self String
windowType :: WindowClass self => ReadAttr self WindowType
windowAllowShrink :: WindowClass self => Attr self Bool
windowAllowGrow :: WindowClass self => Attr self Bool
windowResizable :: WindowClass self => Attr self Bool
windowModal :: WindowClass self => Attr self Bool
windowWindowPosition :: WindowClass self => Attr self WindowPosition
windowDefaultWidth :: WindowClass self => Attr self Int
windowDefaultHeight :: WindowClass self => Attr self Int
windowDestroyWithParent :: WindowClass self => Attr self Bool
windowIcon :: WindowClass self => Attr self Pixbuf
windowScreen :: WindowClass self => Attr self Screen
windowTypeHint :: WindowClass self => Attr self WindowTypeHint
windowSkipTaskbarHint :: WindowClass self => Attr self Bool
windowSkipPagerHint :: WindowClass self => Attr self Bool
windowUrgencyHint :: WindowClass self => Attr self Bool
windowAcceptFocus :: WindowClass self => Attr self Bool
windowFocusOnMap :: WindowClass self => Attr self Bool
windowDecorated :: WindowClass self => Attr self Bool
windowGravity :: WindowClass self => Attr self Gravity
windowTransientFor :: (WindowClass self, WindowClass parent) => ReadWriteAttr self (Maybe Window) parent
onFrameEvent :: WindowClass self => self -> (Event -> IO Bool) -> IO (ConnectId self)
afterFrameEvent :: WindowClass self => self -> (Event -> IO Bool) -> IO (ConnectId self)
onSetFocus :: (WindowClass self, WidgetClass foc) => self -> (foc -> IO ()) -> IO (ConnectId self)
afterSetFocus :: (WindowClass self, WidgetClass foc) => self -> (foc -> IO ()) -> IO (ConnectId self)

Class Hierarchy

     |  GObject
     |   +----Object
     |         +----Widget
     |               +----Container
     |                     +----Bin
     |                           +----Window
     |                                 +----Dialog
     |                                 +----Plug

Types
data Window

Instances

GObjectClass Window
WindowClass Window
BinClass Window
ContainerClass Window
WidgetClass Window
ObjectClass Window

class BinClass o => WindowClass o

Instances

WindowClass Plug
WindowClass MessageDialog
WindowClass InputDialog
WindowClass FontSelectionDialog
WindowClass FileChooserDialog
WindowClass FileSelection
WindowClass ColorSelectionDialog
WindowClass AboutDialog
WindowClass Dialog
WindowClass Window

castToWindow :: GObjectClass obj => obj -> Window
toWindow :: WindowClass o => o -> Window
data WindowType

Interaction of a window with window manager
Constructors

WindowToplevel |
WindowPopup |

Instances

Enum WindowType
Eq WindowType
Show WindowType

data WindowEdge

Determines a window edge or corner.
Constructors

WindowEdgeNorthWest |
WindowEdgeNorth |
WindowEdgeNorthEast |
WindowEdgeWest |
WindowEdgeEast |
WindowEdgeSouthWest |
WindowEdgeSouth |
WindowEdgeSouthEast |

Instances

Enum WindowEdge
Eq WindowEdge
Show WindowEdge

data WindowTypeHint

Constructors

WindowTypeHintNormal |
WindowTypeHintDialog |
WindowTypeHintMenu |
WindowTypeHintToolbar |
WindowTypeHintSplashscreen |
WindowTypeHintUtility |
WindowTypeHintDock |
WindowTypeHintDesktop |
WindowTypeHintDropdownMenu |
WindowTypeHintPopupMenu |
WindowTypeHintTooltip |
WindowTypeHintNotification |
WindowTypeHintCombo |
WindowTypeHintDnd |

Instances

Enum WindowTypeHint
Eq WindowTypeHint
Show WindowTypeHint

data Gravity

Defines the reference point of a window and the meaning of coordinates passed to Graphics.UI.Gtk.Windows.Window.windowMove. See Graphics.UI.Gtk.Windows.Window.windowMove and the implementation notes section of the extended window manager hints specification for more details.
Constructors

GravityNorthWest |
GravityNorth |
GravityNorthEast |
GravityWest |
GravityCenter |
GravityEast |
GravitySouthWest |
GravitySouth |
GravitySouthEast |
GravityStatic |

Instances

Enum Gravity
Eq Gravity
Show Gravity

Constructors
windowNew :: IO Window
Create a new top level window.
windowNewPopup :: IO Window
Create a popup window.
Methods
windowSetTitle :: WindowClass self => self -> String -> IO ()

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, 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.

windowGetTitle :: WindowClass self => self -> IO String
Retrieves the title of the window. See `windowSetTitle`.
windowSetResizable :: WindowClass self => self -> Bool -> IO ()
Sets whether the user can resize a window. Windows are user resizable by default.
windowGetResizable

:: WindowClass self |
=> self |
-> IO Bool | returns `True` if the user can resize the window
Gets the value set by `windowSetResizable`.

windowActivateFocus

:: WindowClass self |
=> self |
-> IO Bool | returns `True` if a widget got activated.
Activates the current focused widget within the window.

windowActivateDefault

:: WindowClass self |
=> self |
-> IO 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 ReceivesDefault in WidgetFlags), in which case the focused widget is activated.

windowSetModal

:: WindowClass self |
=> self |
-> Bool | `modal` - whether the window is modal
-> IO () |
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 will then disallow lowering the dialog below the parent.

windowGetModal

:: WindowClass self |
=> self |
-> IO 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`.

windowSetDefaultSize

:: WindowClass self |
=> self |
-> Int | `height` - height in pixels, or -1 to unset the default height
-> Int | `width` - width in pixels, or -1 to unset the default width
-> IO () |

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.

windowGetDefaultSize

:: WindowClass self |
=> self |
-> IO (Int, Int) | `(width, height)` - the default width and height
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.

windowSetPolicy :: WindowClass self => self -> Bool -> Bool -> Bool -> IO ()

Sets the window resizing policy.

- Warning: this function is deprecated and should not be used in newly-written code. Use `windowSetResizable` instead.

windowSetPosition :: WindowClass self => self -> WindowPosition -> IO ()
Sets a position constraint for this window. If the old or new constraint is `WinPosCenterAlways`, this will also cause the window to be repositioned to satisfy the new constraint.
data WindowPosition

Window position types
Constructors

WinPosNone |
WinPosCenter |
WinPosMouse |
WinPosCenterAlways |
WinPosCenterOnParent |

Instances

Enum WindowPosition
Eq WindowPosition
Show WindowPosition

windowSetTransientFor

:: (WindowClass self, WindowClass parent) |
=> self |
-> parent | `parent` - parent window
-> IO () |

Dialog windows should be set transient for the main application window they were spawned from. This allows window managers to e.g. keep the dialog on top of the main window, or center the dialog over the main window. dialogNewWithButtons and other convenience functions in Gtk+ will sometimes call `windowSetTransientFor` on your behalf.

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

windowGetTransientFor

:: WindowClass self |
=> self |
-> IO (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`.

windowSetDestroyWithParent :: WindowClass self => self -> Bool -> IO ()
If this setting is `True`, then destroying the transient parent of the window will also destroy the window itself. This is useful for dialogs that shouldn't persist beyond the lifetime of the main window they're associated with, for example.
windowGetDestroyWithParent

:: WindowClass self |
=> self |
-> IO 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 `windowSetDestroyWithParent`.

windowIsActive

:: WindowClass self |
=> self |
-> IO 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`

- Available since Gtk+ version 2.4

windowHasToplevelFocus

:: WindowClass self |
=> self |
-> IO Bool | returns `True` if the the input focus is within this `Window`

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

- Available since Gtk+ version 2.4

windowListToplevels :: IO [Window]
Returns a list of all existing toplevel windows.
windowGetFocus :: WindowClass self => self -> IO (Maybe Widget)
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 | widgetHasFocus will not be True for the widget.
windowSetFocus :: (WindowClass self, WidgetClass widget) => self -> Maybe widget -> IO ()
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.
windowSetDefault :: (WindowClass self, WidgetClass widget) => self -> Maybe widget -> IO ()
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 about. 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 set the | widgetCanDefault flag on the widget.
windowPresent :: WindowClass self => self -> IO ()

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.

If you are calling this function in response to a user interaction, it is preferable to use `windowPresentWithTime`.

windowDeiconify :: WindowClass self => self -> IO ()
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) 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`.
windowIconify :: WindowClass self => self -> IO ()

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) 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`.

windowMaximize :: WindowClass self => self -> IO ()

Asks to maximize the 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) 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`.

windowUnmaximize :: WindowClass self => self -> IO ()

Asks to unmaximize the window. Note that you shouldn't assume the window is definitely unmaximized afterward, because other entities (e.g. the user or window manager) 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`.

windowFullscreen :: WindowClass self => self -> IO ()

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) 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`.

- Available since Gtk+ version 2.2

windowUnfullscreen :: WindowClass self => self -> IO ()

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) 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`.

- Available since Gtk+ version 2.2

windowSetKeepAbove

:: WindowClass self |
=> self |
-> Bool | `setting` - whether to keep `window` above other windows
-> IO () |

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) 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.

- Available since Gtk+ version 2.4

windowSetKeepBelow

:: WindowClass self |
=> self |
-> Bool | `setting` - whether to keep `window` below other windows
-> IO () |

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) 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.

- Available since Gtk+ version 2.4

windowSetSkipTaskbarHint

:: WindowClass self |
=> self |
-> Bool | `setting` - `True` to keep this window from appearing in the task bar
-> IO () |

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

- Available since Gtk+ version 2.2

windowGetSkipTaskbarHint

:: WindowClass self |
=> self |
-> IO Bool | returns `True` if window shouldn't be in taskbar

Gets the value set by `windowSetSkipTaskbarHint`

- Available since Gtk+ version 2.2

windowSetSkipPagerHint

:: WindowClass self |
=> self |
-> Bool | `setting` - `True` to keep this window from appearing in the pager
-> IO () |

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.)

- Available since Gtk+ version 2.2

windowGetSkipPagerHint

:: WindowClass self |
=> self |
-> IO Bool | returns `True` if window shouldn't be in pager

Gets the value set by `windowSetSkipPagerHint`.

- Available since Gtk+ version 2.2

windowSetAcceptFocus

:: WindowClass self |
=> self |
-> Bool | `setting` - `True` to let this window receive input focus
-> IO () |

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

- Available since Gtk+ version 2.4

windowGetAcceptFocus

:: WindowClass self |
=> self |
-> IO Bool | returns `True` if window should receive the input focus

Gets the value set by `windowSetAcceptFocus`.

- Available since Gtk+ version 2.4

windowSetFocusOnMap

:: WindowClass self |
=> self |
-> Bool | `setting` - `True` to let this window receive input focus on map
-> IO () |

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.

- Available since Gtk+ version 2.6

windowGetFocusOnMap

:: WindowClass self |
=> self |
-> IO Bool | returns `True` if window should receive the input focus when mapped.

Gets the value set by `windowSetFocusOnMap`.

- Available since Gtk+ version 2.6

windowSetDecorated :: WindowClass self => self -> Bool -> IO ()

By default, windows are decorated with a title bar, resize controls, etc. Some window managers 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 windowShow.

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

windowGetDecorated

:: WindowClass self |
=> self |
-> IO 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`.

windowSetFrameDimensions

:: WindowClass self |
=> self |
-> Int | `left` - The width of the left border
-> Int | `top` - The height of the top border
-> Int | `right` - The width of the right border
-> Int | `bottom` - The height of the bottom border
-> IO () |
(Note: this is a special-purpose function intended for the framebuffer port; see windowSetHasFrame. It will have no effect on the window border drawn by the window manager, which is the normal case when using the X Window system.) For windows with frames (see windowSetHasFrame) this function can be used to change the size of the frame border.

windowSetRole

:: WindowClass self |
=> self |
-> String | `role` - unique identifier for the window to be used when restoring a session
-> IO () |

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 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.

windowGetRole

:: WindowClass self |
=> self |
-> IO (Maybe String) | returns the role of the window if set, or `Nothing`.
Returns the role of the window. See `windowSetRole` for further explanation.

windowStick :: WindowClass self => self -> IO ()

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) 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`.

windowUnstick :: WindowClass self => self -> IO ()

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) could stick it again. But normally the window will end up stuck. Just don't write code that crashes if not.

You can track stickiness via the "window_state_event" signal on `Widget`.

windowAddAccelGroup

:: WindowClass self |
=> self |
-> AccelGroup | `accelGroup` - a `AccelGroup`
-> IO () |
Associate `accelGroup` with `window`, such that calling accelGroupsActivate on `window` will activate accelerators in `accelGroup`.

windowRemoveAccelGroup

:: WindowClass self |
=> self |
-> AccelGroup | `accelGroup` - a `AccelGroup`
-> IO () |
Reverses the effects of `windowAddAccelGroup`.

windowSetIcon

:: WindowClass self |
=> self |
-> Pixbuf | `icon` - icon image
-> IO () |

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.

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.

windowSetIconName

:: WindowClass self |
=> self |
-> String | `name` - the name of the themed icon
-> IO () |

Sets the icon for the window from a named themed icon. See the docs for IconTheme for more details.

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

- Available since Gtk+ version 2.6

windowGetIconName

:: WindowClass self |
=> self |
-> IO String | returns the icon name or `""` if the window has no themed icon.

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

- Available since Gtk+ version 2.6

windowSetDefaultIconName

:: String | `name` - the name of the themed icon
-> IO () |

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`.

- Available since Gtk+ version 2.6

windowSetGravity

:: WindowClass self |
=> self |
-> Gravity | `gravity` - window gravity
-> IO () |
Window gravity defines the meaning of coordinates passed to `windowMove`. See `windowMove` and `Gravity` for more details. The default window gravity is `GravityNorthWest` which will typically "do what you mean."

windowGetGravity

:: WindowClass self |
=> self |
-> IO Gravity | returns window gravity
Gets the value set by `windowSetGravity`.

windowSetScreen

:: WindowClass self |
=> self |
-> Screen | `screen` - a `Screen`.
-> IO () |

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.

- Available since Gtk+ version 2.2

windowGetScreen

:: WindowClass self |
=> self |
-> IO Screen | returns a `Screen`.

Returns the `Screen` associated with the window.

- Available since Gtk+ version 2.2

windowBeginResizeDrag

:: WindowClass self |
=> self |
-> WindowEdge | `edge` - position of the resize control
-> MouseButton | `button` - mouse button that initiated the drag
-> Int | `rootX` - X position where the user clicked to initiate the drag, in root window coordinates
-> Int | `rootY` - Y position where the user clicked to initiate the drag
-> TimeStamp | `timestamp` - timestamp from the click event that initiated the drag
-> IO () |
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 or windowing system. Otherwise, GDK will try to emulate window resizing, potentially not all that well, depending on the windowing system.

windowBeginMoveDrag

:: WindowClass self |
=> self |
-> MouseButton | `button` - mouse button that initiated the drag
-> Int | `rootX` - X position where the user clicked to initiate the drag, in root window coordinates
-> Int | `rootY` - Y position where the user clicked to initiate the drag
-> TimeStamp | `timestamp` - timestamp from the click event that initiated the drag
-> IO () |
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 or windowing system. Otherwise, GDK will try to emulate window movement, potentially not all that well, depending on the windowing system.

windowSetTypeHint

:: WindowClass self |
=> self |
-> WindowTypeHint | `hint` - the window type
-> IO () |
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.

windowGetTypeHint

:: WindowClass self |
=> self |
-> IO WindowTypeHint | returns the type hint for `window`.
Gets the type hint for this window. See `windowSetTypeHint`.

windowGetIcon

:: WindowClass self |
=> self |
-> IO Pixbuf | returns icon for window
Gets the value set by `windowSetIcon` (or if you've called windowSetIconList, gets the first icon in the icon list).

windowGetPosition

:: WindowClass self |
=> self |
-> IO (Int, Int) | `(rootX, rootY)` - X and Y coordinate of gravity-determined reference point

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.

If you haven't changed the window gravity, its gravity will be `GravityNorthWest`. 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.

Moreover, nearly all window managers are historically broken with respect to their handling of window gravity. So moving a window to its current position as returned by `windowGetPosition` tends to result in moving the window slightly. Window managers are slowly getting better over time.

If a window has gravity `GravityStatic` 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.

If you are saving and restoring your application's window positions, you should know that it's impossible for applications to do this without getting it somewhat wrong because applications do not have sufficient knowledge of window manager state. The Correct Mechanism is to support the session management protocol (see the "GnomeClient" object in the GNOME libraries for example) and allow the window manager to save your window sizes and positions.

windowGetSize

:: WindowClass self |
=> self |

-> IO (Int, Int)

    (width, height)

Obtains the current size of the window. If the window is not onscreen, it returns the size Gtk+ will suggest to the window manager for the initial window size (but this is not reliably the same as the size the window manager will actually select). The size obtained by `windowGetSize` is the last size received in a EventConfigure, that is, Gtk+ uses its locally-stored size, rather than querying the X server for the size. As a result, if you call `windowResize` then immediately call `windowGetSize`, the size won't have taken effect yet. After the window manager processes the resize request, Gtk+ receives notification that the size has changed via a configure event, and the size of the window gets updated.

Note 1: Nearly any use of this function creates a race condition, because the size of the window may change between the time that you get the size and the time that you perform some action assuming that size is the current size. To avoid race conditions, connect to "configure_event" on the window and adjust your size-dependent state to match the size delivered in the EventConfigure.

Note 2: The returned size does not include the size of the window manager decorations (aka the window frame or border). Those are not drawn by Gtk+ and Gtk+ has no reliable method of determining their size.

Note 3: If you are getting a window size in order to position the window onscreen, there may be a better way. The preferred way is to 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 things rather than doing it yourself, because all apps will behave consistently and according to user prefs if the window manager handles it. Also, the window manager can take the size of the window decorations/border into account, while your application cannot.

In any case, if you insist on application-specified window positioning, there's still a better way than doing it yourself - `windowSetPosition` will frequently handle the details for you.

windowMove

:: WindowClass self |
=> self |
-> Int | `x` - X coordinate to move window to
-> Int | `y` - Y coordinate to move window to
-> IO () |

Asks the window manager 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 `GravityNorthWest`, 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 `GravityNorthWest`) and move the window to 0,0.

To position a window at the bottom right corner of the screen, you would set `GravitySouthEast`, 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)`.

The Extended Window Manager Hints specification at http://www.freedesktop.org/Standards/wm-spec has a nice table of gravities in the "implementation notes" section.

The `windowGetPosition` documentation may also be relevant.

windowResize

:: WindowClass self |
=> self |
-> Int | `width` - width in pixels to resize the window to
-> Int | `height` - height in pixels to resize the window to
-> IO () |

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.

windowSetIconFromFile

:: WindowClass self |
=> self |
-> FilePath | `filename` - location of icon file
-> IO () |

Sets the icon for `window`.

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

This may throw an exception if the file cannot be loaded.

- Available since Gtk+ version 2.2

windowSetAutoStartupNotification

:: Bool | `setting` - `True` to automatically do startup notification
-> IO () |

By default, after showing the first `Window` for each `Screen`, Gtk+ calls screenNotifyStartupComplete. 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.

- Available since Gtk+ version 2.2

windowPresentWithTime

:: WindowClass self |
=> self |
-> TimeStamp | `timestamp` - the timestamp of the user interaction (typically a button or key press event) which triggered this call
-> IO () |

Presents a window to the user in response to a user interaction. If you need to present a window without a timestamp, use `windowPresent`. See `windowPresent` for details.

- Available since Gtk+ version 2.8

windowSetUrgencyHint

:: WindowClass self |
=> self |
-> Bool | `setting` - `True` to mark this window as urgent
-> IO () |

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

- Available since Gtk+ version 2.8

windowGetUrgencyHint

:: WindowClass self |
=> self |
-> IO Bool | returns `True` if window is urgent

Gets the value set by `windowSetUrgencyHint`

- Available since Gtk+ version 2.8

windowSetGeometryHints

:: (WindowClass self, WidgetClass widget) |
=> self | `window` - the top level window
-> Maybe widget | `geometryWidget` - optionall a widget the geometry hints will be applied to rather than directly to the top level window
-> Maybe (Int, Int) | `(minWidth, minHeight)` - minimum width and height of window (or -1 to use requisition)
-> Maybe (Int, Int) | `(maxWidth, maxHeight)` - maximum width and height of window (or -1 to use requisition)
-> Maybe (Int, Int) | `(baseWidth, baseHeight)` - the allowed window widths are `base_width + width_inc * N` for any int `N`. Similarly, the allowed window widths are `base_height + height_inc * N` for any int `N`. For either the base width or height -1 is allowed as described above.
-> Maybe (Int, Int) | `(widthInc, heightInc)` - width and height resize increment
-> Maybe (Double, Double) | `(minAspect, maxAspect)` - minimum and maximum width/height ratio
-> IO () |

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

If you set a geometry widget, the hints will apply to the geometry widget instead of directly to the toplevel window. Of course since the geometry widget is a child widget of the top level window, constraining the sizing behaviour of the widget will have a knock-on effect on the sizing of the toplevel window.

The `minWidth`/`minHeight`/`maxWidth`/`maxHeight` fields may be set to `-1`, to use the size request of the window or geometry widget. If the minimum size hint is not provided, Gtk+ will use the size requisition of the window (or the geometry widget if it set) as the minimum size. The base size is treated similarly.

The canonical use-case for `windowSetGeometryHints` is to get a terminal widget to resize properly. Here, the terminal text area should be the geometry widget. Gtk+ will then automatically set the base size of the terminal window to the size of other widgets in the terminal window, such as the menubar and scrollbar. Then, the `widthInc` and `heightInc` values should be set to the size of one character in the terminal. Finally, the base size should be set to the size of one character. The net effect is that the minimum size of the terminal will have a 1x1 character terminal area, and only terminal sizes on the "character grid" will be allowed.

The other useful settings are `minAspect` and `maxAspect`. These specify a width/height ratio as a floating point number. If a geometry widget is set, the aspect applies to the geometry widget rather than the entire window. The most common use of these hints is probably to set `minAspect` and `maxAspect` to the same value, thus forcing the window to keep a constant aspect ratio.

Attributes
windowTitle :: WindowClass self => Attr self String
The title of the window.
windowType :: WindowClass self => ReadAttr self WindowType
The type of the window. Default value: `WindowToplevel`
windowAllowShrink :: WindowClass self => Attr self Bool
If `True`, the window has no mimimum size. Setting this to `True` is 99% of the time a bad idea. Default value: `False`
windowAllowGrow :: WindowClass self => Attr self Bool
If `True`, users can expand the window beyond its minimum size. Default value: `True`
windowResizable :: WindowClass self => Attr self Bool
If `True`, users can resize the window. Default value: `True`
windowModal :: WindowClass self => Attr self Bool
If `True`, the window is modal (other windows are not usable while this one is up). Default value: `False`
windowWindowPosition :: WindowClass self => Attr self WindowPosition
The initial position of the window. Default value: `WinPosNone`
windowDefaultWidth :: WindowClass self => Attr self Int
The default width of the window, used when initially showing the window. Allowed values: >= -1 Default value: -1
windowDefaultHeight :: WindowClass self => Attr self Int
The default height of the window, used when initially showing the window. Allowed values: >= -1 Default value: -1
windowDestroyWithParent :: WindowClass self => Attr self Bool
If this window should be destroyed when the parent is destroyed. Default value: `False`
windowIcon :: WindowClass self => Attr self Pixbuf
Icon for this window.
windowScreen :: WindowClass self => Attr self Screen
The screen where this window will be displayed.
windowTypeHint :: WindowClass self => Attr self WindowTypeHint
Hint to help the desktop environment understand what kind of window this is and how to treat it. Default value: `WindowTypeHintNormal`
windowSkipTaskbarHint :: WindowClass self => Attr self Bool
`True` if the window should not be in the task bar. Default value: `False`
windowSkipPagerHint :: WindowClass self => Attr self Bool
`True` if the window should not be in the pager. Default value: `False`
windowUrgencyHint :: WindowClass self => Attr self Bool
`True` if the window should be brought to the user's attention. Default value: `False`
windowAcceptFocus :: WindowClass self => Attr self Bool
`True` if the window should receive the input focus. Default value: `True`
windowFocusOnMap :: WindowClass self => Attr self Bool
`True` if the window should receive the input focus when mapped. Default value: `True`
windowDecorated :: WindowClass self => Attr self Bool
Whether the window should be decorated by the window manager. Default value: `True`
windowGravity :: WindowClass self => Attr self Gravity
The window gravity of the window. See `windowMove` and `Gravity` for more details about window gravity. Default value: `GravityNorthWest`
windowTransientFor :: (WindowClass self, WindowClass parent) => ReadWriteAttr self (Maybe Window) parent
'transientFor' property. See `windowGetTransientFor` and `windowSetTransientFor`
Signals
onFrameEvent :: WindowClass self => self -> (Event -> IO Bool) -> IO (ConnectId self)
afterFrameEvent :: WindowClass self => self -> (Event -> IO Bool) -> IO (ConnectId self)
onSetFocus :: (WindowClass self, WidgetClass foc) => self -> (foc -> IO ()) -> IO (ConnectId self)
afterSetFocus :: (WindowClass self, WidgetClass foc) => self -> (foc -> IO ()) -> IO (ConnectId self)
Produced by Haddock version 2.4.2