KWin::Client

Read-only Properties

boolactive: Whether this Client is active or not. Use Workspace::activateClient() to activate a Client. Workspace::activateClient

QStringcaption: The Caption of the Client. Read from WM_NAME property together with a suffix for hostname and shortcut. To read only the caption as provided by WM_NAME, use the getter with an additional false value.

boolcloseable: Whether the window can be closed by the user. The value is evaluated each time the getter is called. Because of that no changed signal is provided.

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

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

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

boolmodal: Whether the Client represents a modal window.

boolmoveable: Whether the Client 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. moveableAcrossScreens

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

boolprovidesContextHelp: Whether the Client provides context help. Mostly needed by decorations to decide whether to show the help button or not.Returns whether the window provides context help or not. If it does, you should show a help menu item or a help button like '?' and call contextHelp() if this is invoked.contextHelp()

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

boolshadeable: Whether the Client can be shaded. The property is evaluated each time it is invoked. Because of that there is no notify signal.

booltransient: Whether the Client is a transient Window to another Window. transientFor

KWin::ClienttransientFor: The Client to which this Client is a transient if any.

QSizebasicUnit: By how much the window wishes to grow/shrink at least. Usually QSize(1,1). MAY BE DISOBEYED BY THE WM! It's only for information, do NOT rely on it at all. The value is evaluated each time the getter is called. Because of that no changed signal is provided.

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

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

boolspecialWindow: 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.

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

QPixmapicon

KWin::ClientGroupclientGroup: The "Window Tabs" Group this Client belongs to.

Read-write Properties

intdesktop: The desktop this Client is on. If the Client is on all desktops the property has value -1.Returns the virtual desktop within the workspace() the client window is located in, 0 if it isn't located on any special desktop (not mapped yet), or NET::OnAllDesktops. Do not use desktop() directly, use isOnDesktop() instead.

boolfullScreen: Whether this Client is fullScreen. A Client 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 Client does not use the legacy hack. To be sure whether the state changed, connect to the notify signal.

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

boolkeepAbove: Whether the Client is set to be kept above other windows.

boolkeepBelow: Whether the Client is set to be kept below other windows.

boolminimized: Whether the Client is minimized.

boolshade: Whether the Client is shaded.

boolskipSwitcher: Whether the Client should be excluded from window switching effects.

clientGroupChanged(): Emitted whenever the Client's ClientGroup changed. That is whenever the Client is moved to another group, but not when a Client gets added or removed to the Client's ClientGroup.

Functions

closeWindow(): Closes the window by either sending a delete_window message or using XKill.

KWin::ClientGroup

Read-only Properties

QSizeminSize: Combined minimum size of all clients in the group.

QSizemaxSize: Combined maximum size of all clients in the group.

intvisibleClientIndex: The index of the visible Client in this group.

QList<KWin::Client*>clients: The Clients in this group.

Read-write Properties

KWin::Clientvisible: Currently visible client in this group.

Signals

visibleChanged(): Emitted when the visible Client in this group changes.

minSizeChanged(): Emitted when the group's minimum size changes.

maxSizeChanged(): Emitted when the group's maximum size changes.

Functions

add(KWin::Client *c, int before=-1, bool becomeVisible=false): Adds c to the group before before in the list. If becomeVisible is true then the added client will become also the visible client.

remove(int index, const QRect &newGeom=QRect(), bool toNullGroup=false): Remove the client at index index from the group. If newGeom is set then the client will move and resize to the specified geometry, otherwise it will stay where the group is located. If toNullGroup is not true then the client will be added to a new group of its own.

remove(KWin::Client *c, const QRect &newGeom=QRect(), bool toNullGroup=false): Remove c from the group. If newGeom is set then the client will move and resize to the specified geometry, otherwise it will stay where the group is located. If toNullGroup is not true then the client will be added to a new group of its own.

removeAll(): Remove all clients from this group. Results in all clients except the first being moved to a group of their own.

closeAll(): Close all clients in this group.

move(int index, int before): Move the client at index index to the position before the client at index before in the list.

move(KWin::Client *c, KWin::Client *before): Move c to the position before before in the list.