gi-wnck-3.0.9: Wnck bindings
CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Wnck.Objects.Window

Description

The Window struct contains only private fields and should not be directly accessed.

Synopsis

Exported types

newtype Window Source #

Memory-managed wrapper type.

Constructors

Window (ManagedPtr Window) 

Instances

Instances details
Eq Window Source # 
Instance details

Defined in GI.Wnck.Objects.Window

Methods

(==) :: Window -> Window -> Bool #

(/=) :: Window -> Window -> Bool #

IsGValue Window Source #

Convert Window to and from GValue with toGValue and fromGValue.

Instance details

Defined in GI.Wnck.Objects.Window

ManagedPtrNewtype Window Source # 
Instance details

Defined in GI.Wnck.Objects.Window

TypedObject Window Source # 
Instance details

Defined in GI.Wnck.Objects.Window

Methods

glibType :: IO GType #

GObject Window Source # 
Instance details

Defined in GI.Wnck.Objects.Window

HasParentTypes Window Source # 
Instance details

Defined in GI.Wnck.Objects.Window

type ParentTypes Window Source # 
Instance details

Defined in GI.Wnck.Objects.Window

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

Overloaded methods

activate

windowActivate Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> Word32

timestamp: the X server timestamp of the user interaction event that caused this call to occur.

-> m () 

Asks the window manager to make window the active window. The window manager may choose to raise window along with focusing it, and may decide to refuse the request (to not steal the focus if there is a more recent user activity, for example).

This function existed before 2.10, but the timestamp argument was missing in earlier versions.

Since: 2.10

activateTransient

windowActivateTransient Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> Word32

timestamp: the X server timestamp of the user interaction event that caused this call to occur.

-> m () 

If window has transients, activates the most likely transient instead of the window itself. Otherwise activates window.

FIXME the ideal behavior of this function is probably to activate the most recently active window among window and its transients. This is probably best implemented on the window manager side.

This function existed before 2.10, but the timestamp argument was missing in earlier versions.

Since: 2.10

close

windowClose Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> Word32

timestamp: the X server timestamp of the user interaction event that caused this call to occur.

-> m () 

Closes window.

This function existed before 2.6, but the timestamp argument was missing in earlier versions.

Since: 2.6

get

windowGet Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> CULong

xwindow: an X window ID.

-> m (Maybe Window)

Returns: the Window for xwindow. The returned Window is owned by libwnck and must not be referenced or unreferenced.

Gets a preexisting Window for the X window xwindow. This will not create a Window if none exists. The function is robust against bogus window IDs.

getActions

windowGetActions Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m [WindowActions]

Returns: bitmask of actions that can be done for window.

Gets the actions that can be done for window.

getApplication

windowGetApplication Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Application

Returns: the Application to which window belongs. The returned Application is owned by libwnck and must not be referenced or unreferenced.

Gets the Application to which window belongs.

getClassGroup

windowGetClassGroup Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m ClassGroup

Returns: the ClassGroup to which window belongs. The returned ClassGroup is owned by libwnck and must not be referenced or unreferenced.

Gets the ClassGroup to which window belongs.

Since: 2.2

getClassGroupName

windowGetClassGroupName Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Text

Returns: the class group name for window, or Nothing if window belongs to no class group.

Gets the class group name from the <ulink url="http://tronche.com/gui/x/icccm/sec-4.html&num;WM_CLASS">WM_CLASS Property</ulink> for window.

The class group name is also the identifier name of the ClassGroup to which window belongs.

getClassInstanceName

windowGetClassInstanceName Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Text

Returns: the class instance name for window, or Nothing if window has no class instance.

Gets the class instance name from the <ulink url="http://tronche.com/gui/x/icccm/sec-4.html&num;WM_CLASS">WM_CLASS Property</ulink> for window.

The class instance name allows to differentiate windows belonging to the same class group, so that they can use different resources.

getClientWindowGeometry

windowGetClientWindowGeometry Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m (Int32, Int32, Int32, Int32) 

Gets the size and position of window, as last received in a ConfigureNotify event (i.e. this call does not round-trip to the server, just gets the last size we were notified of). The X and Y coordinates are relative to the root window.

