Development/Tutorials/KWin/Scripting/API

workspace[singleton]

Events

workspace.currentDesktopChanged

• Emitted when the user switches from a virtual desktop to another.
  • old_desk {integer}: The number of the virtual desktop the user switched from.

workspace.desktopPresenceChanged

• Emitted whenever a client is moved across virtual desktops. The client's previous desktop is available through the old_desk parameter, whereas the current desktop can be fetched using moved_client.desktop
  • moved_client {client}: The client which was moved from desktop old_desk to the new one
  • old_desk {integer}: The previous desktop on which the client was present

workspace.clientAdded

• Emitted whenever a new client is added to the workspace. This generally occurs when a new window is opened which includes dialog boxes, windows etc. However, it is NOT emitted for unmanaged clients like the Alt+Tab switcher.
  • added_client {client}: The client which was added.

workspace.clientManaging

• Emitted whenever a client is being managed by the KWin subsystem. The difference between workspace.clientManaging and workspace.clientAdded is that clientManaging is emitted BEFORE clientAdded. Also, if KWin is restarted with a list of clients C, then the clientManaging event will be emitted for every client in C, but clientAdded will not.
  • managing_client {client}: The client which is being managed.

workspace.clientMinimized

• Emitted whenever a client is minimized.
  • minimized_client {client}: The client which was minimized.

workspace.clientMaximizeSet

• Emitted whenever a client is maximized in a particular orientation. The orientation i.e. the rectangular direction in which the client was specified to occupy the entire available space is specified by the two parameters horizontally and vertically. If both are true, the client was maximized fully i.e. asked to occupy the entire workspace are available.
  • maximized_client {client}: The client which was maximized (in a certain orientation).
  • horizontally {boolean}: (true) if the client was maximized horizontally, (false) otherwise.
  • vertically {boolean}: (true) if the client was maximized vertically, (false) otherwise.

workspace.killWindowCalled

• Emitted whenever the user requests a Kill Window [generally using the Ctrl+Esc combination]. The parameter killwindow_client is not completely safe and may return kill windows out of order of invocation. This is just a fancy function, avoid using. Instead, use workspace.clientAdded and filter for incoming Kill Windows.
  • killwindow_client {client}: The client handle to the kill window that was called.

workspace.clientActivated

• Emitted whenever a client is given focus or 'activated'.
  • activated_client {client}: The client which was activated (or received focus).

workspace.clientFullScreenSet

• Emitted whenever a client is set to full screen or unset. The fss_set parameter can be used to determine whether the client was set or unset.
  • fss_set {boolean}: (true) if the client was switched to full screen mode, (false) if it was switched from full screen mode.
  • fss_client {client}: The client which was set/unset to fullscreen.

workspace.clientUnminimized

• Emitted whenever a client is Unminimized (or restored).
  • unm_client {client}: The client which was unminimzed.

Methods

workspace.getAllClients[ret: Array(client)]

workspace.getAllClients(desktop_no {integer})

• Gets all clients on the virtual desktop desktop_no. If no desktop number is specified then it fetches all the clients. To specifically isolate clients which are on 'All desktops', set the desktop_no parameter to -1.
• desktop_no {integer}: The desktop number belonging to which the clients are to be fetched.

workspace.dimensions[ret: qsize]

workspace.dimensions()

• Returns the dimensions of the workspace in pixels.

workspace.desktopGridSize[ret: qsize]

workspace.desktopGridSize()

• Returns the desktop size in grid units. In essence, it returns the order of a rectangular matrix, where each element is a virtual desktop and the rows and columns specify the number of virtual desktops and the way of arrangement.

workspace.activeClient[ret: client]

workspace.activeClient()

• Returns the client which currently has focus.

workspace.clientGroups[ret: Array(clientgroup)]

workspace.clientGroups()

• Returns an array of all the ClientGroups from the current workspace.

Properties

workspace.currentDesktop [ret: integer] [GO]

• Returns the current desktop number of the workspace.

toplevel[floating]

Methods

toplevel.x[ret: integer]

toplevel.x()

• Returns the x co-ordinate of the toplevel client (or the client).

toplevel.y[ret: integer]

toplevel.y()

• Returns the y co-ordinate of the toplevel client (or the client).

toplevel.width[ret: integer]

toplevel.width()

• Returns the width of the toplevel client (or the client).

toplevel.height[ret: integer]

toplevel.height()

• Returns the height of the toplevel client (or the client).

