Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Exported types
- Methods
- activate
- activateTransient
- close
- get
- getActions
- getApplication
- getClassGroup
- getClassGroupName
- getClassInstanceName
- getClientWindowGeometry
- getGeometry
- getGroupLeader
- getIcon
- getIconIsFallback
- getIconName
- getIconSurface
- getMiniIcon
- getMiniIconSurface
- getName
- getPid
- getRole
- getScreen
- getSessionId
- getSessionIdUtf8
- getSortOrder
- getState
- getTransient
- getWindowType
- getWorkspace
- getXid
- hasIconName
- hasName
- isAbove
- isActive
- isBelow
- isFullscreen
- isInViewport
- isMaximized
- isMaximizedHorizontally
- isMaximizedVertically
- isMinimized
- isMostRecentlyActivated
- isOnWorkspace
- isPinned
- isShaded
- isSkipPager
- isSkipTasklist
- isSticky
- isVisibleOnWorkspace
- keyboardMove
- keyboardSize
- makeAbove
- makeBelow
- maximize
- maximizeHorizontally
- maximizeVertically
- minimize
- moveToWorkspace
- needsAttention
- orTransientNeedsAttention
- pin
- setFullscreen
- setGeometry
- setIconGeometry
- setSkipPager
- setSkipTasklist
- setSortOrder
- setWindowType
- shade
- stick
- transientIsMostRecentlyActivated
- unmakeAbove
- unmakeBelow
- unmaximize
- unmaximizeHorizontally
- unmaximizeVertically
- unminimize
- unpin
- unshade
- unstick
- Signals
The Window
struct contains only private fields and should not be
directly accessed.
Synopsis
- newtype Window = Window (ManagedPtr Window)
- class (GObject o, IsDescendantOf Window o) => IsWindow o
- toWindow :: (MonadIO m, IsWindow o) => o -> m Window
- windowActivate :: (HasCallStack, MonadIO m, IsWindow a) => a -> Word32 -> m ()
- windowActivateTransient :: (HasCallStack, MonadIO m, IsWindow a) => a -> Word32 -> m ()
- windowClose :: (HasCallStack, MonadIO m, IsWindow a) => a -> Word32 -> m ()
- windowGet :: (HasCallStack, MonadIO m) => CULong -> m (Maybe Window)
- windowGetActions :: (HasCallStack, MonadIO m, IsWindow a) => a -> m [WindowActions]
- windowGetApplication :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Application
- windowGetClassGroup :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ClassGroup
- windowGetClassGroupName :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Text
- windowGetClassInstanceName :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Text
- windowGetClientWindowGeometry :: (HasCallStack, MonadIO m, IsWindow a) => a -> m (Int32, Int32, Int32, Int32)
- windowGetGeometry :: (HasCallStack, MonadIO m, IsWindow a) => a -> m (Int32, Int32, Int32, Int32)
- windowGetGroupLeader :: (HasCallStack, MonadIO m, IsWindow a) => a -> m CULong
- windowGetIcon :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Pixbuf
- windowGetIconIsFallback :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
- windowGetIconName :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Text
- windowGetIconSurface :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Surface
- windowGetMiniIcon :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Pixbuf
- windowGetMiniIconSurface :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Surface
- windowGetName :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Text
- windowGetPid :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Int32
- windowGetRole :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Text
- windowGetScreen :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Screen
- windowGetSessionId :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Text
- windowGetSessionIdUtf8 :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Text
- windowGetSortOrder :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Int32
- windowGetState :: (HasCallStack, MonadIO m, IsWindow a) => a -> m [WindowState]
- windowGetTransient :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Window
- windowGetWindowType :: (HasCallStack, MonadIO m, IsWindow a) => a -> m WindowType
- windowGetWorkspace :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Workspace
- windowGetXid :: (HasCallStack, MonadIO m, IsWindow a) => a -> m CULong
- windowHasIconName :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
- windowHasName :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
- windowIsAbove :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
- windowIsActive :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
- windowIsBelow :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
- windowIsFullscreen :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
- windowIsInViewport :: (HasCallStack, MonadIO m, IsWindow a, IsWorkspace b) => a -> b -> m Bool
- windowIsMaximized :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
- windowIsMaximizedHorizontally :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
- windowIsMaximizedVertically :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
- windowIsMinimized :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
- windowIsMostRecentlyActivated :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
- windowIsOnWorkspace :: (HasCallStack, MonadIO m, IsWindow a, IsWorkspace b) => a -> b -> m Bool
- windowIsPinned :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
- windowIsShaded :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
- windowIsSkipPager :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
- windowIsSkipTasklist :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
- windowIsSticky :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
- windowIsVisibleOnWorkspace :: (HasCallStack, MonadIO m, IsWindow a, IsWorkspace b) => a -> b -> m Bool
- windowKeyboardMove :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
- windowKeyboardSize :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
- windowMakeAbove :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
- windowMakeBelow :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
- windowMaximize :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
- windowMaximizeHorizontally :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
- windowMaximizeVertically :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
- windowMinimize :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
- windowMoveToWorkspace :: (HasCallStack, MonadIO m, IsWindow a, IsWorkspace b) => a -> b -> m ()
- windowNeedsAttention :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
- windowOrTransientNeedsAttention :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
- windowPin :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
- windowSetFullscreen :: (HasCallStack, MonadIO m, IsWindow a) => a -> Bool -> m ()
- windowSetGeometry :: (HasCallStack, MonadIO m, IsWindow a) => a -> WindowGravity -> [WindowMoveResizeMask] -> Int32 -> Int32 -> Int32 -> Int32 -> m ()
- windowSetIconGeometry :: (HasCallStack, MonadIO m, IsWindow a) => a -> Int32 -> Int32 -> Int32 -> Int32 -> m ()
- windowSetSkipPager :: (HasCallStack, MonadIO m, IsWindow a) => a -> Bool -> m ()
- windowSetSkipTasklist :: (HasCallStack, MonadIO m, IsWindow a) => a -> Bool -> m ()
- windowSetSortOrder :: (HasCallStack, MonadIO m, IsWindow a) => a -> Int32 -> m ()
- windowSetWindowType :: (HasCallStack, MonadIO m, IsWindow a) => a -> WindowType -> m ()
- windowShade :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
- windowStick :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
- windowTransientIsMostRecentlyActivated :: (HasCallStack, MonadIO m, IsWindow a) => a -> m Bool
- windowUnmakeAbove :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
- windowUnmakeBelow :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
- windowUnmaximize :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
- windowUnmaximizeHorizontally :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
- windowUnmaximizeVertically :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
- windowUnminimize :: (HasCallStack, MonadIO m, IsWindow a) => a -> Word32 -> m ()
- windowUnpin :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
- windowUnshade :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
- windowUnstick :: (HasCallStack, MonadIO m, IsWindow a) => a -> m ()
- type WindowActionsChangedCallback = [WindowActions] -> [WindowActions] -> IO ()
- afterWindowActionsChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowActionsChangedCallback) -> m SignalHandlerId
- onWindowActionsChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowActionsChangedCallback) -> m SignalHandlerId
- type WindowClassChangedCallback = IO ()
- afterWindowClassChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowClassChangedCallback) -> m SignalHandlerId
- onWindowClassChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowClassChangedCallback) -> m SignalHandlerId
- type WindowGeometryChangedCallback = IO ()
- afterWindowGeometryChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowGeometryChangedCallback) -> m SignalHandlerId
- onWindowGeometryChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowGeometryChangedCallback) -> m SignalHandlerId
- type WindowIconChangedCallback = IO ()
- afterWindowIconChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowIconChangedCallback) -> m SignalHandlerId
- onWindowIconChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowIconChangedCallback) -> m SignalHandlerId
- type WindowNameChangedCallback = IO ()
- afterWindowNameChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowNameChangedCallback) -> m SignalHandlerId
- onWindowNameChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowNameChangedCallback) -> m SignalHandlerId
- type WindowRoleChangedCallback = IO ()
- afterWindowRoleChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowRoleChangedCallback) -> m SignalHandlerId
- onWindowRoleChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowRoleChangedCallback) -> m SignalHandlerId
- type WindowStateChangedCallback = [WindowState] -> [WindowState] -> IO ()
- afterWindowStateChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowStateChangedCallback) -> m SignalHandlerId
- onWindowStateChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowStateChangedCallback) -> m SignalHandlerId
- type WindowTypeChangedCallback = IO ()
- afterWindowTypeChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowTypeChangedCallback) -> m SignalHandlerId
- onWindowTypeChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowTypeChangedCallback) -> m SignalHandlerId
- type WindowWorkspaceChangedCallback = IO ()
- afterWindowWorkspaceChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowWorkspaceChangedCallback) -> m SignalHandlerId
- onWindowWorkspaceChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: a) => WindowWorkspaceChangedCallback) -> m SignalHandlerId
Exported types
Memory-managed wrapper type.
Instances
Eq Window Source # | |
GObject Window Source # | |
Defined in GI.Wnck.Objects.Window | |
ManagedPtrNewtype Window Source # | |
Defined in GI.Wnck.Objects.Window toManagedPtr :: Window -> ManagedPtr Window | |
TypedObject Window Source # | |
Defined in GI.Wnck.Objects.Window | |
HasParentTypes Window Source # | |
Defined in GI.Wnck.Objects.Window | |
IsGValue (Maybe Window) Source # | Convert |
Defined in GI.Wnck.Objects.Window gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Window -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Window) | |
type ParentTypes Window Source # | |
Defined in GI.Wnck.Objects.Window type ParentTypes Window = '[Object] |
class (GObject o, IsDescendantOf Window o) => IsWindow o Source #
Instances
(GObject o, IsDescendantOf Window o) => IsWindow o Source # | |
Defined in GI.Wnck.Objects.Window |
Methods
Click to display all available methods, including inherited ones
Methods
activate, activateTransient, bindProperty, bindPropertyFull, close, forceFloating, freezeNotify, getv, hasIconName, hasName, isAbove, isActive, isBelow, isFloating, isFullscreen, isInViewport, isMaximized, isMaximizedHorizontally, isMaximizedVertically, isMinimized, isMostRecentlyActivated, isOnWorkspace, isPinned, isShaded, isSkipPager, isSkipTasklist, isSticky, isVisibleOnWorkspace, keyboardMove, keyboardSize, makeAbove, makeBelow, maximize, maximizeHorizontally, maximizeVertically, minimize, moveToWorkspace, needsAttention, notify, notifyByPspec, orTransientNeedsAttention, pin, ref, refSink, runDispose, shade, stealData, stealQdata, stick, thawNotify, transientIsMostRecentlyActivated, unmakeAbove, unmakeBelow, unmaximize, unmaximizeHorizontally, unmaximizeVertically, unminimize, unpin, unref, unshade, unstick, watchClosure.
Getters
getActions, getApplication, getClassGroup, getClassGroupName, getClassInstanceName, getClientWindowGeometry, getData, getGeometry, getGroupLeader, getIcon, getIconIsFallback, getIconName, getIconSurface, getMiniIcon, getMiniIconSurface, getName, getPid, getProperty, getQdata, getRole, getScreen, getSessionId, getSessionIdUtf8, getSortOrder, getState, getTransient, getWindowType, getWorkspace, getXid.
Setters
setData, setDataFull, setFullscreen, setGeometry, setIconGeometry, setProperty, setSkipPager, setSkipTasklist, setSortOrder, setWindowType.
activate
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> Word32 |
|
-> 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 #
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> Word32 |
|
-> 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
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> Word32 |
|
-> m () |
Closes window
.
This function existed before 2.6, but the timestamp
argument was missing
in earlier versions.
Since: 2.6
get
getActions
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m [WindowActions] | Returns: bitmask of actions that can be done for |
Gets the actions that can be done for window
.
getApplication
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Application | Returns: the |
Gets the Application
to which window
belongs.
getClassGroup
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m ClassGroup | Returns: the |
Gets the ClassGroup
to which window
belongs.
Since: 2.2
getClassGroupName
windowGetClassGroupName Source #
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Text | Returns: the class group name for |
Gets the class group name from the <ulink
url="http://tronche.com/gui/x/icccm/sec-4.html#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 #
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Text | Returns: the class instance name for |
Gets the class instance name from the <ulink
url="http://tronche.com/gui/x/icccm/sec-4.html#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 #
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
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
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m CULong | Returns: the group leader of the group of windows to which |
Gets the group leader of the group of windows to which window
belongs.
getIcon
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Pixbuf | Returns: the icon for |
Deprecated: (Since version 41.0)Use windowGetIconSurface
instead.
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 #
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Bool | Returns: |
Gets whether a default fallback icon is used for window
(because none
was set on window
).
getIconName
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Text | Returns: the icon name of |
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.
getIconSurface
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Surface | Returns: a reference to the icon-surface for |
Gets the icon-surface to be used for window
. If no icon-surface was found, a
fallback icon-surface is used. windowGetIconIsFallback
can be used
to tell if the icon-surface is the fallback icon-surface.
getMiniIcon
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Pixbuf | Returns: the mini-icon for |
Deprecated: (Since version 41.0)Use windowGetMiniIconSurface
instead.
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.
getMiniIconSurface
windowGetMiniIconSurface Source #
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Surface | Returns: a reference to the mini-icon-surface for |
Gets the mini-icon-surface to be used for window
. If no mini-icon-surface
was found, a fallback mini-icon-surface is used. windowGetIconIsFallback
can be used to tell if the mini-icon-surface is the fallback mini-icon-surface.
getName
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Text | Returns: the name of |
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
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Int32 | Returns: the process ID of |
Gets the process ID of window
.
getRole
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Text | Returns: role for |
Gets the role for window
.
The role uniquely identifies a window among all windows that have the same
client leader window.
getScreen
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Screen | Returns: the |
Gets the Screen
window
is on.
getSessionId
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Text | Returns: the session ID for |
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 #
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Text | Returns: the session ID for |
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
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Int32 | Returns: the sort order of |
getState
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m [WindowState] | Returns: bitmask of active states for |
Gets the state of window
.
getTransient
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Window | Returns: the |
Gets the Window
for which window
is transient.
Since: 2.12
getWindowType
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m WindowType | Returns: the semantic type of |
Gets the semantic type of window
.
getWorkspace
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Workspace | Returns: the single current workspace |
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
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m CULong | Returns: the X window ID of |
Gets the X window ID of window
.
hasIconName
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Bool | Returns: |
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
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Bool | Returns: |
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
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Bool | Returns: |
Gets whether window
is above other windows. This state may change
anytime a Window::stateChanged signal gets emitted.
See windowMakeAbove
for more details on this state.
Since: 2.14
isActive
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Bool | Returns: |
Gets whether window
is the active window on its Screen
.
isBelow
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Bool | Returns: |
Gets whether window
is below other windows. This state may change
anytime a Window::stateChanged signal gets emitted.
See windowMakeBelow
for more details on this state.
Since: 2.20
isFullscreen
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Bool |
Gets whether window
is fullscreen. Fullscreen state may change
anytime a Window::stateChanged signal gets emitted.
Since: 2.8
isInViewport
:: (HasCallStack, MonadIO m, IsWindow a, IsWorkspace b) | |
=> a |
|
-> b |
|
-> m Bool | Returns: |
Gets True
if window
appears in the current viewport of workspace
.
Since: 2.4
isMaximized
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Bool | Returns: |
Gets whether window
is maximized. Maximization state may change
anytime a Window::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 #
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Bool | Returns: |
Gets whether window
is maximized horizontally. Horizontal maximization
state may change anytime a Window::stateChanged signal gets emitted.
isMaximizedVertically
windowIsMaximizedVertically Source #
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Bool | Returns: |
Gets whether window
is maximized vertically. vertiVal maximization
state may change anytime a Window::stateChanged signal gets emitted.
isMinimized
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Bool |
Gets whether window
is minimized. Minimization state may change anytime
a Window::stateChanged signal gets emitted.
isMostRecentlyActivated
windowIsMostRecentlyActivated Source #
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Bool | Returns: |
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
:: (HasCallStack, MonadIO m, IsWindow a, IsWorkspace b) | |
=> a |
|
-> b |
|
-> m Bool | Returns: |
Gets whether window
appears on workspace
.
isPinned
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Bool | Returns: |
Gets whether window
is on all workspace. Pinned state may change
anytime a Window::workspaceChanged signal gets emitted, but not when
a Window::stateChanged gets emitted.
isShaded
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Bool |
Gets whether window
is shaded. Shade state may change anytime
a Window::stateChanged signal gets emitted.
isSkipPager
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Bool | Returns: |
Gets whether window
is included on pagers. This state may change
anytime a Window::stateChanged signal gets emitted.
isSkipTasklist
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Bool | Returns: |
Gets whether window
is included on tasklists. This state may change
anytime a Window::stateChanged signal gets emitted.
isSticky
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Bool | Returns: |
Gets whether window
is sticky. Sticky state may change
anytime a Window::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 #
:: (HasCallStack, MonadIO m, IsWindow a, IsWorkspace b) | |
=> a |
|
-> b |
|
-> m Bool | Returns: |
Like windowIsOnWorkspace
, but also checks that
the window is in a visible state (i.e. not minimized or shaded).
keyboardMove
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m () |
Asks the window manager to start moving window
via the keyboard.
keyboardSize
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m () |
Asks the window manager to start resizing window
via the keyboard.
makeAbove
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> 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
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m () |
Asks the window manager to put window
below most windows.
Since: 2.20
maximize
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m () |
Asks the window manager to maximize window
.
maximizeHorizontally
windowMaximizeHorizontally Source #
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m () |
Asks the window manager to maximize horizontally window
.
maximizeVertically
windowMaximizeVertically Source #
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m () |
Asks the window manager to maximize vertically window
.
minimize
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m () |
Minimizes window
.
moveToWorkspace
windowMoveToWorkspace Source #
:: (HasCallStack, MonadIO m, IsWindow a, IsWorkspace b) | |
=> a |
|
-> b |
|
-> 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
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Bool |
Gets whether window
needs attention. This state may change anytime
a Window::stateChanged signal gets emitted.
This state depends on flags such as the demands_attention and is_urgent hints.
Since: 2.12
orTransientNeedsAttention
windowOrTransientNeedsAttention Source #
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Bool | Returns: |
Gets whether window
or one of its transients needs attention. This state
may change anytime a Window::stateChanged signal gets emitted.
Since: 2.12
pin
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m () |
Asks the window manager to put window
on all workspaces.
setFullscreen
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> Bool |
|
-> m () |
Asks the window manager to set the fullscreen state of window
according to
fullscreen
.
Since: 2.8
setGeometry
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> WindowGravity |
|
-> [WindowMoveResizeMask] |
|
-> Int32 |
|
-> Int32 |
|
-> Int32 |
|
-> Int32 |
|
-> 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 #
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> Int32 |
|
-> Int32 |
|
-> Int32 |
|
-> Int32 |
|
-> m () |
Sets the icon geometry for window
. A typical use case for this is the
destination of the minimization animation of window
.
setSkipPager
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> Bool |
|
-> m () |
Asks the window manager to make window
included or not included on pagers.
setSkipTasklist
windowSetSkipTasklist Source #
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> Bool |
|
-> m () |
Asks the window manager to make window
included or not included on
tasklists.
setSortOrder
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> Int32 |
|
-> m () |
setWindowType
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> WindowType |
|
-> m () |
Sets the semantic type of window
to wintype
.
Since: 2.12
shade
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m () |
Asks the window manager to shade window
.
stick
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> 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 #
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m Bool | Returns: |
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
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> 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
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> 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
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m () |
Asks the window manager to unmaximize window
.
unmaximizeHorizontally
windowUnmaximizeHorizontally Source #
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m () |
Asks the window manager to unmaximize horizontally window
.
unmaximizeVertically
windowUnmaximizeVertically Source #
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m () |
Asks the window manager to unmaximize vertically window
.
unminimize
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> Word32 |
|
-> m () |
Unminimizes window
by activating it or one of its transients. See
windowActivateTransient
for details on how the activation is done.
unpin
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> 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
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m () |
Asks the window manager to unshade window
.
unstick
:: (HasCallStack, MonadIO m, IsWindow a) | |
=> a |
|
-> m () |
Asks the window manager to not have window
's position fixed on the
screen when the workspace or viewport scrolls.
Signals
actionsChanged
type WindowActionsChangedCallback Source #
= [WindowActions] |
|
-> [WindowActions] |
|
-> IO () |
Emitted when the actions availabilities for window
change.
afterWindowActionsChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: 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
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onWindowActionsChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: 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 WindowClassChangedCallback = IO () Source #
Emitted when the class name or instance name of window
changes.
afterWindowClassChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: 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
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onWindowClassChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: 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 WindowGeometryChangedCallback = IO () Source #
Emitted when the geometry of window
changes.
afterWindowGeometryChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: 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
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onWindowGeometryChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: 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 WindowIconChangedCallback = IO () Source #
Emitted when the icon of window
changes.
afterWindowIconChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: 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
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onWindowIconChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: 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 WindowNameChangedCallback = IO () Source #
Emitted when the name of window
changes.
afterWindowNameChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: 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
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onWindowNameChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: 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 WindowRoleChangedCallback = IO () Source #
Emitted when the role of window
changes.
afterWindowRoleChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: 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
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onWindowRoleChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: 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 WindowStateChangedCallback Source #
= [WindowState] |
|
-> [WindowState] |
|
-> 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 -> ((?self :: 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
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onWindowStateChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: 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 WindowTypeChangedCallback = IO () Source #
Emitted when the EWMH type hint of the window changes.
Since: 3.20
afterWindowTypeChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: 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
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onWindowTypeChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: 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 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 -> ((?self :: 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
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onWindowWorkspaceChanged :: (IsWindow a, MonadIO m) => a -> ((?self :: 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