Changeset View
Changeset View
Standalone View
Standalone View
src/kwindoweffects.h
Show First 20 Lines • Show All 121 Lines • ▼ Show 20 Line(s) | |||||
122 | * If @a enable is @c false, blur will be disabled for the whole window | 122 | * If @a enable is @c false, blur will be disabled for the whole window | ||
123 | * (@a region is ignored). | 123 | * (@a region is ignored). | ||
124 | * | 124 | * | ||
125 | * Note that you will usually want to set the region to the shape of the window, | 125 | * Note that you will usually want to set the region to the shape of the window, | ||
126 | * excluding any shadow or halo. | 126 | * excluding any shadow or halo. | ||
127 | * | 127 | * | ||
128 | * @param window The window for which to enable the blur effect | 128 | * @param window The window for which to enable the blur effect | ||
129 | * @param enable Enable the effect if @c true, disable it if @c false | 129 | * @param enable Enable the effect if @c true, disable it if @c false | ||
130 | * @param region The region within the window where the background will be blurred | 130 | * @param region The region within the window where the background will be blurred, specified in logical pixels | ||
131 | */ | 131 | */ | ||
132 | KWINDOWSYSTEM_EXPORT void enableBlurBehind(WId window, bool enable = true, const QRegion ®ion = QRegion()); | 132 | KWINDOWSYSTEM_EXPORT void enableBlurBehind(WId window, bool enable = true, const QRegion ®ion = QRegion()); | ||
133 | 133 | | |||
134 | /** | 134 | /** | ||
135 | * Instructs the window manager to modify the color of the background | 135 | * Instructs the window manager to modify the color of the background | ||
136 | * in the specified region behind the given window, | 136 | * in the specified region behind the given window, | ||
137 | * in order to improve the contrast and readability of any text | 137 | * in order to improve the contrast and readability of any text | ||
138 | * in the translucent window. | 138 | * in the translucent window. | ||
139 | * The given region will overwrite any previous backgroundcontrast region. | 139 | * The given region will overwrite any previous backgroundcontrast region. | ||
140 | * Passing a null region will enable the blur effect for the whole window. | 140 | * Passing a null region will enable the blur effect for the whole window. | ||
141 | * The region is relative to the top-left corner of the client area. | 141 | * The region is relative to the top-left corner of the client area. | ||
142 | * | 142 | * | ||
143 | * If @a enable is @c false, blur will be disabled for the whole window | 143 | * If @a enable is @c false, blur will be disabled for the whole window | ||
144 | * (@a region is ignored). | 144 | * (@a region is ignored). | ||
145 | * | 145 | * | ||
146 | * Note that you will usually want to set the region to the shape of the window, | 146 | * Note that you will usually want to set the region to the shape of the window, | ||
147 | * excluding any shadow or halo. | 147 | * excluding any shadow or halo. | ||
148 | * | 148 | * | ||
149 | * @param window The window for which to enable the background contrast effect | 149 | * @param window The window for which to enable the background contrast effect | ||
150 | * @param enable Enable the effect if @c true, disable it if @c false | 150 | * @param enable Enable the effect if @c true, disable it if @c false | ||
151 | * @param brightness How to modify the area brightness: from 0 (make it black) to 2 (make it white), 1 leaves it unchanged | 151 | * @param brightness How to modify the area brightness: from 0 (make it black) to 2 (make it white), 1 leaves it unchanged | ||
152 | * @param region The region within the window where the background will be modified | 152 | * @param region The region within the window where the background will be modified, specified in logical pixels | ||
153 | */ | 153 | */ | ||
154 | KWINDOWSYSTEM_EXPORT void enableBackgroundContrast(WId window, bool enable = true, qreal contrast = 1, qreal intensity = 1, qreal saturation = 1, const QRegion ®ion = QRegion()); | 154 | KWINDOWSYSTEM_EXPORT void enableBackgroundContrast(WId window, bool enable = true, qreal contrast = 1, qreal intensity = 1, qreal saturation = 1, const QRegion ®ion = QRegion()); | ||
155 | 155 | | |||
156 | /** | 156 | /** | ||
157 | * Instructs the window manager to handle the given window as dashboard window as | 157 | * Instructs the window manager to handle the given window as dashboard window as | ||
158 | * Dashboard windows should be handled diffrently and may have special effects | 158 | * Dashboard windows should be handled diffrently and may have special effects | ||
159 | * applied to them. | 159 | * applied to them. | ||
160 | * | 160 | * | ||
161 | * @param window The window for which to enable the blur effect | 161 | * @param window The window for which to enable the blur effect | ||
162 | */ | 162 | */ | ||
163 | KWINDOWSYSTEM_EXPORT void markAsDashboard(WId window); | 163 | KWINDOWSYSTEM_EXPORT void markAsDashboard(WId window); | ||
164 | } | 164 | } | ||
165 | 165 | | |||
166 | #endif | 166 | #endif | ||
167 | 167 | |