Contents

Window QML Type (Uncreatable)

The window type represents a window. More...

Import Statement: import org.kde.kwin

Note: This is an uncreatable type. It cannot be instantiated in QML.

Properties

Detailed Description

Property Documentation

active : bool

Whether this Window is active or not. Use Workspace::activateWindow() to activate a Window.

See also Workspace::activateWindow.

activities : list<string>

The activities this client is on. If it's on all activities the property is empty.

appletPopup : bool

Returns whether the window is an applet popup.

applicationMenuActive : bool

Whether the application menu for this Window is currently opened

bufferGeometry : RectF

This property holds the rectangle that the pixmap or buffer of this Window occupies on the screen. This rectangle includes invisible portions of the window, e.g. client-side drop shadows, etc.

caption : string

The Caption of the Window. Read from WM_NAME property together with a suffix for hostname and shortcut. To read only the caption as provided by WM_NAME, use captionNormal.

captionNormal : string

The Caption of the Window. Read from WM_NAME property.

clientGeometry : RectF

The geometry of the Window without frame borders.

closeable : bool

Whether the window can be closed by the user.

colorScheme : string

The color scheme set on this window Absolute file path, or name of palette in the user's config directory following KColorSchemes format. An empty string indicates the default palette from kdeglobals is used.

Note: This indicates the colour scheme requested, which might differ from the theme applied if the colorScheme cannot be found

comboBox : bool

Returns whether the window is a combobox popup. See _NET_WM_WINDOW_TYPE_COMBO at https://specifications.freedesktop.org/wm-spec .

criticalNotification : bool

Returns whether the window is a window with a critical notification.

decorationHasAlpha : bool

Whether the decoration is currently using an alpha channel.

deleted : bool

Whether this Window represents an already deleted window and only kept for the compositor for animations.

demandsAttention : bool

Whether window state _NET_WM_STATE_DEMANDS_ATTENTION is set. This state indicates that some action in or with the window happened. For example, it may be set by the Window Manager if the window requested activation but the Window Manager refused it, or the application may set it if it finished some work. This state may be set by both the Window and the Window Manager. It should be unset by the Window Manager when it decides the window got the required attention (usually, that it got activated).

description : string

A client-provided description of the window

desktopFileName : string

The desktop file name of the application this Window belongs to.

This is either the base name without full path and without file extension of the desktop file for the window's application (e.g. "org.kde.foo").

The application's desktop file name can also be the full path to the desktop file (e.g. "/opt/kde/share/org.kde.foo.desktop") in case it's not in a standard location.

desktopWindow : bool

Returns whether the window is a desktop background window (the one with wallpaper). See _NET_WM_WINDOW_TYPE_DESKTOP at https://specifications.freedesktop.org/wm-spec .

desktops : list<VirtualDesktop>

The virtual desktops this client is on. If it's on all desktops, the list is empty.

dialog : bool

Returns whether the window is a dialog window. See _NET_WM_WINDOW_TYPE_DIALOG at https://specifications.freedesktop.org/wm-spec .

dndIcon : bool

Returns whether the window is a Drag&Drop icon. See _NET_WM_WINDOW_TYPE_DND at https://specifications.freedesktop.org/wm-spec .

dock : bool

Returns whether the window is a dock (i.e. a panel). See _NET_WM_WINDOW_TYPE_DOCK at https://specifications.freedesktop.org/wm-spec .