toplevel.size[ret: qsize]

toplevel.size()

• Returns the size of the toplevel client (or the client).

toplevel.pos[ret: qpoint]

toplevel.pos()

• Returns the position of the toplevel client (or the client).

toplevel.opacity[ret: decimal]

toplevel.opacity()

• Returns the opacity (or 1 - transperency) of the toplevel client (or the client).

toplevel.hasAlpha[ret: bool]

toplevel.hasAlpha()

• Returns (true) if the client can be made translucent i.e. opacity can be set to values other than 0 or 1, (false) otherwise. NOTE: If compositing is OFF, then clients may still show that translucency is possible, but translucency is not possible without compositing being ON.

toplevel.setOpacity

toplevel.setOpacity(opacity_v {decimal})

• Sets the opacity of the client to opacity_v or sets transperency to (1 - opacity_v). NOTE: If compositing is OFF, this function has no effect for any values between 0 and 1 (exclusive).

setOpacity(opacity_v {decimal})

• opacity_v {decimal}: The opacity to be set (on a scale of 0-1).

client[floating]

Events

client.clientMoved

• Emitted whenever the client is moved or it's geometry changed. This includes when a client is resized.

client.minimized

• Emitted whenever a client is minimized. Equivalent to workspace.clientMinimized, but for a specific client. Use wherever possible instead of workspace.clientMinimzed to improve performance.

client.maximizeSet

• Emitted when the client is maximized in a particular orientation. The orientation i.e. the rectangular direction in which the client was specified to occupy the entire available space is specified by the two parameters horizontally and vertically. If both are true, the client was maximized fully i.e. asked to occupy the entire workspace are available. Equivalent to workspace.clientMaximizeSet, but for a specific client. Use wherever possible instead of workspace.clientMaximizeSet to improve performance.
  • horizontally {boolean}: (true) if the client was maximized horizontally, (false) otherwise.
  • vertically {boolean}: (true) if the client was maximized vertically, (false) otherwise.

client.activated

• Emitted whenever the client is activated (or gets focus). Equivalent to workspace.clientActivated but for a specific client. Use wherever possible instead of workspace.clientActivated to improve performance.

client.unminimized

• Emitted whenever the given client is unminimized. Equivalent of workspace.clientUnminimzed but for a specific client. Use wherever possible instead of workspace.clientUnminimized to improve performance.

client.fullScreenSet

• Emitted whenever the client's fullscreen mode is toggled. fss_set specifies whether the client was set to or from fullscreen mode.
  • fss_set {boolean}: (true) if the client was set to full screen mode, (false) if the client was set from full screen mode.

Methods

client.caption[ret: string]

client.caption()

• Returns the caption of the caption (or the title) of the window.

client.close

client.close()

• Closes the given client using killClient.

client.move[variable parameter styles]

client.move(location {qpoint}, emitjs {boolean})

client.move(x {integer}, y {integer}, emitjs {boolean})

• Moves the client to the specified location keeping the height and width of the client same.
  • location {qpoint}: The (x, y) point to where the top left corner of the client must be moved to keeping the current height and width same.
  • emitjs {boolean}: EmitJS value (defaults to true).
  • x {integer}: The x co-ordinate value of the point to where the top left corner of the client must be moved to keeping the current height and width same.
  • y {integer}: The y co-ordinate value of the point to where the top left corner of the client must be moved to keeping the current height and width same.

client.resize[variable parameter styles]

client.resize(size {qsize}, emitJS {boolean})

client.resize(w {integer}, h {integer}, emitJS {boolean})

• Resizes the client to the specified size without changing its position.
  • size {qsize}: The size to which the client is to be resized.
  • emitJS {boolean}: EmitJS value (defaults to true).
  • w {integer}: New width for the client.
  • h {integer}: New height for the client.
  • emitJS {boolean}: EmitJS value (defaults to true).

client.setGeometry[variable parameter styles]

client.setGeometry(geometry {qrect}, emitJS {boolean})

client.setGeometry(x {integer}, y {integer}, w {integer}, h {integer})

• Sets the geometry of the client i.e. sets is size and location according to the provided parameters.
  • geometry {qrect}: The new geometry which is to be set for the client.
  • emitJS {boolean}: EmitJS value (defaults to true).
  • x {integer}: The x co-ordinate of the new geometry.
  • y {integer}: The y co-ordinate of the new geometry.
  • w {integer}: The width of the new geometry.
  • h {integer}: The height of the new geometry.

