Changeset View
Changeset View
Standalone View
Standalone View
libkwineffects/kwineffects.h
| Show First 20 Lines • Show All 1072 Lines • ▼ Show 20 Line(s) | 830 | public: | |||
|---|---|---|---|---|---|
| 1073 | * Note: The factor can be also 0, so make sure your code can cope with 0ms time | 1073 | * Note: The factor can be also 0, so make sure your code can cope with 0ms time | ||
| 1074 | * if used manually. | 1074 | * if used manually. | ||
| 1075 | */ | 1075 | */ | ||
| 1076 | virtual double animationTimeFactor() const = 0; | 1076 | virtual double animationTimeFactor() const = 0; | ||
| 1077 | virtual WindowQuadType newWindowQuadType() = 0; | 1077 | virtual WindowQuadType newWindowQuadType() = 0; | ||
| 1078 | 1078 | | |||
| 1079 | Q_SCRIPTABLE virtual KWin::EffectWindow* findWindow(WId id) const = 0; | 1079 | Q_SCRIPTABLE virtual KWin::EffectWindow* findWindow(WId id) const = 0; | ||
| 1080 | Q_SCRIPTABLE virtual KWin::EffectWindow* findWindow(KWayland::Server::SurfaceInterface *surf) const = 0; | 1080 | Q_SCRIPTABLE virtual KWin::EffectWindow* findWindow(KWayland::Server::SurfaceInterface *surf) const = 0; | ||
| 1081 | /** | ||||
| 1082 | * Finds the EffectWindow for the internal window @p w. | ||||
| 1083 | * If there is no such window @c null is returned. | ||||
| 1084 | * | ||||
| 1085 | * On Wayland this returns the internal window. On X11 it returns an Unamanged with the | ||||
| 1086 | * window id matching that of the provided window @p w. | ||||
| 1087 | * | ||||
| 1088 | * @since 5.16 | ||||
| 1089 | **/ | ||||
| 1090 | Q_SCRIPTABLE virtual KWin::EffectWindow *findWindow(QWindow *w) const = 0; | ||||
| 1081 | virtual EffectWindowList stackingOrder() const = 0; | 1091 | virtual EffectWindowList stackingOrder() const = 0; | ||
| 1082 | // window will be temporarily painted as if being at the top of the stack | 1092 | // window will be temporarily painted as if being at the top of the stack | ||
| 1083 | Q_SCRIPTABLE virtual void setElevatedWindow(KWin::EffectWindow* w, bool set) = 0; | 1093 | Q_SCRIPTABLE virtual void setElevatedWindow(KWin::EffectWindow* w, bool set) = 0; | ||
| 1084 | 1094 | | |||
| 1085 | virtual void setTabBoxWindow(EffectWindow*) = 0; | 1095 | virtual void setTabBoxWindow(EffectWindow*) = 0; | ||
| 1086 | virtual void setTabBoxDesktop(int) = 0; | 1096 | virtual void setTabBoxDesktop(int) = 0; | ||
| 1087 | virtual EffectWindowList currentTabBoxWindowList() const = 0; | 1097 | virtual EffectWindowList currentTabBoxWindowList() const = 0; | ||
| 1088 | virtual void refTabBox() = 0; | 1098 | virtual void refTabBox() = 0; | ||
| ▲ Show 20 Lines • Show All 947 Lines • ▼ Show 20 Line(s) | 1795 | { | |||
| 2036 | * | 2046 | * | ||
| 2037 | * A popup is a window that can be used to implement tooltips, combo box popups, | 2047 | * A popup is a window that can be used to implement tooltips, combo box popups, | ||
| 2038 | * popup menus and other similar user interface concepts. | 2048 | * popup menus and other similar user interface concepts. | ||
| 2039 | * | 2049 | * | ||
| 2040 | * @since 5.15 | 2050 | * @since 5.15 | ||
| 2041 | **/ | 2051 | **/ | ||
| 2042 | Q_PROPERTY(bool popupWindow READ isPopupWindow CONSTANT) | 2052 | Q_PROPERTY(bool popupWindow READ isPopupWindow CONSTANT) | ||
| 2043 | 2053 | | |||
| 2054 | /** | ||||
| 2055 | * KWin internal window. Specific to Wayland platform. | ||||
| 2056 | * | ||||
| 2057 | * If the EffectWindow does not reference an internal window, this property is @c null. | ||||
| 2058 | * @since 5.16 | ||||
| 2059 | **/ | ||||
| 2060 | Q_PROPERTY(QWindow *internalWindow READ internalWindow CONSTANT) | ||||
| 2061 | | ||||
| 2044 | public: | 2062 | public: | ||
| 2045 | /** Flags explaining why painting should be disabled */ | 2063 | /** Flags explaining why painting should be disabled */ | ||
| 2046 | enum { | 2064 | enum { | ||
| 2047 | /** Window will not be painted */ | 2065 | /** Window will not be painted */ | ||
| 2048 | PAINT_DISABLED = 1 << 0, | 2066 | PAINT_DISABLED = 1 << 0, | ||
| 2049 | /** Window will not be painted because it is deleted */ | 2067 | /** Window will not be painted because it is deleted */ | ||
| 2050 | PAINT_DISABLED_BY_DELETE = 1 << 1, | 2068 | PAINT_DISABLED_BY_DELETE = 1 << 1, | ||
| 2051 | /** Window will not be painted because of which desktop it's on */ | 2069 | /** Window will not be painted because of which desktop it's on */ | ||
| ▲ Show 20 Lines • Show All 268 Lines • ▼ Show 20 Line(s) | 2118 | #endif | |||
| 2320 | virtual bool isX11Client() const = 0; | 2338 | virtual bool isX11Client() const = 0; | ||
| 2321 | 2339 | | |||
| 2322 | /** | 2340 | /** | ||
| 2323 | * @since 5.15 | 2341 | * @since 5.15 | ||
| 2324 | **/ | 2342 | **/ | ||
| 2325 | virtual bool isPopupWindow() const = 0; | 2343 | virtual bool isPopupWindow() const = 0; | ||
| 2326 | 2344 | | |||
| 2327 | /** | 2345 | /** | ||
| 2346 | * @since 5.16 | ||||
| 2347 | **/ | ||||
| 2348 | virtual QWindow *internalWindow() const = 0; | ||||
| 2349 | | ||||
| 2350 | /** | ||||
| 2328 | * Can be used to by effects to store arbitrary data in the EffectWindow. | 2351 | * Can be used to by effects to store arbitrary data in the EffectWindow. | ||
| 2329 | * | 2352 | * | ||
| 2330 | * Invoking this method will emit the signal EffectsHandler::windowDataChanged. | 2353 | * Invoking this method will emit the signal EffectsHandler::windowDataChanged. | ||
| 2331 | * @see EffectsHandler::windowDataChanged | 2354 | * @see EffectsHandler::windowDataChanged | ||
| 2332 | */ | 2355 | */ | ||
| 2333 | Q_SCRIPTABLE virtual void setData(int role, const QVariant &data) = 0; | 2356 | Q_SCRIPTABLE virtual void setData(int role, const QVariant &data) = 0; | ||
| 2334 | Q_SCRIPTABLE virtual QVariant data(int role) const = 0; | 2357 | Q_SCRIPTABLE virtual QVariant data(int role) const = 0; | ||
| 2335 | 2358 | | |||
| ▲ Show 20 Lines • Show All 1557 Lines • Show Last 20 Lines | |||||