Returns whether the window is a dropdown menu (i.e. a popup directly or indirectly open from the application's menubar). See _NET_WM_WINDOW_TYPE_DROPDOWN_MENU at https://specifications.freedesktop.org/wm-spec .

excludeFromCapture : bool

Exclude this window from ScreenCast. It will also be applied for all transient windows recursively.

frameGeometry : RectF

The geometry of this Window. Be aware that depending on resize mode the frameGeometryChanged signal might be emitted at each resize step or only at the end of the resize operation.

fullScreen : bool

Whether this Window is fullScreen. A Window might either be fullScreen due to the _NET_WM property or through a legacy support hack. The fullScreen state can only be changed if the Window does not use the legacy hack. To be sure whether the state changed, connect to the notify signal.

fullScreenable : bool

Whether the Window can be set to fullScreen. The property is evaluated each time it is invoked. Because of that there is no notify signal.

hasApplicationMenu : bool

Whether an application menu is available for this Window

height : real

This property holds the height of the Window's frame geometry.

hidden : bool

Whether this window is hidden. It's usually the case with auto-hide panels.

icon : icon

iconGeometry : RectF

The optional geometry representing the minimized Window in e.g a taskbar. See _NET_WM_ICON_GEOMETRY at https://specifications.freedesktop.org/wm-spec . The value is evaluated each time the getter is called. Because of that no changed signal is provided.

inputMethod : bool

Returns whether this window is an input method window. This is only used for Wayland.

internalId : uuid

This property holds a UUID to uniquely identify this Window.

keepAbove : bool

Whether the Window is set to be kept above other windows.

keepBelow : bool

Whether the Window is set to be kept below other windows.

layer : enumeration

managed : bool

Whether this Window is managed by KWin (it has control over its placement and other aspects, as opposed to override-redirect windows that are entirely handled by the application).

maxSize : size

Maximum size as specified in WM_NORMAL_HINTS

maximizable : bool

Whether the Window can be maximized both horizontally and vertically. The property is evaluated each time it is invoked. Because of that there is no notify signal.

maximizeMode : enumeration

Whether the window is maximized horizontally, vertically or fully. This is read only, in order to maximize from a script use the setMaximize function

See also setMaximize.

Returns whether the window is a torn-off menu. See _NET_WM_WINDOW_TYPE_MENU at https://specifications.freedesktop.org/wm-spec .

minSize : size

Minimum size as specified in WM_NORMAL_HINTS

minimizable : bool

Whether the Window can be minimized. The property is evaluated each time it is invoked. Because of that there is no notify signal.

minimized : bool

Whether the Window is minimized.

Whether the Window represents a modal window.

move : bool

Whether the Window is currently being moved by the user. Notify signal is emitted when the Window starts or ends move/resize mode.

moveable : bool

Whether the Window is moveable. Even if it is not moveable, it might be possible to move it to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal.

See also moveableAcrossScreens.

moveableAcrossScreens : bool

Whether the Window can be moved to another screen. The property is evaluated each time it is invoked. Because of that there is no notify signal.

See also moveable.

noBorder : bool

Whether the window has a decoration or not. This property is not allowed to be set by applications themselves. The decision whether a window has a border or not belongs to the window manager. If this property gets abused by application developers, it will be removed again.

normalWindow : bool

Returns whether the window is a "normal" window, i.e. an application or any other window for which none of the specialized window types fit. See _NET_WM_WINDOW_TYPE_NORMAL at https://specifications.freedesktop.org/wm-spec .

notification : bool

Returns whether the window is a window with a notification. See _NET_WM_WINDOW_TYPE_NOTIFICATION at https://specifications.freedesktop.org/wm-spec .

onAllDesktops : bool

Whether the Window is on all desktops. That is desktop is -1.

onScreenDisplay : bool

Returns whether the window is an On Screen Display.

opacity : real

outline : bool

Whether this Window represents the outline.

Note: It's always false if compositing is turned off.

output : LogicalOutput

The output where the window center is on

pid : int

The pid of the process owning this window.

popupMenu : bool

Returns whether the window is a popup menu (that is not a torn-off or dropdown menu). See _NET_WM_WINDOW_TYPE_POPUP_MENU at https://specifications.freedesktop.org/wm-spec .

Whether the window is a popup.

pos : point

This property holds the position of the Window's frame geometry.

providesContextHelp : bool

Whether the Window provides context help. Mostly needed by decorations to decide whether to show the help button or not.

rect : RectF

resize : bool

Whether the Window is currently being resized by the user. Notify signal is emitted when the Window starts or ends move/resize mode.

resizeable : bool

Whether the Window can be resized. The property is evaluated each time it is invoked. Because of that there is no notify signal.

resourceClass : string

resourceName : string

size : size

This property holds the size of the Window's frame geometry.

skipPager : bool

Indicates that the window should not be included on a Pager.

skipSwitcher : bool

Whether the Window should be excluded from window switching effects.

skipTaskbar : bool

Indicates that the window should not be included on a taskbar.

skipsCloseAnimation : bool

Whether the window does not want to be animated on window close. There are legit reasons for this like a screenshot application which does not want its window being captured.

specialWindow : bool

Returns whether the window is any of special windows types (desktop, dock, splash, ...), i.e. window types that usually don't have a window frame and the user does not use window management (moving, raising,...) on them. The value is evaluated each time the getter is called. Because of that no changed signal is provided.

splash : bool

Returns whether the window is a splashscreen. Note that many (especially older) applications do not support marking their splash windows with this type. See _NET_WM_WINDOW_TYPE_SPLASH at https://specifications.freedesktop.org/wm-spec .

stackingOrder : int

The position of this window within Workspace's window stack.

tag : string

A client-provided tag of the window. Not necessarily unique, but can be used to identify similar windows across application restarts

tile : Tile

The Tile this window is associated to, if any

toolbar : bool

Returns whether the window is a standalone (detached) toolbar window. See _NET_WM_WINDOW_TYPE_TOOLBAR at https://specifications.freedesktop.org/wm-spec .

tooltip : bool

Returns whether the window is a tooltip. See _NET_WM_WINDOW_TYPE_TOOLTIP at https://specifications.freedesktop.org/wm-spec .

transient : bool

Whether the Window is a transient Window to another Window.

See also transientFor.

transientFor : Window

The Window to which this Window is a transient if any.

unresponsive : bool

Whether this window is unresponsive.

When an application failed to react on a ping request in time, it is considered unresponsive. This usually indicates that the application froze or crashed.

utility : bool

Returns whether the window is a utility window, such as a tool window. See _NET_WM_WINDOW_TYPE_UTILITY at https://specifications.freedesktop.org/wm-spec .

wantsInput : bool

Whether the Window can accept keyboard focus. The value is evaluated each time the getter is called. Because of that no changed signal is provided.

width : real

This property holds the width of the Window's frame geometry.

windowRole : string

windowType : enumeration

Returns the NETWM window type. See https://specifications.freedesktop.org/wm-spec .

x : real

This property holds the x position of the Window's frame geometry.

y : real

This property holds the y position of the Window's frame geometry.