Differential D16602 Diff 46538 libkwineffects/kwineffects.h

Changeset View

Standalone View

View Options

libkwineffects/kwineffects.h

Show First 20 Lines • Show All 2065 Lines • ▼ Show 20 Line(s)2043public:
2066 Q_SCRIPTABLE void addRepaint(const QRect& r); 2066​ Q_SCRIPTABLE void addRepaint(const QRect& r);
2067 Q_SCRIPTABLE void addRepaint(int x, int y, int w, int h); 2067​ Q_SCRIPTABLE void addRepaint(int x, int y, int w, int h);
2068 Q_SCRIPTABLE void addRepaintFull(); 2068​ Q_SCRIPTABLE void addRepaintFull();
2069 Q_SCRIPTABLE void addLayerRepaint(const QRect& r); 2069​ Q_SCRIPTABLE void addLayerRepaint(const QRect& r);
2070 Q_SCRIPTABLE void addLayerRepaint(int x, int y, int w, int h); 2070​ Q_SCRIPTABLE void addLayerRepaint(int x, int y, int w, int h);
2071 2071​
2072 virtual void refWindow() = 0; 2072​ virtual void refWindow() = 0;
2073 virtual void unrefWindow() = 0; 2073​ virtual void unrefWindow() = 0;
2074 bool isDeleted() const; ​
2075 2074​
2076 bool isMinimized() const; 2075​ virtual bool isDeleted() const = 0;
2077 double opacity() const; 2076​
2078 bool hasAlpha() const; 2077​ virtual bool isMinimized() const = 0;
2078​ virtual double opacity() const = 0;
2079​ virtual bool hasAlpha() const = 0;
2079 2080​
2080 bool isOnCurrentActivity() const; 2081​ bool isOnCurrentActivity() const;
2081 Q_SCRIPTABLE bool isOnActivity(QString id) const; 2082​ Q_SCRIPTABLE bool isOnActivity(QString id) const;
2082 bool isOnAllActivities() const; 2083​ bool isOnAllActivities() const;
2083 QStringList activities() const; 2084​ virtual QStringList activities() const = 0;
2084 2085​
2085 Q_SCRIPTABLE bool isOnDesktop(int d) const; 2086​ Q_SCRIPTABLE bool isOnDesktop(int d) const;
2086 bool isOnCurrentDesktop() const; 2087​ bool isOnCurrentDesktop() const;
2087 bool isOnAllDesktops() const; 2088​ bool isOnAllDesktops() const;
2088 /** 2089​ /**
2089 * The desktop this window is in. This mkaes sense only on X11 2090​ * The desktop this window is in. This mkaes sense only on X11
2090 * where desktops are mutually exclusive, on Wayland it's the last 2091​ * where desktops are mutually exclusive, on Wayland it's the last
2091 * desktop the window has been added to. 2092​ * desktop the window has been added to.
2092 * use desktops() instead. 2093​ * use desktops() instead.
2093 * @see desktops() 2094​ * @see desktops()
2094 * @deprecated 2095​ * @deprecated
2095 */ 2096​ */
2096#ifndef KWIN_NO_DEPRECATED 2097​#ifndef KWIN_NO_DEPRECATED
2097 int KWIN_DEPRECATED desktop() const; // prefer isOnXXX() 2098​ virtual int KWIN_DEPRECATED desktop() const = 0; // prefer isOnXXX()
2098#endif 2099​#endif
2099 /** 2100​ /**
2100 * All the desktops by number that the window is in. On X11 this list will always have 2101​ * All the desktops by number that the window is in. On X11 this list will always have
2101 * a length of 1, on Wayland can be any subset. 2102​ * a length of 1, on Wayland can be any subset.
2102 * If the list is empty it means the window is on all desktops 2103​ * If the list is empty it means the window is on all desktops
2103 */ 2104​ */
2104 QVector<uint> desktops() const; 2105​ virtual QVector<uint> desktops() const = 0;
2105 2106​
2106 int x() const; 2107​ virtual int x() const = 0;
2107 int y() const; 2108​ virtual int y() const = 0;
2108 int width() const; 2109​ virtual int width() const = 0;
2109 int height() const; 2110​ virtual int height() const = 0;
2110 /** 2111​ /**
2111 * By how much the window wishes to grow/shrink at least. Usually QSize(1,1). 2112​ * By how much the window wishes to grow/shrink at least. Usually QSize(1,1).
2112 * MAY BE DISOBEYED BY THE WM! It's only for information, do NOT rely on it at all. 2113​ * MAY BE DISOBEYED BY THE WM! It's only for information, do NOT rely on it at all.
2113 */ 2114​ */
2114 QSize basicUnit() const; 2115​ virtual QSize basicUnit() const = 0;
2115 QRect geometry() const; 2116​ virtual QRect geometry() const = 0;
2116 /** 2117​ /**
2117 * Geometry of the window including decoration and potentially shadows. 2118​ * Geometry of the window including decoration and potentially shadows.
2118 * May be different from geometry() if the window has a shadow. 2119​ * May be different from geometry() if the window has a shadow.
2119 * @since 4.9 2120​ * @since 4.9
2120 */ 2121​ */
2121 QRect expandedGeometry() const; 2122​ virtual QRect expandedGeometry() const = 0;
2122 virtual QRegion shape() const = 0; 2123​ virtual QRegion shape() const = 0;
2123 int screen() const; 2124​ virtual int screen() const = 0;
2124 /** @internal Do not use */ 2125​ /** @internal Do not use */
2125 bool hasOwnShape() const; // only for shadow effect, for now 2126​ virtual bool hasOwnShape() const = 0; // only for shadow effect, for now
2126 QPoint pos() const; 2127​ virtual QPoint pos() const = 0;
2127 QSize size() const; 2128​ virtual QSize size() const = 0;
2128 QRect rect() const; 2129​ virtual QRect rect() const = 0;
2129 bool isMovable() const; 2130​ virtual bool isMovable() const = 0;
2130 bool isMovableAcrossScreens() const; 2131​ virtual bool isMovableAcrossScreens() const = 0;
2131 bool isUserMove() const; 2132​ virtual bool isUserMove() const = 0;
2132 bool isUserResize() const; 2133​ virtual bool isUserResize() const = 0;
2133 QRect iconGeometry() const; 2134​ virtual QRect iconGeometry() const = 0;
2134 2135​
2135 /** 2136​ /**
2136 * Geometry of the actual window contents inside the whole (including decorations) window. 2137​ * Geometry of the actual window contents inside the whole (including decorations) window.
2137 */ 2138​ */
2138 QRect contentsRect() const; 2139​ virtual QRect contentsRect() const = 0;
2139 /** 2140​ /**
2140 * Geometry of the transparent rect in the decoration. 2141​ * Geometry of the transparent rect in the decoration.
2141 * May be different from contentsRect() if the decoration is extended into the client area. 2142​ * May be different from contentsRect() if the decoration is extended into the client area.
2142 * @since 4.5 2143​ * @since 4.5
2143 */ 2144​ */
2144 virtual QRect decorationInnerRect() const = 0; 2145​ virtual QRect decorationInnerRect() const = 0;
2145 bool hasDecoration() const; 2146​ bool hasDecoration() const;
2146 bool decorationHasAlpha() const; 2147​ virtual bool decorationHasAlpha() const = 0;
2147 virtual QByteArray readProperty(long atom, long type, int format) const = 0; 2148​ virtual QByteArray readProperty(long atom, long type, int format) const = 0;
2148 virtual void deleteProperty(long atom) const = 0; 2149​ virtual void deleteProperty(long atom) const = 0;
2149 2150​
2150 QString caption() const; 2151​ virtual QString caption() const = 0;
2151 QIcon icon() const; 2152​ virtual QIcon icon() const = 0;
2152 QString windowClass() const; 2153​ virtual QString windowClass() const = 0;
2153 QString windowRole() const; 2154​ virtual QString windowRole() const = 0;
2154 virtual const EffectWindowGroup* group() const = 0; 2155​ virtual const EffectWindowGroup* group() const = 0;
2155 2156​
2156 /** 2157​ /**
2157 * Returns whether the window is a desktop background window (the one with wallpaper). 2158​ * Returns whether the window is a desktop background window (the one with wallpaper).
2158 * See _NET_WM_WINDOW_TYPE_DESKTOP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . 2159​ * See _NET_WM_WINDOW_TYPE_DESKTOP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
2159 */ 2160​ */
2160 bool isDesktop() const; 2161​ virtual bool isDesktop() const = 0;
2161 /** 2162​ /**
2162 * Returns whether the window is a dock (i.e. a panel). 2163​ * Returns whether the window is a dock (i.e. a panel).
2163 * See _NET_WM_WINDOW_TYPE_DOCK at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . 2164​ * See _NET_WM_WINDOW_TYPE_DOCK at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
2164 */ 2165​ */
2165 bool isDock() const; 2166​ virtual bool isDock() const = 0;
2166 /** 2167​ /**
2167 * Returns whether the window is a standalone (detached) toolbar window. 2168​ * Returns whether the window is a standalone (detached) toolbar window.
2168 * See _NET_WM_WINDOW_TYPE_TOOLBAR at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . 2169​ * See _NET_WM_WINDOW_TYPE_TOOLBAR at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
2169 */ 2170​ */
2170 bool isToolbar() const; 2171​ virtual bool isToolbar() const = 0;
2171 /** 2172​ /**
2172 * Returns whether the window is a torn-off menu. 2173​ * Returns whether the window is a torn-off menu.
2173 * See _NET_WM_WINDOW_TYPE_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . 2174​ * See _NET_WM_WINDOW_TYPE_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
2174 */ 2175​ */
2175 bool isMenu() const; 2176​ virtual bool isMenu() const = 0;
2176 /** 2177​ /**
2177 * Returns whether the window is a "normal" window, i.e. an application or any other window 2178​ * Returns whether the window is a "normal" window, i.e. an application or any other window
2178 * for which none of the specialized window types fit. 2179​ * for which none of the specialized window types fit.
2179 * See _NET_WM_WINDOW_TYPE_NORMAL at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . 2180​ * See _NET_WM_WINDOW_TYPE_NORMAL at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
2180 */ 2181​ */
2181 bool isNormalWindow() const; // normal as in 'NET::Normal or NET::Unknown non-transient' 2182​ virtual bool isNormalWindow() const = 0; // normal as in 'NET::Normal or NET::Unknown non-transient'
2182 /** 2183​ /**
2183 * Returns whether the window is any of special windows types (desktop, dock, splash, ...), 2184​ * Returns whether the window is any of special windows types (desktop, dock, splash, ...),
2184 * i.e. window types that usually don't have a window frame and the user does not use window 2185​ * i.e. window types that usually don't have a window frame and the user does not use window
2185 * management (moving, raising,...) on them. 2186​ * management (moving, raising,...) on them.
2186 */ 2187​ */
2187 bool isSpecialWindow() const; 2188​ virtual bool isSpecialWindow() const = 0;
2188 /** 2189​ /**
2189 * Returns whether the window is a dialog window. 2190​ * Returns whether the window is a dialog window.
2190 * See _NET_WM_WINDOW_TYPE_DIALOG at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . 2191​ * See _NET_WM_WINDOW_TYPE_DIALOG at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
2191 */ 2192​ */
2192 bool isDialog() const; 2193​ virtual bool isDialog() const = 0;
2193 /** 2194​ /**
2194 * Returns whether the window is a splashscreen. Note that many (especially older) applications 2195​ * Returns whether the window is a splashscreen. Note that many (especially older) applications
2195 * do not support marking their splash windows with this type. 2196​ * do not support marking their splash windows with this type.
2196 * See _NET_WM_WINDOW_TYPE_SPLASH at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . 2197​ * See _NET_WM_WINDOW_TYPE_SPLASH at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
2197 */ 2198​ */
2198 bool isSplash() const; 2199​ virtual bool isSplash() const = 0;
2199 /** 2200​ /**
2200 * Returns whether the window is a utility window, such as a tool window. 2201​ * Returns whether the window is a utility window, such as a tool window.
2201 * See _NET_WM_WINDOW_TYPE_UTILITY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . 2202​ * See _NET_WM_WINDOW_TYPE_UTILITY at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
2202 */ 2203​ */
2203 bool isUtility() const; 2204​ virtual bool isUtility() const = 0;
2204 /** 2205​ /**
2205 * Returns whether the window is a dropdown menu (i.e. a popup directly or indirectly open 2206​ * Returns whether the window is a dropdown menu (i.e. a popup directly or indirectly open
2206 * from the applications menubar). 2207​ * from the applications menubar).
2207 * See _NET_WM_WINDOW_TYPE_DROPDOWN_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . 2208​ * See _NET_WM_WINDOW_TYPE_DROPDOWN_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
2208 */ 2209​ */
2209 bool isDropdownMenu() const; 2210​ virtual bool isDropdownMenu() const = 0;
2210 /** 2211​ /**
2211 * Returns whether the window is a popup menu (that is not a torn-off or dropdown menu). 2212​ * Returns whether the window is a popup menu (that is not a torn-off or dropdown menu).
2212 * See _NET_WM_WINDOW_TYPE_POPUP_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . 2213​ * See _NET_WM_WINDOW_TYPE_POPUP_MENU at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
2213 */ 2214​ */
2214 bool isPopupMenu() const; // a context popup, not dropdown, not torn-off 2215​ virtual bool isPopupMenu() const = 0; // a context popup, not dropdown, not torn-off
2215 /** 2216​ /**
2216 * Returns whether the window is a tooltip. 2217​ * Returns whether the window is a tooltip.
2217 * See _NET_WM_WINDOW_TYPE_TOOLTIP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . 2218​ * See _NET_WM_WINDOW_TYPE_TOOLTIP at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
2218 */ 2219​ */
2219 bool isTooltip() const; 2220​ virtual bool isTooltip() const = 0;
2220 /** 2221​ /**
2221 * Returns whether the window is a window with a notification. 2222​ * Returns whether the window is a window with a notification.
2222 * See _NET_WM_WINDOW_TYPE_NOTIFICATION at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . 2223​ * See _NET_WM_WINDOW_TYPE_NOTIFICATION at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
2223 */ 2224​ */
2224 bool isNotification() const; 2225​ virtual bool isNotification() const = 0;
2225 /** 2226​ /**
2226 * Returns whether the window is an on screen display window 2227​ * Returns whether the window is an on screen display window
2227 * using the non-standard _KDE_NET_WM_WINDOW_TYPE_ON_SCREEN_DISPLAY 2228​ * using the non-standard _KDE_NET_WM_WINDOW_TYPE_ON_SCREEN_DISPLAY
2228 */ 2229​ */
2229 bool isOnScreenDisplay() const; 2230​ virtual bool isOnScreenDisplay() const = 0;
2230 /** 2231​ /**
2231 * Returns whether the window is a combobox popup. 2232​ * Returns whether the window is a combobox popup.
2232 * See _NET_WM_WINDOW_TYPE_COMBO at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . 2233​ * See _NET_WM_WINDOW_TYPE_COMBO at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
2233 */ 2234​ */
2234 bool isComboBox() const; 2235​ virtual bool isComboBox() const = 0;
2235 /** 2236​ /**
2236 * Returns whether the window is a Drag&Drop icon. 2237​ * Returns whether the window is a Drag&Drop icon.
2237 * See _NET_WM_WINDOW_TYPE_DND at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . 2238​ * See _NET_WM_WINDOW_TYPE_DND at http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
2238 */ 2239​ */
2239 bool isDNDIcon() const; 2240​ virtual bool isDNDIcon() const = 0;
2240 /** 2241​ /**
2241 * Returns the NETWM window type 2242​ * Returns the NETWM window type
2242 * See http://standards.freedesktop.org/wm-spec/wm-spec-latest.html . 2243​ * See http://standards.freedesktop.org/wm-spec/wm-spec-latest.html .
2243 */ 2244​ */
2244 NET::WindowType windowType() const; 2245​ virtual NET::WindowType windowType() const = 0;
2245 /** 2246​ /**
2246 * Returns whether the window is managed by KWin (it has control over its placement and other 2247​ * Returns whether the window is managed by KWin (it has control over its placement and other
2247 * aspects, as opposed to override-redirect windows that are entirely handled by the application). 2248​ * aspects, as opposed to override-redirect windows that are entirely handled by the application).
2248 */ 2249​ */
2249 bool isManaged() const; // whether it's managed or override-redirect 2250​ virtual bool isManaged() const = 0; // whether it's managed or override-redirect
2250 /** 2251​ /**
2251 * Returns whether or not the window can accept keyboard focus. 2252​ * Returns whether or not the window can accept keyboard focus.
2252 */ 2253​ */
2253 bool acceptsFocus() const; 2254​ virtual bool acceptsFocus() const = 0;
2254 /** 2255​ /**
2255 * Returns whether or not the window is kept above all other windows. 2256​ * Returns whether or not the window is kept above all other windows.
2256 */ 2257​ */
2257 bool keepAbove() const; 2258​ virtual bool keepAbove() const = 0;
2258 /** 2259​ /**
2259 * Returns whether the window is kept below all other windows. 2260​ * Returns whether the window is kept below all other windows.
2260 */ 2261​ */
2261 bool keepBelow() const; 2262​ virtual bool keepBelow() const = 0;
2262 2263​
2263 bool isModal() const; 2264​ virtual bool isModal() const = 0;
2264 Q_SCRIPTABLE virtual KWin::EffectWindow* findModal() = 0; 2265​ Q_SCRIPTABLE virtual KWin::EffectWindow* findModal() = 0;
2265 Q_SCRIPTABLE virtual QList<KWin::EffectWindow*> mainWindows() const = 0; 2266​ Q_SCRIPTABLE virtual QList<KWin::EffectWindow*> mainWindows() const = 0;
2266 2267​
2267 /** 2268​ /**
2268 * Returns whether the window should be excluded from window switching effects. 2269​ * Returns whether the window should be excluded from window switching effects.
2269 * @since 4.5 2270​ * @since 4.5
2270 */ 2271​ */
2271 bool isSkipSwitcher() const; 2272​ virtual bool isSkipSwitcher() const = 0;
2272 2273​
2273 /** 2274​ /**
2274 * Returns the unmodified window quad list. Can also be used to force rebuilding. 2275​ * Returns the unmodified window quad list. Can also be used to force rebuilding.
2275 */ 2276​ */
2276 virtual WindowQuadList buildQuads(bool force = false) const = 0; 2277​ virtual WindowQuadList buildQuads(bool force = false) const = 0;
2277 2278​
2278 void setMinimized(bool minimize); 2279​ void setMinimized(bool minimize);
2279 void minimize(); 2280​ void minimize();
2280 void unminimize(); 2281​ void unminimize();
2281 Q_SCRIPTABLE void closeWindow() const; 2282​ Q_SCRIPTABLE void closeWindow() const;
2282 2283​
2283 bool isCurrentTab() const; 2284​ virtual bool isCurrentTab() const = 0;
2284 2285​
2285 /** 2286​ /**
2286 * @since 4.11 2287​ * @since 4.11
2287 **/ 2288​ **/
2288 bool isVisible() const; 2289​ bool isVisible() const;
2289 2290​
2290 /** 2291​ /**
2291 * @since 5.0 2292​ * @since 5.0
2292 **/ 2293​ **/
2293 bool skipsCloseAnimation() const; 2294​ virtual bool skipsCloseAnimation() const = 0;
2294 2295​
2295 /** 2296​ /**
2296 * @since 5.5 2297​ * @since 5.5
2297 */ 2298​ */
2298 KWayland::Server::SurfaceInterface *surface() const; 2299​ virtual KWayland::Server::SurfaceInterface *surface() const = 0;
2299 2300​
2300 /** 2301​ /**
2301 * @since 5.6 2302​ * @since 5.6
2302 **/ 2303​ **/
2303 bool isFullScreen() const; 2304​ virtual bool isFullScreen() const = 0;
2304 2305​
2305 /** 2306​ /**
2306 * @since 5.10 2307​ * @since 5.10
2307 */ 2308​ */
2308 bool isUnresponsive() const; 2309​ virtual bool isUnresponsive() const = 0;
2309 2310​
2310 /** 2311​ /**
2311 * @since 5.15 2312​ * @since 5.15
2312 **/ 2313​ **/
2313 bool isWaylandClient() const; 2314​ virtual bool isWaylandClient() const = 0;
2314 2315​
2315 /** 2316​ /**
2316 * @since 5.15 2317​ * @since 5.15
2317 **/ 2318​ **/
2318 bool isX11Client() const; 2319​ virtual bool isX11Client() const = 0;
2319 2320​
2320 /** 2321​ /**
2321 * @since 5.15 2322​ * @since 5.15
2322 **/ 2323​ **/
2323 bool isPopupWindow() const; 2324​ virtual bool isPopupWindow() const = 0;
2324 2325​
2325 /** 2326​ /**
2326 * Can be used to by effects to store arbitrary data in the EffectWindow. 2327​ * Can be used to by effects to store arbitrary data in the EffectWindow.
2327 * 2328​ *
2328 * Invoking this method will emit the signal EffectsHandler::windowDataChanged. 2329​ * Invoking this method will emit the signal EffectsHandler::windowDataChanged.
2329 * @see EffectsHandler::windowDataChanged 2330​ * @see EffectsHandler::windowDataChanged
2330 */ 2331​ */
2331 Q_SCRIPTABLE virtual void setData(int role, const QVariant &data) = 0; 2332​ Q_SCRIPTABLE virtual void setData(int role, const QVariant &data) = 0;
▲ Show 20 Lines • Show All 1559 Lines • Show Last 20 Lines