Development/Tutorials/KWin/Scripting/API 4.9

    From KDE TechBase
    Revision as of 14:49, 1 January 2012 by Mgraesslin (talk | contribs) (Client Group)

    KWin::Toplevel

    Toplevel is an abstract base class for all "Windows". You cannot use it directly, but everything available on Toplevel is available on Client, too.

    Read-only Properties

    Read-write Properties

    • qreal opacity:

    Signals

    • opacityChanged(KWin::Toplevel *toplevel, qreal oldOpacity)
    • damaged(KWin::Toplevel *toplevel, const QRect &damage)
    • propertyNotify(KWin::Toplevel *toplevel, long a)
    • geometryChanged()
    • geometryShapeChanged(KWin::Toplevel *toplevel, const QRect &old)
    • windowClosed(KWin::Toplevel *toplevel, KWin::Deleted *deleted)

    KWin::Client

    The Client class encapsulates a window decoration frame.

    Inherits: KWin::Toplevel

    Read-only Properties

    • bool active: Whether this Client is active or not. Use Workspace::activateClient() to activate a Client. Workspace::activateClient
    • QString caption: 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.
    • bool closeable: 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.
    • bool fullScreenable: 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.
    • bool maximizable: 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.
    • bool minimizable: Whether the Client can be minimized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
    • bool modal: Whether the Client represents a modal window.
    • bool moveable: 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
    • bool moveableAcrossScreens: 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.
    • bool providesContextHelp: 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()
    • bool resizeable: Whether the Client can be resized. The property is evaluated each time it is invoked. Because of that there is no notify signal.
    • bool shadeable: Whether the Client can be shaded. The property is evaluated each time it is invoked. Because of that there is no notify signal.
    • bool transient: Whether the Client is a transient Window to another Window.
    • QObject transientFor: The Client to which this Client is a transient if any. Property uses a QObject. If the property is needed as a Client, perform a qobject_cast.
    • QSize basicUnit: 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.
    • bool move: Whether the Client is currently being moved by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
    • bool resize: Whether the Client is currently being resized by the user. Notify signal is emitted when the Client starts or ends move/resize mode.
    • QRect iconGeometry: The optional geometry representing the minimized Client in e.g a taskbar. See _NET_WM_ICON_GEOMETRY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . The value is evaluated each time the getter is called. Because of that no changed signal is provided.
    • bool specialWindow: 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.
    • bool wantsInput: 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.
    • QPixmap icon

    Read-write Properties

    • int desktop: The desktop this Client is on. If the Client is on all desktops the property has value -1.
    • bool fullScreen: 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.
    • QRect geometry: 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.
    • bool keepAbove: Whether the Client is set to be kept above other windows.
    • bool keepBelow: Whether the Client is set to be kept below other windows.
    • bool minimized: Whether the Client is minimized.
    • bool shade: Whether the Client is shaded.
    • bool skipSwitcher: Whether the Client should be excluded from window switching effects.

    Signals

    • clientManaging(KWin::Client *)
    • s_unminimized()
    • maximizeSet(QPair< bool, bool >)
    • clientMaximizedStateChanged(KWin::Client *, KDecorationDefines::MaximizeMode)
    • clientMinimized(KWin::Client *client, bool animate)
    • clientUnminimized(KWin::Client *client, bool animate)
    • clientStartUserMovedResized(KWin::Client *)
    • clientStepUserMovedResized(KWin::Client *, const QRect &)
    • clientFinishUserMovedResized(KWin::Client *)
    • activeChanged()
    • captionChanged()
    • desktopChanged()
    • fullScreenChanged()
    • transientChanged()
    • modalChanged()
    • shadeChanged()
    • keepAboveChanged()
    • keepBelowChanged()
    • minimizedChanged()
    • moveResizedChanged()
    • iconChanged()
    • skipSwitcherChanged()

    KWin::ClientGroup

    Read-only Properties

    • QSize minSize: Combined minimum size of all clients in the group.
    • QSize maxSize: Combined maximum size of all clients in the group.
    • int visibleClientIndex: The index of the visible Client in this group.
    • QList<KWin::Client*> clients: The Clients in this group.

    Read-write Properties

    • KWin::Client visible: 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.
    • displayClientMenu(int index, const QPoint &pos): Display the right-click client menu belonging to the client at index index at the global coordinates specified by pos.
    • displayClientMenu(KWin::Client *c, const QPoint &pos): Display the right-click client menu belonging to c at the global coordinates specified by pos.
    • int indexOfClient(KWin::Client *c): Returns the list index of c.
    • bool contains(KWin::Client *c): Returns whether or not this group contains c.