client.getWindowInfo[ret: windowinfo]

client.getWindowInfo()

• Returns a windowinfo object which can be used to get further information about the client. Wherever possible, directly use the client properties than calling for a windowinfo object. NOTE: The windowinfo object is a 'snapshot' object and hence the data provided by it is not modified when the properties of the client are changed.

client.isTransient[ret: boolean]

client.isTransient()

• Returns (true) is 'client' is transient, (false) otherwise.

client.isTransientFor[ret: client]

client.isTransientFor()

• If the given client is transient, returns it's parent client, otherwise returns an undefined scriptvalue.

client.activate client.activate()

• Attempt to activate (focus) the client. By attempt, it means that focus stealing prevention still is activated and the rules for activation are in place. Hence, the client actually may nor may not be activated.

client.setCaption

client.setCaption(caption_string {string})

• Sets the caption for the specified client to caption_string.
  • caption_string {string}: The caption to be set for the specified.

client.unminimize

client.unminimize()

• Unminimizes (or restores) the given client.

client.setFullScreen

client.setFullScreen( {fss_set})

• Sets the client to or from full screen mode.
  • {fss_set}: If (true), then the client is set to full screen or else, it is unset from fullscreen mode. If no parameter is provided, it toggles the full screen state.

client.isShade[ret: boolean]

client.isShade()

• Returns (true) of the client is shaded, (false) otherwise.

client.isShadeable[ret: boolean]

client.isShadeable()

• Returns (true) of the client is shadeable (can be shaded), (false) otherwise.

client.isMinimized[ret: boolean]

client.isMinimized()

• Returns (true) of the client is minimized, (false) otherwise.

client.isMinimizable[ret: boolean]

client.isMinimizable()

• Returns (true) of the client can be minimized, (false) otherwise.

client.isMaximizable[ret: boolean]

client.isMaximizable()

• Returns (true) of the client can be mazimized, (false) otherwise.

client.isResizable[ret: boolean]

client.isResizable()

• Returns (true) of the client can be resized (changable size), (false) otherwise.

client.isMovable[ret: boolean]

client.isMovable()

• Returns (true) of the client can be moved (non-fixed location), (false) otherwise.

client.isMovableAcrossScreens[ret: boolean]

client.isMovableAcrossScreens()

• Returns (true) of the client can be moved across screens (only valid in a multiple monitor setup), (false) otherwise.

client.isCloseable[ret: boolean]

client.isCloseable()

• Returns (true) of the client can be closed by user action (or any other action other than the system or the application itself), (false) otherwise.

client.isFullScreen[ret: boolean]

client.isFullScreen()

• Returns (true) of the client is in fullscreen mode, (false) otherwise.

client.isFullScreenable[ret: boolean]

client.isFullScreenable()

• Returns (true) of the client can be set to fullscreen mode, (false) otherwise.

client.clientGroup[ret: clientgroup]

client.clientGroup()

• Returns the client group the client belongs to. If it belongs to no client, it returns an undefined script value.

client.desktop[ret: integer]

client.desktop()

• Returns the desktop number that the client is on. If it is on all desktops, it returns -1.

clientgroup[instantiable]

Methods

clientgroup.ClientGroup[constructor]

clientgroup.ClientGroup(seed_client {client})

• Creates a new clientgroup object. A clientgroup in essence refers to a group of tabbed clients and an object refers to a specific group of such tabbed clients. It returns a clientgroup object which can be then manipulated using the various accessor functions.
  • seed_client {client}: The client to be added to the newly formed clientgroup. This is a mandatory argument for the creation of a new clientgroup object.

clientgroup.add

clientgroup.add(new_client {client}, beforeClient {integer}, becomeVisible {boolean})

• Adds new_client to the clientgroup at the index specified by beforeClient and if becomeVisible is true, makes it visible.
  • new_client {client}: A client object to be added to the clientgroup.
  • beforeClient {integer}: An index as to where the client is to be added to the clientgroup. It is an optional argument and if not specified, it will be added at the last position in the clientgroup.

becomeVisible {boolean}: If (true), makes the added client visible.

clientgroup.remove[variable parameter styles]

clientgroup.remove(index {integer}, set_geom {qrect})

clientgroup.remove(rem_client {client}, set_geom {qrect})

