File indexing completed on 2024-09-15 09:28:30

 /*
     SPDX-FileCopyrightText: 2009 Marco Martin <notmart@gmail.com>
 
     SPDX-License-Identifier: LGPL-2.1-or-later
 */
 
 #ifndef KWINDOWEFFECTS_H
 #define KWINDOWEFFECTS_H
 
 #include "kwindowsystem_export.h"
 #include <optional>
 
 #include <QWidgetList> // for WId, etc.
 
 #include <QColor>
 #include <QRegion>
 #include <netwm_def.h>
 
 /**
  * Namespace for common standardized window effects
  */
 namespace KWindowEffects
 {
 enum Effect {
     Slide = 1,
 #if KWINDOWSYSTEM_ENABLE_DEPRECATED_SINCE(5, 82)
     PresentWindows KWINDOWSYSTEM_ENUMERATOR_DEPRECATED_VERSION(5, 82, "Check whether org.kde.KWin.PresentWindows d-bus service is registered") = 3,
     PresentWindowsGroup KWINDOWSYSTEM_ENUMERATOR_DEPRECATED_VERSION(5, 82, "Check whether org.kde.KWin.PresentWindows d-bus service is registered") = 4,
     HighlightWindows KWINDOWSYSTEM_ENUMERATOR_DEPRECATED_VERSION(5, 82, "Check whether org.kde.KWin.HighlightWindow d-bus service is registered") = 5,
 #endif
     BlurBehind = 7,
 #if KWINDOWSYSTEM_ENABLE_DEPRECATED_SINCE(5, 67)
     Dashboard KWINDOWSYSTEM_ENUMERATOR_DEPRECATED_VERSION_BELATED(5, 82, 5, 67, "Support for dashboard windows in KWin was removed long time ago") = 8,
 #endif
     BackgroundContrast = 9,
 };
 
 enum SlideFromLocation {
     NoEdge = 0,
     TopEdge,
     RightEdge,
     BottomEdge,
     LeftEdge,
 };
 /**
  * @return if an atom property is available
  *
  * @param effect the effect we want to check
  */
 KWINDOWSYSTEM_EXPORT bool isEffectAvailable(Effect effect);
 
 #if KWINDOWSYSTEM_ENABLE_DEPRECATED_SINCE(5, 82)
 /**
  * Mark a window as sliding from screen edge
  *
  * @param id of the window on which we want to apply the effect
  * @param location edge of the screen from which we want the sliding effect.
  *               Desktop and Floating won't have effect.
  * @param offset distance in pixels from the screen edge defined by location
  *
  * @deprecated Since 5.82, Use slideWindow(QWindow) overload
  */
 KWINDOWSYSTEM_EXPORT
 KWINDOWSYSTEM_DEPRECATED_VERSION(5, 82, "Use slideWindow(QWindow) overload")
 void slideWindow(WId id, SlideFromLocation location, int offset = -1);
 #endif
 
 #if KWINDOWSYSTEM_ENABLE_DEPRECATED_SINCE(5, 62)
 /**
  * Mark a window as sliding from screen edge
  * This is an overloaded member function provided for convenience
  *
  * @param widget QWidget corresponding to the top level window we want to animate
  * @param location edge of the screen from which we want the sliding effect.
  *               Desktop and Floating won't have effect.
  * @deprecated since 5.62, use slideWindow(widget->effectiveWinId(), location);
  */
 KWINDOWSYSTEM_EXPORT
 KWINDOWSYSTEM_DEPRECATED_VERSION(5, 62, "Use KWindowEffects::slideWindow(WId, SlideFromLocation, int)")
 void slideWindow(QWidget *widget, SlideFromLocation location);
 #endif
 
 #if KWINDOWSYSTEM_ENABLE_DEPRECATED_SINCE(5, 81)
 /**
  * @return dimension of all the windows passed as parameter
  *
  * @param ids all the windows we want the size
  * @deprecated since 5.81, fetch sizes through KWindowSystem instead
  */
 KWINDOWSYSTEM_EXPORT
 KWINDOWSYSTEM_DEPRECATED_VERSION(5, 81, "Fetch sizes through KWindowSystem instead")
 QList<QSize> windowSizes(const QList<WId> &ids);
 #endif
 
 #if KWINDOWSYSTEM_ENABLE_DEPRECATED_SINCE(5, 82)
 /**
  * Activate the Present Windows effect for the given groups of windows.
  *
  * @param controller The window which is the controller of this effect. The property
  *                   will be set on this window. It will be removed by the effect
  * @param ids all the windows which should be presented.
  *
  * @deprecated Since 5.82, Use org.kde.KWin.PresentWindows d-bus api
  */
 KWINDOWSYSTEM_EXPORT
 KWINDOWSYSTEM_DEPRECATED_VERSION(5, 82, "Use org.kde.KWin.PresentWindows d-bus api")
 void presentWindows(WId controller, const QList<WId> &ids);
 #endif
 
 #if KWINDOWSYSTEM_ENABLE_DEPRECATED_SINCE(5, 82)
 /**
  * Activate the Present Windows effect for the windows of the given desktop.
  *
  * @param controller The window which is the controller of this effect. The property
  *                   will be set on this window. It will be removed by the effect
  * @param desktop The desktop whose windows should be presented. -1 for all desktops
  *
  * @deprecated Since 5.82, Use org.kde.KWin.PresentWindows d-bus api
  */
 KWINDOWSYSTEM_EXPORT
 KWINDOWSYSTEM_DEPRECATED_VERSION(5, 82, "Use org.kde.KWin.PresentWindows d-bus api")
 void presentWindows(WId controller, int desktop = NET::OnAllDesktops);
 #endif
 
 #if KWINDOWSYSTEM_ENABLE_DEPRECATED_SINCE(5, 82)
 /**
  * Highlight the selected windows, making all the others translucent
  *
  * @param controller The window which is the controller of this effect. The property
  *                   will be set on this window. It will be removed by the effect
  * @param ids all the windows which should be highlighted.
  *
  * @deprecated Since 5.82, Use org.kde.KWin.HighlightWindow d-bus api
  */
 KWINDOWSYSTEM_EXPORT
 KWINDOWSYSTEM_DEPRECATED_VERSION(5, 82, "Use org.kde.KWin.HighlightWindow d-bus api")
 void highlightWindows(WId controller, const QList<WId> &ids);
 #endif
 
 #if KWINDOWSYSTEM_ENABLE_DEPRECATED_SINCE(5, 82)
 /**
  * Instructs the window manager to blur the background
  * in the specified region behind the given window.
  * The given region will overwrite any previous blur-behind region.
  * Passing a null region will enable the blur effect for the whole window.
  * The region is relative to the top-left corner of the client area.
  *
  * If @a enable is @c false, blur will be disabled for the whole window
  * (@a region is ignored).
  *
  * Note that you will usually want to set the region to the shape of the window,
  * excluding any shadow or halo.
  *
  * @param window The window for which to enable the blur effect
  * @param enable Enable the effect if @c true, disable it if @c false
  * @param region The region within the window where the background will be blurred, specified in logical pixels
  *
  * @deprecated Since 5.82, use enableBlurBehind(QWindow) overload.
  */
 KWINDOWSYSTEM_EXPORT
 KWINDOWSYSTEM_DEPRECATED_VERSION(5, 82, "Use enableBlurBehind(QWindow) overload")
 void enableBlurBehind(WId window, bool enable = true, const QRegion &region = QRegion());
 #endif
 
 #if KWINDOWSYSTEM_ENABLE_DEPRECATED_SINCE(5, 82)
 /**
  * Instructs the window manager to modify the color of the background
  * in the specified region behind the given window,
  * in order to improve the contrast and readability of any text
  * in the translucent window.
  * The given region will overwrite any previous backgroundcontrast region.
  * Passing a null region will enable the blur effect for the whole window.
  * The region is relative to the top-left corner of the client area.
  *
  * If @a enable is @c false, blur will be disabled for the whole window
  * (@a region is ignored).
  *
  * Note that you will usually want to set the region to the shape of the window,
  * excluding any shadow or halo.
  *
  * @param window The window for which to enable the background contrast effect
  * @param enable Enable the effect if @c true, disable it if @c false
  * @param brightness How to modify the area brightness: from 0 (make it black) to 2 (make it white), 1 leaves it unchanged
  * @param region The region within the window where the background will be modified, specified in logical pixels
  *
  * @deprecated Since 5.82, use enableBackgroundContrast(QWindow) overload.
  */
 KWINDOWSYSTEM_EXPORT
 KWINDOWSYSTEM_DEPRECATED_VERSION(5, 82, "Use enableBackgroundContrast(QWindow) overload")
 void enableBackgroundContrast(WId window, bool enable = true, qreal contrast = 1, qreal intensity = 1, qreal saturation = 1, const QRegion &region = QRegion());
 #endif
 
 #if KWINDOWSYSTEM_ENABLE_DEPRECATED_SINCE(5, 67)
 /**
  * Instructs the window manager to handle the given window as dashboard window as
  * Dashboard windows should be handled differently and may have special effects
  * applied to them.
  *
  * @param window The window for which to enable the blur effect
  * @deprecated since 5.67, support for dashboard windows was removed
  */
 KWINDOWSYSTEM_EXPORT
 KWINDOWSYSTEM_DEPRECATED_VERSION(5, 67, "Support for dashboard windows was removed")
 void markAsDashboard(WId window);
 #endif
 
 /**
  * Instructs the window manager to blur the background
  * in the specified region behind the given window.
  * The given region will overwrite any previous blur-behind region.
  * Passing a null region will enable the blur effect for the whole window.
  * The region is relative to the top-left corner of the client area.
  *
  * If @a enable is @c false, blur will be disabled for the whole window
  * (@a region is ignored).
  *
  * Note that you will usually want to set the region to the shape of the window,
  * excluding any shadow or halo.
  *
  * @param window The window for which to enable the blur effect
  * @param enable Enable the effect if @c true, disable it if @c false
  * @param region The region within the window where the background will be blurred, specified in logical pixels
  *
  * @since 5.82
  */
 KWINDOWSYSTEM_EXPORT void enableBlurBehind(QWindow *window, bool enable = true, const QRegion &region = QRegion());
 
 /**
  * Instructs the window manager to modify the color of the background
  * in the specified region behind the given window,
  * in order to improve the contrast and readability of any text
  * in the translucent window.
  * The given region will overwrite any previous backgroundcontrast region.
  * Passing a null region will enable the blur effect for the whole window.
  * The region is relative to the top-left corner of the client area.
  *
  * If @a enable is @c false, blur will be disabled for the whole window
  * (@a region is ignored).
  *
  * Note that you will usually want to set the region to the shape of the window,
  * excluding any shadow or halo.
  *
  * @param window The window for which to enable the background contrast effect
  * @param enable Enable the effect if @c true, disable it if @c false
  * @param brightness How to modify the area brightness: from 0 (make it black) to 2 (make it white), 1 leaves it unchanged
  * @param region The region within the window where the background will be modified, specified in logical pixels
  *
  * @since 5.82
  */
 KWINDOWSYSTEM_EXPORT void
 enableBackgroundContrast(QWindow *window, bool enable = true, qreal contrast = 1, qreal intensity = 1, qreal saturation = 1, const QRegion &region = QRegion());
 
 /**
  * Instructs the window manager to modify the color of the background
  * in the specified region behind the given window,
  * in order to improve the contrast and readability of any text
  * in the translucent window.
  * The given region will overwrite any previous backgroundcontrast region.
  * Passing a null region will enable the frost effect for the whole window.
  * The region is relative to the top-left corner of the client area.
  *
  * If @a color is null, frost will be disabled for the whole window
  * (@a region is ignored).
  *
  * Note that you will usually want to set the region to the shape of the window,
  * excluding any shadow or halo.
  *
  * @param window The window for which to enable the background frost effect
  * @param frostColor The color to use as an anchor point for adjusting colors of windows behind the window; usually a translucent version of the window's
  * background colour
  * @param region The region within the window where the background will be modified, specified in logical pixels
  *
  * @since 5.86
  */
 KWINDOWSYSTEM_EXPORT void setBackgroundFrost(QWindow *window, QColor frostColor, const QRegion &region = QRegion());
 
 /**
  * Mark a window as sliding from screen edge
  *
  * @param id of the window on which we want to apply the effect
  * @param location edge of the screen from which we want the sliding effect.
  *               Desktop and Floating won't have effect.
  * @param offset distance in pixels from the screen edge defined by location
  *
  * @since 5.82
  */
 KWINDOWSYSTEM_EXPORT void slideWindow(QWindow *window, SlideFromLocation location, int offset = -1);
 }
 
 #endif