Gtk2HsContentsIndex
Graphics.UI.Gtk.Windows.Window
Portabilityportable (depends on GHC)
Stabilityprovisional
Maintainergtk2hs-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
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
show/hide Instances
class BinClass o => WindowClass o
show/hide Instances
castToWindow :: GObjectClass obj => obj -> Window
toWindow :: WindowClass o => o -> Window
data WindowType
Interaction of a window with window manager
Constructors
WindowToplevel
WindowPopup
show/hide Instances
data WindowEdge
Determines a window edge or corner.
Constructors
WindowEdgeNorthWest
WindowEdgeNorth
WindowEdgeNorthEast
WindowEdgeWest
WindowEdgeEast
WindowEdgeSouthWest
WindowEdgeSouth
WindowEdgeSouthEast
show/hide Instances
data WindowTypeHint

These are hints for the window manager that indicate what type of function the window has. The window manager can use this when determining decoration and behaviour of the window. The hint must be set before mapping the window.

See the extended window manager hints specification for more details about window types.

Constructors
WindowTypeHintNormal
WindowTypeHintDialog
WindowTypeHintMenu
WindowTypeHintToolbar
WindowTypeHintSplashscreen
WindowTypeHintUtility
WindowTypeHintDock
WindowTypeHintDesktop
WindowTypeHintDropdownMenu
WindowTypeHintPopupMenu
WindowTypeHintTooltip
WindowTypeHintNotification
WindowTypeHintCombo
WindowTypeHintDnd
show/hide Instances
data Gravity
Defines the reference point of a window and the meaning of coordinates passed to windowMove. See 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
show/hide Instances
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 Boolreturns True if the user can resize the window
Gets the value set by windowSetResizable.
windowActivateFocus
:: WindowClass self
=> self
-> IO Boolreturns True if a widget got activated.
Activates the current focused widget within the window.
windowActivateDefault
:: WindowClass self
=> self
-> IO Boolreturns 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
-> Boolmodal - 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 Boolreturns 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
-> Intheight - height in pixels, or -1 to unset the default height
-> Intwidth - 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
show/hide Instances
windowSetTransientFor
:: (WindowClass self, WindowClass parent)
=> self
-> parentparent - 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 Boolreturns 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 Boolreturns 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 Boolreturns 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
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
-> Boolsetting - 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
-> Boolsetting - 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
-> Boolsetting - 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 Boolreturns True if window shouldn't be in taskbar

Gets the value set by windowSetSkipTaskbarHint

  • Available since Gtk+ version 2.2
windowSetSkipPagerHint
:: WindowClass self
=> self
-> Boolsetting - 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 Boolreturns True if window shouldn't be in pager

Gets the value set by windowSetSkipPagerHint.

  • Available since Gtk+ version 2.2
windowSetAcceptFocus
:: WindowClass self
=> self
-> Boolsetting - 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 Boolreturns True if window should receive the input focus

Gets the value set by windowSetAcceptFocus.

  • Available since Gtk+ version 2.4
windowSetFocusOnMap
:: WindowClass self
=> self
-> Boolsetting - 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 Boolreturns 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 Boolreturns 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
-> Intleft - The width of the left border
-> Inttop - The height of the top border
-> Intright - The width of the right border
-> Intbottom - 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
-> Stringrole - 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
-> AccelGroupaccelGroup - a AccelGroup
-> IO ()
Associate accelGroup with window, such that calling accelGroupsActivate on window will activate accelerators in accelGroup.
windowRemoveAccelGroup
:: WindowClass self
=> self
-> AccelGroupaccelGroup - a AccelGroup
-> IO ()
Reverses the effects of windowAddAccelGroup.
windowSetIcon
:: WindowClass self
=> self
-> Pixbuficon - 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
-> Stringname - 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 Stringreturns 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
:: Stringname - 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
-> Gravitygravity - 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 Gravityreturns window gravity
Gets the value set by windowSetGravity.
windowSetScreen
:: WindowClass self
=> self
-> Screenscreen - 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 Screenreturns a Screen.

Returns the Screen associated with the window.

  • Available since Gtk+ version 2.2
windowBeginResizeDrag
:: WindowClass self
=> self
-> WindowEdgeedge - position of the resize control
-> MouseButtonbutton - mouse button that initiated the drag
-> IntrootX - X position where the user clicked to initiate the drag, in root window coordinates
-> IntrootY - Y position where the user clicked to initiate the drag
-> TimeStamptimestamp - 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
-> MouseButtonbutton - mouse button that initiated the drag
-> IntrootX - X position where the user clicked to initiate the drag, in root window coordinates
-> IntrootY - Y position where the user clicked to initiate the drag
-> TimeStamptimestamp - 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
-> WindowTypeHinthint - 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.