Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Client

Client, also known as window. Represents KWin::Window.

Hierarchy

Index

Properties

Readonly active

active: boolean

Whether the window is active.

activeChanged

activeChanged: QSignal
see

active

Readonly activities

activities: string[]

On which activities the toplevel is present

activitiesChanged

activitiesChanged: QSignal

TODO: I could not find anything about signal in the KWin source. Probably it does not exist here. It exists in KWin::Window though.

Readonly caption

caption: string

Window caption (The text in the titlebar).

Readonly clientPos

clientPos: QPoint

Client position

Readonly clientSize

clientSize: QSize

Client size

desktop

desktop: number

The desktop this window is on. If the window is on all desktops the property has value -1.

desktopChanged

desktopChanged: QSignal
see

active

Readonly dialog

dialog: boolean

Whether the window is a dialog window.

frameGeometry

frameGeometry: QRectF

This property holds the geometry of the Toplevel, excluding invisible portions, e.g. server-side and client-side drop-shadows, etc.

frameGeometryChanged

frameGeometryChanged: QSignal

This signal is emitted when the Toplevel's frame geometry changes.

fullScreen

fullScreen: boolean

Whether the window is fullscreen

keepAbove

keepAbove: boolean

Whether the window is set to be above all

keepBelow

keepBelow: boolean

Whether the window is set to be below all

Readonly maxSize

maxSize: QSize

Maximum allowed size for a window.

Readonly minSize

minSize: QSize

Minimum allowed size for a window.

minimized

minimized: boolean

Whether the window is minimized

Readonly modal

modal: boolean

Whether the window is modal or not.

Readonly move

move: boolean

Whether the window is currently being moved by the user.

moveResizedChanged

moveResizedChanged: QSignal
see

move

noBorder

noBorder: boolean

Whether the window has borders (window decorations)

onAllDesktops

onAllDesktops: boolean

Whether the window is set to be on all desktops

Readonly resize

resize: boolean

Whether the window is currently being resized by the user.

Readonly resizeable

resizeable: boolean

Whether the window is resizable

Readonly resourceClass

resourceClass: QByteArray

TODO: ???

Readonly resourceName

resourceName: QByteArray

TODO: ???

Readonly screen

screen: number

On which screen toplevel is

screenChanged

screenChanged: QSignal

Emitted whenever the Toplevel's screen changes. This can happen either in consequence to a screen being removed/added or if the Toplevel's geometry changes.

shade

shade: boolean

Whether the Client is shaded.

shadeChanged

shadeChanged: QSignal

Whether the window shading state changed

Readonly specialWindow

specialWindow: boolean

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.

Readonly splash

splash: boolean

Whether the window is a splashscreen.

Readonly transient

transient: boolean

Whether the windows is transient to an other windows, i.e. it is a sub window belonging to a main window

Readonly utility

utility: boolean

Whether the window is a utility window, such as a tool window.

Readonly windowId

windowId: number

Window id in KWin

Readonly windowRole

windowRole: QByteArray

Window role property

windowShown

windowShown: QSignal

Emitted when the Toplevel is shown?

Generated using TypeDoc