class NETWinInfo |
|
|
Common API for application window properties/protocols. The NETWinInfo class provides a common API for clients and window managers to set/read/change properties on an application window as defined by the NET Window Manager Specification.
Author Bradley T. Hughes See also NET See also NETRootInfo See also http://www.freedesktop.org/standards/wm-spec/
|
|
|
This constructor differs from the above one only in the way it accepts the list of properties the client is interested in. The properties argument is equivalent to the first element of the properties array in the above constructor.
|
|
Creates a shared copy of the specified NETWinInfo object.
wininfo - the NETWinInfo to copy
|
|
Returns actions that the window manager allows for the window. |
|
Sentinel value to indicate that the client wishes to be visible on all desktops. Returns the value to be on all desktops A Window Manager should subclass NETWinInfo and reimplement this function when it wants to know when a Client made a request to change desktops (ie. move to another desktop).
desktop - the number of the desktop
|
|
A Window Manager should subclass NETWinInfo and reimplement this function when it wants to know when a Client made a request to change state (ie. to Shade / Unshade).
state - the new state
mask - the mask for the state
|
|
Returns the client machine for the window (i.e. WM_CLIENT_MACHINE property). |
|
Returns the desktop where the window is residing. NOTE: KDE uses virtual desktops and does not directly support viewport in any way. It is however mapped to virtual desktops if needed.
ignore_viewport - if false, viewport is mapped to virtual desktops Returns the number of the window's desktop See also OnAllDesktops()
|
|
This function takes the passed XEvent and returns an OR'ed list of NETWinInfo properties that have changed in the properties argument. The new information will be read immediately by the class. The elements of the properties argument are as they would be passed to the constructor, if the array is not large enough, changed properties that don't fit in it won't be listed there (they'll be updated in the class though).
event - the event properties - properties that changed properties_size - size of the passed properties array
|
|
This function takes the pass XEvent and returns an OR'ed list of NETWinInfo properties that have changed. The new information will be read immediately by the class. This overloaded version returns only a single mask, and therefore cannot check state of all properties like the other variant.
event - the event Returns the properties
|
|
Returns the extended (partial) strut specified by this client. See _NET_WM_STRUT_PARTIAL in the spec.
|
|
Returns the leader window for the group the window is in, if any. |
|
Returns whether or not this client handles icons. Returns true if this client handles icons, false otherwise
|
|
Assignment operator. Ensures that the shared data reference counts are correct. Returns true if the window has any window type set, even if the type itself is not known to this implementation. Presence of a window type as specified by the NETWM spec is considered as the window supporting this specification. Returns true if the window has support for the NETWM spec
|
|
Returns an icon. If width and height are passed, the icon returned will be the closest it can find (the next biggest). If width and height are omitted, then the largest icon in the list is returned.
width - the preferred width for the icon, -1 to ignore
height - the preferred height for the icon, -1 to ignore Returns the icon
|
|
Returns the icon geometry. Returns the geometry of the icon
|
|
Returns the iconic name of the window in UTF-8 format. Note that this has nothing to do with icons, but it's for "iconic" representations of the window (taskbars etc.), that should be shown when the window is in iconic state. See description of _NET_WM_ICON_NAME for details. Returns the iconic name
|
|
Places the window frame geometry in frame, and the application window geometry in window. Both geometries are relative to the root window.
frame - the geometry for the frame
window - the geometry for the window
|
|
Returns the mapping state for the window (see the NET base class documentation for a description of mapping state). Returns the mapping state
|
|
Returns the name of the window in UTF-8 format. Returns the name of the window
|
|
Returns the opacity of the window. |
|
Returns the properties argument passed to the constructor. The size is the maximum array size the constructor accepts.
|
|
Returns the process id for the client window. Returns the process id of the window
|
|
Sets actions that the window manager allows for the window. |
|
Set which window the desktop is (should be) on. NOTE: KDE uses virtual desktops and does not directly support viewport in any way. It is however mapped to virtual desktops if needed.
desktop - the number of the new desktop ignore_viewport - if false, viewport is mapped to virtual desktops See also OnAllDesktops()
|
|
Set the extended (partial) strut for the application window.
extended_strut - the new strut
|
|
Set the frame decoration strut, i.e. the width of the decoration borders.
strut - the new strut
|
|
Set whether this application window handles icons.
handled - true if the window handles icons, false otherwise
|
|
Set icons for the application window. If replace is True, then the specified icon is defined to be the only icon. If replace is False, then the specified icon is added to a list of icons.
icon - the new icon
replace - true to replace, false to append to the list of icons
|
|
Set the icon geometry for the application window.
geometry - the new icon geometry
|
|
Sets the iconic name for the application window.
name - the new iconic name
|
|
Sets the name for the application window.
name - the new name of the window
|
|
Sets opacity (0 = transparent, 0xffffffff = opaque ) on the window. |
|
Set the application window's process id.
pid - the window's process id
|
|
Sets the startup notification id id on the window. |
|
Set the state for the application window (see the NET base class documentation for a description of window state).
state - the name state
mask - the mask for the state
|
|
Deprecated use setExtendedStrut() Set the strut for the application window.
strut - the new strut
|
|
Sets user timestamp time on the window (property _NET_WM_USER_TIME). The timestamp is expressed as XServer time. If a window is shown with user timestamp older than the time of the last user action, it won't be activated after being shown, with the special value 0 meaning not to activate the window after being shown. |
|
For Window Managers only: set the visible iconic name ( i.e. xterm, xterm <2>, xterm <3>, ... )
name - the new visible iconic name
|
|
For Window Managers only: set the visible name ( i.e. xterm, xterm <2>, xterm <3>, ... )
visibleName - the new visible name
|
|
Sets the window type for this client (see the NET base class documentation for a description of the various window types).
type - the window type
|
|
Returns the startup notification id of the window. |
|
Returns the state of the window (see the NET base class documentation for a description of the various states). Returns the state of the window
|
|
Deprecated use strutPartial() Returns the strut specified by this client. Returns the strut of the window
|
|
Returns the WM_TRANSIENT_FOR property for the window, i.e. the mainwindow for this window. |
|
Returns the time of last user action on the window, or -1 if not set. |
|
Returns the visible iconic name as set by the window manager in UTF-8 format. Note that this has nothing to do with icons, but it's for "iconic" representations of the window (taskbars etc.), that should be shown when the window is in iconic state. See description of _NET_WM_VISIBLE_ICON_NAME for details. Returns the visible iconic name
|
|
Returns the visible name as set by the window manager in UTF-8 format. Returns the visible name of the window
|
|
Returns the class component of the window class for the window (i.e. WM_CLASS property). |
|
Returns the name component of the window class for the window (i.e. WM_CLASS property). |
|
Returns the window role for the window (i.e. WM_WINDOW_ROLE property). |
|
Returns the window type for this client (see the NET base class documentation for a description of the various window types). Since clients may specify several windows types for a window in order to support backwards compatibility and extensions not available in the NETWM spec, you should specify all window types you application supports (see the NET.WindowTypeMask mask values for various window types). This method will return the first window type that is listed in the supported types, or NET.Unknown if none of the window types is supported. Returns the type of the window
|