Mgraesslin (Talk | contribs) (Global) |
Mgraesslin (Talk | contribs) |
||
| (9 intermediate revisions by one user not shown) | |||
| Line 5: | Line 5: | ||
* ''KWin::Options'' '''options''': Global property to all configuration values of KWin core. | * ''KWin::Options'' '''options''': Global property to all configuration values of KWin core. | ||
* ''KWin::Workspace'' '''workspace''': Global property to the core wrapper of KWin. | * ''KWin::Workspace'' '''workspace''': Global property to the core wrapper of KWin. | ||
| − | + | * ''object'' '''KWin''': Provides access to enums defined in KWin::WorkspaceWrapper | |
| − | + | ||
| − | + | ||
| − | + | ||
=== Functions === | === Functions === | ||
| − | * | + | * '''print(QVariant ... values)''': Prints all provided values to kDebug and as a D-Bus signal |
* ''QVariant'' '''readConfig(QString key, QVariant defaultValue = QVariant())''': Reads the config value for key in the Script's configuration with the optional default value. If not providing a default value and no value stored in the configuration an undefined value is returned. | * ''QVariant'' '''readConfig(QString key, QVariant defaultValue = QVariant())''': Reads the config value for key in the Script's configuration with the optional default value. If not providing a default value and no value stored in the configuration an undefined value is returned. | ||
| + | * ''bool'' '''registerScreenEdge(ElectricBorder border, QScriptValue callback)''': Registers the callback for the screen edge. When the mouse gets pushed against the given edge the callback will be invoked. | ||
* ''bool'' '''registerShortcut(QString title, QString text, QString keySequence, QScriptValue callback)''': Registers keySequence as a global shortcut. When the shortcut is invoked the callback will be called. Title and text are used to name the shortcut and make it available to the global shortcut configuration module. | * ''bool'' '''registerShortcut(QString title, QString text, QString keySequence, QScriptValue callback)''': Registers keySequence as a global shortcut. When the shortcut is invoked the callback will be called. Title and text are used to name the shortcut and make it available to the global shortcut configuration module. | ||
| + | * ''bool'' '''assert(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to true. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown. | ||
| + | * ''bool'' '''assertTrue(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to true. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown. | ||
| + | * ''bool'' '''assertFalse(bool value, QString message = QString())''': Aborts the execution of the script if value does not evaluate to false. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown. | ||
| + | * ''bool'' '''assertEquals(QVariant expected, QVariant actual, QString message = QString())''': Aborts the execution of the script if the actual value is not equal to the expected value. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown. | ||
| + | * ''bool'' '''assertNull(QVariant value, QString message = QString())''': Aborts the execution of the script if value is not null. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown. | ||
| + | * ''bool'' '''assertNotNull(QVariant value, QString message = QString())''': Aborts the execution of the script if value is null. If message is provided an error is thrown with the given message, if not provided an error with default message is thrown. | ||
| + | * '''callDBus(QString service, QString path, QString interface, QString method, QVariant arg..., QScriptValue callback = QScriptValue())''': Call a D-Bus method at (service, path, interface and method). A variable number of arguments can be added to the method call. The D-Bus call is always performed in an async way invoking the callback provided as the last (optional) argument. The reply values of the D-Bus method call are passed to the callback. | ||
| + | * '''registerUserActionsMenu(QScriptValue callback)''': Registers the passed in callback to be invoked whenever the User actions menu (Alt+F3 or right click on window decoration) is about to be shown. The callback is invoked with a reference to the Client for which the menu is shown. The callback can return either a single menu entry to be added to the menu or an own sub menu with multiple entries. The object for a menu entry should be {title: "My Menu entry", checkable: true, checked: false, triggered: function (action) { // callback with triggered QAction}}, for a menu it should be {title: "My menu", items: [{...}, {...}, ...] /*list with entries as described*/} | ||
| − | == | + | |
| − | + | == KWin::WorkspaceWrapper == | |
| + | === Enums === | ||
| + | |||
| + | ==== ClientAreaOption ==== | ||
| + | |||
| + | * '''PlacementArea''': window movement snapping area? ignore struts | ||
| + | * '''MovementArea''': | ||
| + | * '''MaximizeArea''': | ||
| + | * '''MaximizeFullArea''': | ||
| + | * '''FullScreenArea''': | ||
| + | * '''WorkArea''': | ||
| + | * '''FullArea''': | ||
| + | * '''ScreenArea''': | ||
| + | ==== ElectricBorder ==== | ||
| + | |||
| + | * '''ElectricTop''': | ||
| + | * '''ElectricTopRight''': | ||
| + | * '''ElectricRight''': | ||
| + | * '''ElectricBottomRight''': | ||
| + | * '''ElectricBottom''': | ||
| + | * '''ElectricBottomLeft''': | ||
| + | * '''ElectricLeft''': | ||
| + | * '''ElectricTopLeft''': | ||
| + | * '''ELECTRIC_COUNT''': | ||
| + | * '''ElectricNone''': | ||
=== Read-only Properties === | === Read-only Properties === | ||
| Line 31: | Line 61: | ||
* ''int'' '''activeScreen''' | * ''int'' '''activeScreen''' | ||
* ''int'' '''numScreens''' | * ''int'' '''numScreens''' | ||
| + | * ''QString'' '''currentActivity''' | ||
| + | * ''QStringList'' '''activities''' | ||
=== Read-write Properties === | === Read-write Properties === | ||
| Line 39: | Line 71: | ||
* '''desktopPresenceChanged(KWin::Client *client, int desktop)''' | * '''desktopPresenceChanged(KWin::Client *client, int desktop)''' | ||
| − | * '''currentDesktopChanged(int desktop)''' | + | * '''currentDesktopChanged(int desktop, KWin::Client *client)''' |
* '''clientAdded(KWin::Client *client)''' | * '''clientAdded(KWin::Client *client)''' | ||
* '''clientRemoved(KWin::Client *client)''' | * '''clientRemoved(KWin::Client *client)''' | ||
| Line 54: | Line 86: | ||
* '''clientDemandsAttentionChanged(KWin::Client *client, bool set)''': The demands attention state for Client c changed to set. c The Client for which demands attention changed set New value of demands attention | * '''clientDemandsAttentionChanged(KWin::Client *client, bool set)''': The demands attention state for Client c changed to set. c The Client for which demands attention changed set New value of demands attention | ||
* '''numberScreensChanged(int count)''': Signal emitted when the number of screens changes. count The new number of screens | * '''numberScreensChanged(int count)''': Signal emitted when the number of screens changes. count The new number of screens | ||
| + | * '''screenResized(int screen)''': This signal is emitted when the size of screen changes. Don't forget to fetch an updated client area. | ||
| + | * '''currentActivityChanged(const QString &id)''': Signal emitted whenever the current activity changed. id id of the new activity | ||
| + | * '''activitiesChanged(const QString &id)''': Signal emitted whenever the list of activities changed. id id of the new activity | ||
| + | * '''activityAdded(const QString &id)''': This signal is emitted when a new activity is added id id of the new activity | ||
| + | * '''activityRemoved(const QString &id)''': This signal is emitted when the activity is removed id id of the removed activity | ||
=== Functions === | === Functions === | ||
| Line 109: | Line 146: | ||
* '''slotWindowToDesktopUp()''' | * '''slotWindowToDesktopUp()''' | ||
* '''slotWindowToDesktopDown()''' | * '''slotWindowToDesktopDown()''' | ||
| − | * '' | + | * '''showOutline(const QRect &geometry)''': Shows an outline at the specified geometry. If an outline is already shown the outline is moved to the new position. Use to remove the outline again. |
| − | * '' | + | * '''showOutline(int x, int y, int width, int height)''': Overloaded method for convenience. |
| + | * '''hideOutline()''': Hides the outline previously shown by showOutline. | ||
| + | * ''QList< KWin::Client * >'' '''clientList() const ''': List of Clients currently managed by KWin. | ||
* ''QRect'' '''clientArea(ClientAreaOption option, int screen, int desktop) const ''': Returns the geometry a Client can use with the specified option. This method should be preferred over other methods providing screen sizes as the various options take constraints such as struts set on panels into account. This method is also multi screen aware, but there are also options to get full areas. option The type of area which should be considered screen The screen for which the area should be considered desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry | * ''QRect'' '''clientArea(ClientAreaOption option, int screen, int desktop) const ''': Returns the geometry a Client can use with the specified option. This method should be preferred over other methods providing screen sizes as the various options take constraints such as struts set on panels into account. This method is also multi screen aware, but there are also options to get full areas. option The type of area which should be considered screen The screen for which the area should be considered desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry | ||
| − | * ''QRect'' '''clientArea(ClientAreaOption option, const QPoint & | + | * ''QRect'' '''clientArea(ClientAreaOption option, const QPoint &point, int desktop) const ''': Overloaded method for convenience. option The type of area which should be considered point The coordinates which have to be included in the area desktop The desktop for which the area should be considered, in general there should not be a difference The specified screen geometry |
* ''QRect'' '''clientArea(ClientAreaOption option, const KWin::Client *client) const ''': Overloaded method for convenience. client The Client for which the area should be retrieved The specified screen geometry | * ''QRect'' '''clientArea(ClientAreaOption option, const KWin::Client *client) const ''': Overloaded method for convenience. client The Client for which the area should be retrieved The specified screen geometry | ||
* ''QString'' '''desktopName(int desktop) const ''': Returns the name for the given desktop. | * ''QString'' '''desktopName(int desktop) const ''': Returns the name for the given desktop. | ||
* ''QString'' '''supportInformation() const ''': Provides support information about the currently running KWin instance. | * ''QString'' '''supportInformation() const ''': Provides support information about the currently running KWin instance. | ||
| + | * ''KWin::Client *'' '''getClient(qulonglong windowId)''': Finds the Client with the given windowId. windowId The window Id of the Client The found Client or null | ||
| + | |||
== KWin::Options == | == KWin::Options == | ||
| − | |||
'''Inherits:''' KDecorationOptions | '''Inherits:''' KDecorationOptions | ||
| + | === Enums === | ||
| + | |||
| + | ==== FocusPolicy ==== | ||
| + | |||
| + | * '''ClickToFocus''': | ||
| + | * '''FocusFollowsMouse''': | ||
| + | * '''FocusUnderMouse''': | ||
| + | * '''FocusStrictlyUnderMouse''': | ||
| + | ==== MouseCommand ==== | ||
| + | |||
| + | * '''MouseRaise''': | ||
| + | * '''MouseLower''': | ||
| + | * '''MouseOperationsMenu''': | ||
| + | * '''MouseToggleRaiseAndLower''': | ||
| + | * '''MouseActivateAndRaise''': | ||
| + | * '''MouseActivateAndLower''': | ||
| + | * '''MouseActivate''': | ||
| + | * '''MouseActivateRaiseAndPassClick''': | ||
| + | * '''MouseActivateAndPassClick''': | ||
| + | * '''MouseMove''': | ||
| + | * '''MouseUnrestrictedMove''': | ||
| + | * '''MouseActivateRaiseAndMove''': | ||
| + | * '''MouseActivateRaiseAndUnrestrictedMove''': | ||
| + | * '''MouseResize''': | ||
| + | * '''MouseUnrestrictedResize''': | ||
| + | * '''MouseShade''': | ||
| + | * '''MouseSetShade''': | ||
| + | * '''MouseUnsetShade''': | ||
| + | * '''MouseMaximize''': | ||
| + | * '''MouseRestore''': | ||
| + | * '''MouseMinimize''': | ||
| + | * '''MouseNextDesktop''': | ||
| + | * '''MousePreviousDesktop''': | ||
| + | * '''MouseAbove''': | ||
| + | * '''MouseBelow''': | ||
| + | * '''MouseOpacityMore''': | ||
| + | * '''MouseOpacityLess''': | ||
| + | * '''MouseClose''': | ||
| + | * '''MousePreviousTab''': | ||
| + | * '''MouseNextTab''': | ||
| + | * '''MouseDragTab''': | ||
| + | * '''MouseNothing''': | ||
| + | ==== MouseWheelCommand ==== | ||
| + | |||
| + | * '''MouseWheelRaiseLower''': | ||
| + | * '''MouseWheelShadeUnshade''': | ||
| + | * '''MouseWheelMaximizeRestore''': | ||
| + | * '''MouseWheelAboveBelow''': | ||
| + | * '''MouseWheelPreviousNextDesktop''': | ||
| + | * '''MouseWheelChangeOpacity''': | ||
| + | * '''MouseWheelChangeCurrentTab''': | ||
| + | * '''MouseWheelNothing''': | ||
| + | ==== @16 ==== | ||
| + | |||
| + | * '''ElectricDisabled''': | ||
| + | * '''ElectricMoveOnly''': | ||
| + | * '''ElectricAlways''': | ||
=== Read-only Properties === | === Read-only Properties === | ||
| + | |||
| + | * ''bool'' '''focusPolicyIsReasonable''' | ||
| + | * ''bool'' '''electricBorders''': Whether electric borders are enabled. With electric borders you can change desktop by moving the mouse pointer towards the edge of the screen | ||
| + | === Read-write Properties === | ||
* ''FocusPolicy'' '''focusPolicy''' | * ''FocusPolicy'' '''focusPolicy''' | ||
| Line 131: | Line 232: | ||
* ''bool'' '''shadeHover''': Whether shade hover is enabled or not | * ''bool'' '''shadeHover''': Whether shade hover is enabled or not | ||
* ''int'' '''shadeHoverInterval''': shade hover interval | * ''int'' '''shadeHoverInterval''': shade hover interval | ||
| − | |||
| − | |||
* ''bool'' '''separateScreenFocus''': whether to see Xinerama screens separately for focus (in Alt+Tab, when activating next client) | * ''bool'' '''separateScreenFocus''': whether to see Xinerama screens separately for focus (in Alt+Tab, when activating next client) | ||
* ''bool'' '''activeMouseScreen''': whether active Xinerama screen is the one with mouse (or with the active window) | * ''bool'' '''activeMouseScreen''': whether active Xinerama screen is the one with mouse (or with the active window) | ||
* ''int'' '''placement''' | * ''int'' '''placement''' | ||
| − | |||
* ''int'' '''borderSnapZone''': the size of the zone that triggers snapping on desktop borders | * ''int'' '''borderSnapZone''': the size of the zone that triggers snapping on desktop borders | ||
* ''int'' '''windowSnapZone''': the size of the zone that triggers snapping with other windows | * ''int'' '''windowSnapZone''': the size of the zone that triggers snapping with other windows | ||
| Line 161: | Line 259: | ||
* ''uint'' '''keyCmdAllModKey''' | * ''uint'' '''keyCmdAllModKey''' | ||
* ''bool'' '''showGeometryTip''': whether the Geometry Tip should be shown during a window move/resize. | * ''bool'' '''showGeometryTip''': whether the Geometry Tip should be shown during a window move/resize. | ||
| − | |||
* ''int'' '''electricBorderDelay''': the activation delay for electric borders in milliseconds. | * ''int'' '''electricBorderDelay''': the activation delay for electric borders in milliseconds. | ||
* ''int'' '''electricBorderCooldown''': the trigger cooldown for electric borders in milliseconds. | * ''int'' '''electricBorderCooldown''': the trigger cooldown for electric borders in milliseconds. | ||
| Line 167: | Line 264: | ||
* ''bool'' '''electricBorderMaximize''': Whether a window gets maximized when it reaches top screen edge while being moved. | * ''bool'' '''electricBorderMaximize''': Whether a window gets maximized when it reaches top screen edge while being moved. | ||
* ''bool'' '''electricBorderTiling''': Whether a window is tiled to half screen when reaching left or right screen edge while been moved | * ''bool'' '''electricBorderTiling''': Whether a window is tiled to half screen when reaching left or right screen edge while been moved | ||
| + | * ''float'' '''electricBorderCornerRatio''': Whether a window is tiled to half screen when reaching left or right screen edge while been moved | ||
* ''bool'' '''borderlessMaximizedWindows''' | * ''bool'' '''borderlessMaximizedWindows''' | ||
* ''int'' '''killPingTimeout''': timeout before non-responding application will be killed after attempt to close | * ''int'' '''killPingTimeout''': timeout before non-responding application will be killed after attempt to close | ||
| Line 175: | Line 273: | ||
* ''int'' '''compositingMode''' | * ''int'' '''compositingMode''' | ||
* ''bool'' '''useCompositing''' | * ''bool'' '''useCompositing''' | ||
| + | * ''bool'' '''compositingInitialized''' | ||
* ''int'' '''hiddenPreviews''' | * ''int'' '''hiddenPreviews''' | ||
* ''bool'' '''unredirectFullscreen''' | * ''bool'' '''unredirectFullscreen''' | ||
| Line 182: | Line 281: | ||
* ''uint'' '''maxFpsInterval''' | * ''uint'' '''maxFpsInterval''' | ||
* ''uint'' '''refreshRate''' | * ''uint'' '''refreshRate''' | ||
| + | * ''uint'' '''vBlankTime''' | ||
* ''bool'' '''glDirect''' | * ''bool'' '''glDirect''' | ||
* ''bool'' '''glStrictBinding''' | * ''bool'' '''glStrictBinding''' | ||
| − | + | * ''bool'' '''glStrictBindingFollowsDriver''': Whether strict binding follows the driver or has been overwritten by a user defined config value. If true is set by the OpenGL Scene during initialization. If false glStrictBinding is set from a config value and not updated during scene initialization. | |
| − | + | * ''bool'' '''glLegacy''': Whether legacy OpenGL should be used or OpenGL (ES) 2 | |
| − | * ''bool'' ''' | + | |
| − | * ''bool'' ''' | + | |
=== Signals === | === Signals === | ||
* '''configChanged()''' | * '''configChanged()''' | ||
| + | * '''focusPolicyChanged()''' | ||
| + | * '''nextFocusPrefersMouseChanged()''' | ||
| + | * '''clickRaiseChanged()''' | ||
| + | * '''autoRaiseChanged()''' | ||
| + | * '''autoRaiseIntervalChanged()''' | ||
| + | * '''delayFocusIntervalChanged()''' | ||
| + | * '''shadeHoverChanged()''' | ||
| + | * '''shadeHoverIntervalChanged()''' | ||
| + | * '''separateScreenFocusChanged()''' | ||
| + | * '''activeMouseScreenChanged()''' | ||
| + | * '''placementChanged()''' | ||
| + | * '''borderSnapZoneChanged()''' | ||
| + | * '''windowSnapZoneChanged()''' | ||
| + | * '''centerSnapZoneChanged()''' | ||
| + | * '''snapOnlyWhenOverlappingChanged()''' | ||
| + | * '''showDesktopIsMinimizeAllChanged()''' | ||
| + | * '''rollOverDesktopsChanged()''' | ||
| + | * '''focusStealingPreventionLevelChanged()''' | ||
| + | * '''legacyFullscreenSupportChanged()''' | ||
| + | * '''operationTitlebarDblClickChanged()''' | ||
| + | * '''commandActiveTitlebar1Changed()''' | ||
| + | * '''commandActiveTitlebar2Changed()''' | ||
| + | * '''commandActiveTitlebar3Changed()''' | ||
| + | * '''commandInactiveTitlebar1Changed()''' | ||
| + | * '''commandInactiveTitlebar2Changed()''' | ||
| + | * '''commandInactiveTitlebar3Changed()''' | ||
| + | * '''commandWindow1Changed()''' | ||
| + | * '''commandWindow2Changed()''' | ||
| + | * '''commandWindow3Changed()''' | ||
| + | * '''commandWindowWheelChanged()''' | ||
| + | * '''commandAll1Changed()''' | ||
| + | * '''commandAll2Changed()''' | ||
| + | * '''commandAll3Changed()''' | ||
| + | * '''keyCmdAllModKeyChanged()''' | ||
| + | * '''showGeometryTipChanged()''' | ||
| + | * '''electricBordersChanged()''' | ||
| + | * '''electricBorderDelayChanged()''' | ||
| + | * '''electricBorderCooldownChanged()''' | ||
| + | * '''electricBorderPushbackPixelsChanged()''' | ||
| + | * '''electricBorderMaximizeChanged()''' | ||
| + | * '''electricBorderTilingChanged()''' | ||
| + | * '''electricBorderCornerRatioChanged()''' | ||
| + | * '''borderlessMaximizedWindowsChanged()''' | ||
| + | * '''killPingTimeoutChanged()''' | ||
| + | * '''hideUtilityWindowsForInactiveChanged()''' | ||
| + | * '''inactiveTabsSkipTaskbarChanged()''' | ||
| + | * '''autogroupSimilarWindowsChanged()''' | ||
| + | * '''autogroupInForegroundChanged()''' | ||
| + | * '''compositingModeChanged()''' | ||
| + | * '''useCompositingChanged()''' | ||
| + | * '''compositingInitializedChanged()''' | ||
| + | * '''hiddenPreviewsChanged()''' | ||
| + | * '''unredirectFullscreenChanged()''' | ||
| + | * '''glSmoothScaleChanged()''' | ||
| + | * '''glVSyncChanged()''' | ||
| + | * '''xrenderSmoothScaleChanged()''' | ||
| + | * '''maxFpsIntervalChanged()''' | ||
| + | * '''refreshRateChanged()''' | ||
| + | * '''vBlankTimeChanged()''' | ||
| + | * '''glDirectChanged()''' | ||
| + | * '''glStrictBindingChanged()''' | ||
| + | * '''glStrictBindingFollowsDriverChanged()''' | ||
| + | * '''glLegacyChanged()''' | ||
| + | === Functions === | ||
| + | |||
| + | |||
== KWin::Toplevel == | == KWin::Toplevel == | ||
| − | + | ||
| + | '''Inherits:''' KDecorationDefines | ||
=== Read-only Properties === | === Read-only Properties === | ||
| + | |||
* ''bool'' '''alpha''' | * ''bool'' '''alpha''' | ||
* ''qulonglong'' '''frameId''' | * ''qulonglong'' '''frameId''' | ||
* ''QRect'' '''geometry''' | * ''QRect'' '''geometry''' | ||
| + | * ''QRect'' '''visibleRect''' | ||
* ''int'' '''height''' | * ''int'' '''height''' | ||
* ''QPoint'' '''pos''' | * ''QPoint'' '''pos''' | ||
| Line 207: | Line 374: | ||
* ''int'' '''y''' | * ''int'' '''y''' | ||
* ''int'' '''desktop''' | * ''int'' '''desktop''' | ||
| + | * ''bool'' '''onAllDesktops''': Whether the window is on all desktops. That is desktop is -1. | ||
* ''QRect'' '''rect''' | * ''QRect'' '''rect''' | ||
* ''QPoint'' '''clientPos''' | * ''QPoint'' '''clientPos''' | ||
| Line 226: | Line 394: | ||
* ''bool'' '''notification''': Returns whether the window is a window with a notification. See _NET_WM_WINDOW_TYPE_NOTIFICATION at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . | * ''bool'' '''notification''': Returns whether the window is a window with a notification. See _NET_WM_WINDOW_TYPE_NOTIFICATION at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . | ||
* ''bool'' '''comboBox''': Returns whether the window is a combobox popup. See _NET_WM_WINDOW_TYPE_COMBO at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . | * ''bool'' '''comboBox''': Returns whether the window is a combobox popup. See _NET_WM_WINDOW_TYPE_COMBO at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . | ||
| − | * ''bool'' '''dndIcon''': Returns whether the window is a Drag& | + | * ''bool'' '''dndIcon''': Returns whether the window is a Drag&Drop icon. See _NET_WM_WINDOW_TYPE_DND at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . |
* ''int'' '''windowType''': Returns the NETWM window type See http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . | * ''int'' '''windowType''': Returns the NETWM window type See http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . | ||
* ''QStringList'' '''activities''' | * ''QStringList'' '''activities''' | ||
| Line 238: | Line 406: | ||
* '''opacityChanged(KWin::Toplevel *toplevel, qreal oldOpacity)''' | * '''opacityChanged(KWin::Toplevel *toplevel, qreal oldOpacity)''' | ||
| − | * '''damaged(KWin::Toplevel *toplevel, const QRect & | + | * '''damaged(KWin::Toplevel *toplevel, const QRect &damage)''' |
* '''propertyNotify(KWin::Toplevel *toplevel, long a)''' | * '''propertyNotify(KWin::Toplevel *toplevel, long a)''' | ||
* '''geometryChanged()''' | * '''geometryChanged()''' | ||
| − | * '''geometryShapeChanged(KWin::Toplevel *toplevel, const QRect & | + | * '''geometryShapeChanged(KWin::Toplevel *toplevel, const QRect &old)''' |
| + | * '''paddingChanged(KWin::Toplevel *toplevel, const QRect &old)''' | ||
* '''windowClosed(KWin::Toplevel *toplevel, KWin::Deleted *deleted)''' | * '''windowClosed(KWin::Toplevel *toplevel, KWin::Deleted *deleted)''' | ||
* '''windowShown(KWin::Toplevel *toplevel)''' | * '''windowShown(KWin::Toplevel *toplevel)''' | ||
* '''shapedChanged()''': Signal emitted when the window's shape state changed. That is if it did not have a shape and received one or if the shape was withdrawn. Think of Chromium enabling/disabling KWin's decoration. | * '''shapedChanged()''': Signal emitted when the window's shape state changed. That is if it did not have a shape and received one or if the shape was withdrawn. Think of Chromium enabling/disabling KWin's decoration. | ||
| + | * '''needsRepaint()''': Emitted whenever the state changes in a way, that the Compositor should schedule a repaint of the scene. | ||
=== Functions === | === Functions === | ||
| − | * | + | * '''addRepaint(const QRect &r)''' |
| − | * | + | * '''addRepaint(const QRegion &r)''' |
| − | * | + | * '''addRepaint(int x, int y, int w, int h)''' |
| − | * | + | * '''addLayerRepaint(const QRect &r)''' |
| − | * | + | * '''addLayerRepaint(const QRegion &r)''' |
| − | * | + | * '''addLayerRepaint(int x, int y, int w, int h)''' |
| − | * | + | * '''addRepaintFull()''' |
| + | |||
== KWin::Client == | == KWin::Client == | ||
The Client class encapsulates a window decoration frame. | The Client class encapsulates a window decoration frame. | ||
'''Inherits:''' KWin::Toplevel | '''Inherits:''' KWin::Toplevel | ||
| + | === Enums === | ||
| + | |||
| + | ==== Sizemode ==== | ||
| + | |||
| + | * '''SizemodeAny''': | ||
| + | * '''SizemodeFixedW''': | ||
| + | * '''SizemodeFixedH''': | ||
| + | * '''SizemodeMax''': | ||
| + | ==== CoordinateMode ==== | ||
| + | |||
| + | * '''DecorationRelative''': | ||
| + | * '''WindowRelative''': | ||
=== Read-only Properties === | === Read-only Properties === | ||
| Line 288: | Line 471: | ||
* ''int'' '''desktop''': 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. | * ''int'' '''desktop''': 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. | ||
| + | * ''bool'' '''onAllDesktops''': Whether the Client is on all desktops. That is desktop is -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. | * ''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. | * ''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. | ||
| Line 309: | Line 493: | ||
* '''clientUnminimized(KWin::Client *client, bool animate)''' | * '''clientUnminimized(KWin::Client *client, bool animate)''' | ||
* '''clientStartUserMovedResized(KWin::Client *)''' | * '''clientStartUserMovedResized(KWin::Client *)''' | ||
| − | * '''clientStepUserMovedResized(KWin::Client *, const QRect & | + | * '''clientStepUserMovedResized(KWin::Client *, const QRect &)''' |
* '''clientFinishUserMovedResized(KWin::Client *)''' | * '''clientFinishUserMovedResized(KWin::Client *)''' | ||
* '''activeChanged()''' | * '''activeChanged()''' | ||
| Line 328: | Line 512: | ||
* '''tabGroupChanged()''': Emitted whenever the Client's TabGroup 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. | * '''tabGroupChanged()''': Emitted whenever the Client's TabGroup 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. | ||
* '''demandsAttentionChanged()''': Emitted whenever the demands attention state changes. | * '''demandsAttentionChanged()''': Emitted whenever the demands attention state changes. | ||
| − | * '''blockingCompositingChanged()''': Emitted whenever the Client's block compositing state changes. | + | * '''blockingCompositingChanged(KWin::Client *client)''': Emitted whenever the Client's block compositing state changes. |
=== Functions === | === Functions === | ||
* '''closeWindow()''': Closes the window by either sending a delete_window message or using XKill. | * '''closeWindow()''': Closes the window by either sending a delete_window message or using XKill. | ||
| − | * '' | + | * ''bool'' '''tabBefore(Client *other, bool activate)''' |
| − | * '' | + | * ''bool'' '''tabBehind(Client *other, bool activate)''' |
| − | * '' | + | * '''syncTabGroupFor(QString property, bool fromThisClient=false)''': Syncs the dynamic property fromThisClient or the to all members of the tabGroup() (if there is one) eg. if you call: client->setProperty("kwin_tiling_floats", true); client->syncTabGroupFor("kwin_tiling_floats", true) all clients in this tabGroup will have ::property("kwin_tiling_floats").toBool() == true WARNING: non dynamic properties are ignored - you're not supposed to alter/update such explicitly |
| − | + | * ''bool'' '''untab(const QRect &toGeometry=QRect())''' | |
| − | == | + | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | * ''' | + | |
| − | + | ||
| − | + | ||
Contents |
Methods and properties added to the global JavaScript object.
Inherits: KDecorationOptions
Inherits: KDecorationDefines
The Client class encapsulates a window decoration frame. Inherits: KWin::Toplevel
KDE TechBase 