The window manager usually adds a frame around windows. If you need to know the size of window with the frame, use windowGetGeometry.

Since: 2.20

getGeometry

windowGetGeometry Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m (Int32, Int32, Int32, Int32) 

Gets the size and position of window, including decorations. This function uses the information last received in a ConfigureNotify event and adjusts it according to the size of the frame that is added by the window manager (this call does not round-trip to the server, it just gets the last sizes that were notified). The X and Y coordinates are relative to the root window.

If you need to know the actual size of window ignoring the frame added by the window manager, use windowGetClientWindowGeometry.

getGroupLeader

windowGetGroupLeader Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m CULong

Returns: the group leader of the group of windows to which window belongs, or the X window ID of window if window does not belong to any group.

Gets the group leader of the group of windows to which window belongs.

getIcon

windowGetIcon Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Pixbuf

Returns: the icon for window. The caller should reference the returned <classname>GdkPixbuf</classname> if it needs to keep the icon around.

Gets the icon to be used for window. If no icon was found, a fallback icon is used. windowGetIconIsFallback can be used to tell if the icon is the fallback icon.

getIconIsFallback

windowGetIconIsFallback Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Bool

Returns: True if the icon for window is a fallback, False otherwise.

Gets whether a default fallback icon is used for window (because none was set on window).

getIconName

windowGetIconName Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window

-> m Text

Returns: the icon name of window, or a fallback icon name if no icon name is available.

Gets the icon name of window, as it should be displayed for an icon (minimized state). Always returns some value, even if window has no icon name set; use windowHasIconName if you need to know whether the returned icon name is "real" or not.

Contrast with windowGetName, which returns window's title, not its icon title.

getMiniIcon

windowGetMiniIcon Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Pixbuf

Returns: the mini-icon for window. The caller should reference the returned <classname>GdkPixbuf</classname> if it needs to keep the icon around.

Gets the mini-icon to be used for window. If no mini-icon was found, a fallback mini-icon is used. windowGetIconIsFallback can be used to tell if the mini-icon is the fallback mini-icon.

getName

windowGetName Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Text

Returns: the name of window, or a fallback name if no name is available.

Gets the name of window, as it should be displayed in a pager or tasklist. Always returns some value, even if window has no name set; use windowHasName if you need to know whether the returned name is "real" or not.

For icons titles, use windowGetIconName instead.

getPid

windowGetPid Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Int32

Returns: the process ID of window, or 0 if none is available.

Gets the process ID of window.

getRole

windowGetRole Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Text

Returns: role for window, or Nothing if window has no role.

Gets the role for window. The role uniquely identifies a window among all windows that have the same client leader window.

getScreen

windowGetScreen Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Screen

Returns: the Screen window is on. The returned Screen is owned by libwnck and must not be referenced or unreferenced.

Gets the Screen window is on.

getSessionId

windowGetSessionId Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Text

Returns: the session ID for window in Latin-1, or Nothing if window has no session ID.

Gets the session ID for window in Latin-1 encoding. NOTE: this is invalid UTF-8. You can't display this string in a GTK+ widget without converting to UTF-8. See windowGetSessionIdUtf8.

getSessionIdUtf8

windowGetSessionIdUtf8 Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Text

Returns: the session ID for window in UTF-8, or Nothing if window has no session ID.

Gets the session ID for window in UTF-8 encoding. The session ID should be in Latin-1 encoding, so the conversion should work, but a broken client could set a session ID that might not be convertable to UTF-8.

getSortOrder

windowGetSortOrder Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Int32

Returns: the sort order of window, or G_MAXINT if none is available.

Gets the sort order of window, used for ordering of window in Selector and Tasklist. The sort order is an internal state in libwnck. The initial value is defined when the window is created.

Since: 2.10

getState

windowGetState Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m [WindowState]

Returns: bitmask of active states for window.

Gets the state of window.

getTransient

windowGetTransient Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Window

Returns: the Window for which window is transient, or Nothing if window is not transient for any Window. The returned Window is owned by libwnck and must not be referenced or unreferenced.

Gets the Window for which window is transient.

Since: 2.12

getWindowType

windowGetWindowType Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m WindowType

Returns: the semantic type of window.

Gets the semantic type of window.

getWorkspace

windowGetWorkspace Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Workspace