• Removes the client from the clientgroup and then sets it's geometry according to set_geom. This parameter is optional.
  • index {integer}: The client index which is to be removed.
  • set_geom {qrect}: The geometry to be set after removeal. This parameter is optional.
  • rem_client {client}: The client which is to be removed.
  • set_geom {qrect}: The geometry to be set after removal.

clientgroup.clients[ret: Array(client)]

clientgroup.clients()

• Returns an array of all the member clients of the clientgroup.

clientgroup.contains[ret: boolean]

clientgroup.contains(needle_client {client})

• Returns (true) if needle_client is a member of the clientgroup, (false) otherwise.
  • needle_client {client}: The client to be searched for

clientgroup.indexOf[ret: integer]

clientgroup.indexOf(needle_client {client})

• Searches for needle_client in the clientgroup and returns the position at which it exists. If needle_client is not found, then it returns -1.
  • needle_client {client}: The client whose index is to be found

clientgroup.move[variable parameter styles]

clientgroup.move(index_a {integer}, index_b {integer})

clientgroup.move(move_client {integer}, index {integer})

clientgroup.move(move_client {integer}, before_client {integer})

clientgroup.move(index_a {integer}, before_client {integer})

• Move a client within the group. Accepts move(client, client), move(index, index), move(index, client), move(client, index). All calls except move(client, client) are eventually mapped to move(index, index) using indexOf(client)
  • index_a {integer}: The index of the client to be moved.
  • index_b {integer}: The index of the position to move the client to.
  • move_client {integer}: The client to be moved.
  • index {integer}: The index of the position to move the client to.
  • move_client {integer}: The client to be moved.
  • before_client {integer}: The client before which the client is to moved.
  • index_a {integer}: The index of the client to be moved.
  • before_client {integer}: The client before which the client is to moved.

clientgroup.removeAll

clientgroup.removeAll()

• Removes all the clients from the clientgroup i.e. completely disassembles the clientgroup into its proponents.

clientgroup.closeAll

clientgroup.closeAll()

• Closes all the clients presents in the clientgroup.

clientgroup.minSize[ret: qsize]

clientgroup.minSize()

• Returns the minimum size acceptable for the clientgroup computed from the minimum sizes of all its present members.

clientgroup.maxSize[ret: qsize]

clientgroup.maxSize()

• Returns the maximum size acceptable for the clientgroup computed from the minimum sizes of all its present members.

windowinfo[floating]

Properties

windowinfo.isValid [ret: boolean] [GO]

• Returns (true) if the client is valid, (false) otherwise.

windowinfo.visibleName [ret: string] [GO]

• Returns the visible name of the client.

windowinfo.isMinimized [ret: boolean] [GO]

• Returns (true) if client is minimized. Redundant with client.isMinimized. For client, the subclass property is called, not the toplevel one.

windowinfo.state [ret: integer] [GO]

• Returns an integeral state for the client. Prefer other methods like isShaded, isFullScreenSet etc. over this.

windowinfo.windowRole [ret: string] [GO]

• Returns the window role of the toplevel client.

windowinfo.windowClassClass [ret: string] [GO]

• Returns the windowclass class of the client.

windowinfo.windowClassName [ret: string] [GO]

• Returns the windowclass name of the client.

config[singleton]

Methods

config.exists

config.exists(config_key {string})

• Searches for config_key in the configuration array and returns (true) if a corresponding value exists, (false) otherwise.
  • config_key {string}: The configuration key to be seeked.

config.get[variable parameter styles]

config.get()

config.get(key1, key2 ... keyN {string})

config.get(key {string})

config.get(keyArray {Array(string)}, showNonAssoc {boolean})

• If called without parameters, returns an associative array in the format ["key" : "value"] of all available key value pairs. If only a single key is requested for (passing 1 string parameter), then the corresponding value is returned and NOT an array. If multiple keys are provided as multiple arguments, an associative array is returned. If multiple keys (or a single) key is provided as an Array, then an associative array is present (if showNonAssoc is false or it is not specified), otherwise returns an integer indexed array.
  • key1, key2 ... keyN {string}: A list of keys to search the values for.
  • key {string}: The key to search the value for.
  • keyArray {Array(string)}: An array of keys to search the corresponding values for.
  • showNonAssoc {boolean}: If (true) causes the function to return an integer-indexed array, otherwise returns an associative array in the form ["key" : "value"]. This parameter is optional, defaults to false

Properties

config.loaded [ret: boolean] [GO]

• Returns (true) if a configuration file was found and loaded, (false) otherwise.