Returns: the single current workspace window is on, or Nothing. The returned Workspace is owned by libwnck and must not be referenced or unreferenced.

Gets the current workspace window is on. If the window is pinned (on all workspaces), or not on any workspaces, Nothing may be returned.

getXid

windowGetXid Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m CULong

Returns: the X window ID of window.

Gets the X window ID of window.

hasIconName

windowHasIconName Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window

-> m Bool

Returns: True if windowGetIconName returns window's icon name, False if it returns a fallback name.

Checks whether or not window has an icon name. windowGetIconName will always return some value, even if window has no icon name set; windowHasIconName can be used to tell if that icon name is real or not.

(Note that if windowHasIconName returns False, but windowHasName returns True, then the name returned by windowGetIconName is window's name. Only when both methods return False does windowGetIconName return a generic fallback name.)

Since: 2.16

hasName

windowHasName Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Bool

Returns: True if windowGetName returns window's name, False if it returns a fallback name.

Checks whether or not window has a name. windowGetName will always return some value, even if window has no name set; windowHasName can be used to tell if that name is real or not.

For icons titles, use windowHasIconName instead.

Since: 2.16

isAbove

windowIsAbove Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Bool

Returns: True if window is above other windows, False otherwise.

Gets whether window is above other windows. This state may change anytime a stateChanged signal gets emitted.

See windowMakeAbove for more details on this state.

Since: 2.14

isActive

windowIsActive Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Bool

Returns: True if window is the active window on its Screen, False otherwise.

Gets whether window is the active window on its Screen.

isBelow

windowIsBelow Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Bool

Returns: True if window is below other windows, False otherwise.

Gets whether window is below other windows. This state may change anytime a stateChanged signal gets emitted.

See windowMakeBelow for more details on this state.

Since: 2.20

isFullscreen

windowIsFullscreen Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Bool

Returns: True if window is fullscreen, False otherwise.

Gets whether window is fullscreen. Fullscreen state may change anytime a stateChanged signal gets emitted.

Since: 2.8

isInViewport

windowIsInViewport Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a, IsWorkspace b) 
=> a

window: a Window.

-> b

workspace: a Workspace.

-> m Bool

Returns: True if window appears in current viewport of workspace, False otherwise.

Gets True if window appears in the current viewport of workspace.

Since: 2.4

isMaximized

windowIsMaximized Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Bool

Returns: True if window is maximized in both directions, False otherwise.

Gets whether window is maximized. Maximization state may change anytime a stateChanged signal gets emitted.

As for GDK, "maximized" means both vertically and horizontally. If window is maximized in only one direction, then window is not considered maximized.

isMaximizedHorizontally

windowIsMaximizedHorizontally Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Bool

Returns: True if window is maximized horizontally, False otherwise.

Gets whether window is maximized horizontally. Horizontal maximization state may change anytime a stateChanged signal gets emitted.

isMaximizedVertically

windowIsMaximizedVertically Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Bool

Returns: True if window is maximized vertically, False otherwise.

Gets whether window is maximized vertically. vertiVal maximization state may change anytime a stateChanged signal gets emitted.

isMinimized

windowIsMinimized Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Bool

Returns: True if window is minimized, False otherwise.

Gets whether window is minimized. Minimization state may change anytime a stateChanged signal gets emitted.

isMostRecentlyActivated

windowIsMostRecentlyActivated Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Bool

Returns: True if window was the most recently activated window on its Screen, False otherwise.

Gets whether window is the most recently activated window on its Screen.

The most recently activated window is identical to the active window for click and sloppy focus methods (since a window is always active in those cases) but differs slightly for mouse focus since there often is no active window.

Since: 2.8

isOnWorkspace

windowIsOnWorkspace Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a, IsWorkspace b) 
=> a

window: a Window.

-> b

workspace: a Workspace.

-> m Bool

Returns: True if window appears on workspace, False otherwise.

Gets whether window appears on workspace.

isPinned

windowIsPinned Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Bool

Returns: True if window is on all workspaces, False otherwise.

Gets whether window is on all workspace. Pinned state may change anytime a workspaceChanged signal gets emitted, but not when a stateChanged gets emitted.

isShaded

windowIsShaded Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Bool

Returns: True if window is shaded, False otherwise.

Gets whether window is shaded. Shade state may change anytime a stateChanged signal gets emitted.

isSkipPager

windowIsSkipPager Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Bool

Returns: True if window is included on pagers, False otherwise.

Gets whether window is included on pagers. This state may change anytime a stateChanged signal gets emitted.

isSkipTasklist

windowIsSkipTasklist Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Bool

Returns: True if window is included on tasklists, False otherwise.

Gets whether window is included on tasklists. This state may change anytime a stateChanged signal gets emitted.

isSticky

windowIsSticky Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Bool

Returns: True if window is "stuck to the glass", False otherwise.

Gets whether window is sticky. Sticky state may change anytime a stateChanged signal gets emitted.

Sticky here means "stuck to the glass", i.e. does not scroll with the viewport. In GDK/GTK+ (e.g. windowStick/windowStick), sticky means "stuck to the glass" and <emphasis>also</emphasis> that the window is on all workspaces. But here it only means the viewport aspect of it.

isVisibleOnWorkspace

windowIsVisibleOnWorkspace Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a, IsWorkspace b) 
=> a

window: a Window.

-> b

workspace: a Workspace.

-> m Bool

Returns: True if window appears on workspace in normal state, False otherwise.

Like windowIsOnWorkspace, but also checks that the window is in a visible state (i.e. not minimized or shaded).

keyboardMove

windowKeyboardMove Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m () 

Asks the window manager to start moving window via the keyboard.

keyboardSize

windowKeyboardSize Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m () 

Asks the window manager to start resizing window via the keyboard.

makeAbove

windowMakeAbove Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m () 

Asks the window manager to put window on top of most windows (window will not be on top of focused fullscreen windows, of other windows with this setting and of dock windows).

Since: 2.14

makeBelow

windowMakeBelow Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m () 

Asks the window manager to put window below most windows.

Since: 2.20

maximize

windowMaximize Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m () 

Asks the window manager to maximize window.

maximizeHorizontally

windowMaximizeHorizontally Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m () 

Asks the window manager to maximize horizontally window.

maximizeVertically

windowMaximizeVertically Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m () 

Asks the window manager to maximize vertically window.

minimize

windowMinimize Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m () 

Minimizes window.

moveToWorkspace

windowMoveToWorkspace Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a, IsWorkspace b) 
=> a

window: a Window.

-> b

space: a Workspace.

-> m () 

Asks the window manager to move window to space. If window was pinned, it will also result in window being visible only on space.

needsAttention

windowNeedsAttention Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Bool

Returns: True if window needs attention, False otherwise.

Gets whether window needs attention. This state may change anytime a stateChanged signal gets emitted.

This state depends on flags such as the demands_attention and is_urgent hints.

Since: 2.12

orTransientNeedsAttention

windowOrTransientNeedsAttention Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Bool

Returns: True if window or one of its transients needs attention, False otherwise.

Gets whether window or one of its transients needs attention. This state may change anytime a stateChanged signal gets emitted.

Since: 2.12

pin

windowPin Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m () 

Asks the window manager to put window on all workspaces.

setFullscreen

windowSetFullscreen Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> Bool

fullscreen: whether to make window fullscreen.

-> m () 

Asks the window manager to set the fullscreen state of window according to fullscreen.

Since: 2.8

setGeometry

windowSetGeometry Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> WindowGravity

gravity: the gravity point to use as a reference for the new position.

-> [WindowMoveResizeMask]

geometryMask: a bitmask containing flags for what should be set.

-> Int32

x: new X coordinate in pixels of window.

-> Int32

y: new Y coordinate in pixels of window.

-> Int32

width: new width in pixels of window.

-> Int32

height: new height in pixels of window.

-> m () 

Sets the size and position of window. The X and Y coordinates should be relative to the root window.

Note that the new size and position apply to window with its frame added by the window manager. Therefore, using windowSetGeometry with the values returned by windowGetGeometry should be a no-op, while using windowSetGeometry with the values returned by windowGetClientWindowGeometry should reduce the size of window and move it.

Since: 2.16

setIconGeometry

windowSetIconGeometry Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> Int32

x: X coordinate in pixels.

-> Int32

y: Y coordinate in pixels.

-> Int32

width: width in pixels.

-> Int32

height: height in pixels.

-> m () 

Sets the icon geometry for window. A typical use case for this is the destination of the minimization animation of window.

setSkipPager

windowSetSkipPager Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> Bool

skip: whether window should be included on pagers.

-> m () 

Asks the window manager to make window included or not included on pagers.

setSkipTasklist

windowSetSkipTasklist Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> Bool

skip: whether window should be included on tasklists.

-> m () 

Asks the window manager to make window included or not included on tasklists.

setSortOrder

windowSetSortOrder Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> Int32

order: new sort order for window.

-> m () 

Sets the sort order of window. The sort order is used for ordering of window in Selector and Tasklist.

Since: 2.20

setWindowType

windowSetWindowType Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> WindowType

wintype: a semantic type.

-> m () 

Sets the semantic type of window to wintype.

Since: 2.12

shade

windowShade Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m () 

Asks the window manager to shade window.

stick

windowStick Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m () 

Asks the window manager to keep the window's position fixed on the screen, even when the workspace or viewport scrolls.

transientIsMostRecentlyActivated

windowTransientIsMostRecentlyActivated Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m Bool

Returns: True if one of the transients of window is the most recently activated window, False otherwise.

Gets whether one of the transients of window is the most recently activated window. See windowIsMostRecentlyActivated for a more complete description of what is meant by most recently activated. This function is needed because clicking on a Tasklist once will activate a transient instead of window itself (wnck_window_activate_transient), and clicking again should minimize window and its transients. (Not doing this can be especially annoying in the case of modal dialogs that don't appear in the Tasklist).

Since: 2.12

unmakeAbove

windowUnmakeAbove Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m () 

Asks the window manager to not put window on top of most windows, and to put it again in the stack with other windows.

Since: 2.14

unmakeBelow

windowUnmakeBelow Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m () 

Asks the window manager to not put window below most windows, and to put it again in the stack with other windows.

Since: 2.20

unmaximize

windowUnmaximize Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m () 

Asks the window manager to unmaximize window.

unmaximizeHorizontally

windowUnmaximizeHorizontally Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m () 

Asks the window manager to unmaximize horizontally window.

unmaximizeVertically

windowUnmaximizeVertically Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m () 

Asks the window manager to unmaximize vertically window.

unminimize

windowUnminimize Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> Word32

timestamp: the X server timestamp of the user interaction event that caused this call to occur.

-> m () 

Unminimizes window by activating it or one of its transients. See windowActivateTransient for details on how the activation is done.

unpin

windowUnpin Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m () 

Asks the window manager to put window only in the currently active workspace, if window was previously pinned. If window was not pinned, does not change window's workspace. If the active workspace is not known for some reason (it should not happen much), sets window's workspace to the first workspace.

unshade

windowUnshade Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m () 

Asks the window manager to unshade window.

unstick

windowUnstick Source #

Arguments

:: (HasCallStack, MonadIO m, IsWindow a) 
=> a

window: a Window.

-> m () 

Asks the window manager to not have window's position fixed on the screen when the workspace or viewport scrolls.

Signals

actionsChanged

type C_WindowActionsChangedCallback = Ptr () -> CUInt -> CUInt -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type WindowActionsChangedCallback Source #

Arguments

 = [WindowActions]

changedMask: the bitmask containing bits set for all actions availabilities for window that have changed.

-> [WindowActions]

newState: the new actions availabilities for window.

-> IO () 

Emitted when the actions availabilities for window change.

afterWindowActionsChanged :: (IsWindow a, MonadIO m) => a -> WindowActionsChangedCallback -> m SignalHandlerId Source #

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

after window #actionsChanged callback

onWindowActionsChanged :: (IsWindow a, MonadIO m) => a -> WindowActionsChangedCallback -> m SignalHandlerId Source #

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

on window #actionsChanged callback

classChanged

type C_WindowClassChangedCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type WindowClassChangedCallback = IO () Source #

Emitted when the class name or instance name of window changes.

afterWindowClassChanged :: (IsWindow a, MonadIO m) => a -> WindowClassChangedCallback -> m SignalHandlerId Source #

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

after window #classChanged callback

onWindowClassChanged :: (IsWindow a, MonadIO m) => a -> WindowClassChangedCallback -> m SignalHandlerId Source #

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

on window #classChanged callback

geometryChanged

type C_WindowGeometryChangedCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type WindowGeometryChangedCallback = IO () Source #

Emitted when the geometry of window changes.

afterWindowGeometryChanged :: (IsWindow a, MonadIO m) => a -> WindowGeometryChangedCallback -> m SignalHandlerId Source #

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

after window #geometryChanged callback

onWindowGeometryChanged :: (IsWindow a, MonadIO m) => a -> WindowGeometryChangedCallback -> m SignalHandlerId Source #

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

on window #geometryChanged callback

iconChanged

type C_WindowIconChangedCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type WindowIconChangedCallback = IO () Source #

Emitted when the icon of window changes.

afterWindowIconChanged :: (IsWindow a, MonadIO m) => a -> WindowIconChangedCallback -> m SignalHandlerId Source #

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

after window #iconChanged callback

onWindowIconChanged :: (IsWindow a, MonadIO m) => a -> WindowIconChangedCallback -> m SignalHandlerId Source #

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

on window #iconChanged callback

nameChanged

type C_WindowNameChangedCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type WindowNameChangedCallback = IO () Source #

Emitted when the name of window changes.

afterWindowNameChanged :: (IsWindow a, MonadIO m) => a -> WindowNameChangedCallback -> m SignalHandlerId Source #

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

after window #nameChanged callback

onWindowNameChanged :: (IsWindow a, MonadIO m) => a -> WindowNameChangedCallback -> m SignalHandlerId Source #

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

on window #nameChanged callback

roleChanged

type C_WindowRoleChangedCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type WindowRoleChangedCallback = IO () Source #

Emitted when the role of window changes.

afterWindowRoleChanged :: (IsWindow a, MonadIO m) => a -> WindowRoleChangedCallback -> m SignalHandlerId Source #

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

after window #roleChanged callback

onWindowRoleChanged :: (IsWindow a, MonadIO m) => a -> WindowRoleChangedCallback -> m SignalHandlerId Source #

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

on window #roleChanged callback

stateChanged

type C_WindowStateChangedCallback = Ptr () -> CUInt -> CUInt -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type WindowStateChangedCallback Source #

Arguments

 = [WindowState]

changedMask: the bitmask containing bits set for all states of window that have changed.

-> [WindowState]

newState: the new state of window.

-> IO () 

Emitted when the state of window changes. This can happen when window is (un)minimized, (un)maximized, (un)sticked, (un)shaded, (un)made above, (un)made below, (un)set fullscreen, when it needs attention, etc. See WindowState for the complete list of states that might have changed.

afterWindowStateChanged :: (IsWindow a, MonadIO m) => a -> WindowStateChangedCallback -> m SignalHandlerId Source #

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

after window #stateChanged callback

onWindowStateChanged :: (IsWindow a, MonadIO m) => a -> WindowStateChangedCallback -> m SignalHandlerId Source #

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

on window #stateChanged callback

typeChanged

type C_WindowTypeChangedCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type WindowTypeChangedCallback = IO () Source #

Emitted when the EWMH type hint of the window changes.

Since: 3.20

afterWindowTypeChanged :: (IsWindow a, MonadIO m) => a -> WindowTypeChangedCallback -> m SignalHandlerId Source #

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

after window #typeChanged callback

onWindowTypeChanged :: (IsWindow a, MonadIO m) => a -> WindowTypeChangedCallback -> m SignalHandlerId Source #

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

on window #typeChanged callback

workspaceChanged

type C_WindowWorkspaceChangedCallback = Ptr () -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type WindowWorkspaceChangedCallback = IO () Source #

Emitted when the current workspace of window changes, or if window has been pinned or unpinned.

afterWindowWorkspaceChanged :: (IsWindow a, MonadIO m) => a -> WindowWorkspaceChangedCallback -> m SignalHandlerId Source #

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

after window #workspaceChanged callback

onWindowWorkspaceChanged :: (IsWindow a, MonadIO m) => a -> WindowWorkspaceChangedCallback -> m SignalHandlerId Source #

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

on window #workspaceChanged callback