Changeset View
Changeset View
Standalone View
Standalone View
src/server/plasmashell_interface.h
Show First 20 Lines • Show All 133 Lines • ▼ Show 20 Line(s) | 82 | public: | |||
---|---|---|---|---|---|
134 | /** | 134 | /** | ||
135 | * @returns true if this window doesn't want to be listed | 135 | * @returns true if this window doesn't want to be listed | ||
136 | * in the taskbar | 136 | * in the taskbar | ||
137 | * @since 5.5 | 137 | * @since 5.5 | ||
138 | */ | 138 | */ | ||
139 | bool skipTaskbar() const; | 139 | bool skipTaskbar() const; | ||
140 | 140 | | |||
141 | /** | 141 | /** | ||
142 | * Informs the PlasmaShellSurfaceInterface that the auto-hiding panel got hidden. | ||||
143 | * Once it is shown again the method @link{showAutoHidingPanel} should be used. | ||||
144 | * | ||||
145 | * @see showAutoHidingPanel | ||||
146 | * @see panelAutoHideHideRequested | ||||
147 | * @see panelAutoHideShowRequested | ||||
148 | * @since 5.28 | ||||
149 | **/ | ||||
150 | void hideAutoHidingPanel(); | ||||
151 | | ||||
152 | /** | ||||
153 | * Informs the PlasmaShellSurfaceInterface that the auto-hiding panel got shown again. | ||||
154 | * | ||||
155 | * @see hideAutoHidingPanel | ||||
156 | * @see panelAutoHideHideRequested | ||||
157 | * @see panelAutoHideShowRequested | ||||
158 | * @see 5.28 | ||||
159 | **/ | ||||
160 | void showAutoHidingPanel(); | ||||
161 | | ||||
162 | /** | ||||
142 | * @returns The PlasmaShellSurfaceInterface for the @p native resource. | 163 | * @returns The PlasmaShellSurfaceInterface for the @p native resource. | ||
143 | * @since 5.5 | 164 | * @since 5.5 | ||
144 | **/ | 165 | **/ | ||
145 | static PlasmaShellSurfaceInterface *get(wl_resource *native); | 166 | static PlasmaShellSurfaceInterface *get(wl_resource *native); | ||
146 | 167 | | |||
147 | Q_SIGNALS: | 168 | Q_SIGNALS: | ||
148 | /** | 169 | /** | ||
149 | * A change of global position has been requested. | 170 | * A change of global position has been requested. | ||
150 | **/ | 171 | **/ | ||
151 | void positionChanged(); | 172 | void positionChanged(); | ||
152 | /** | 173 | /** | ||
153 | * A change of the role has been requested. | 174 | * A change of the role has been requested. | ||
154 | **/ | 175 | **/ | ||
155 | void roleChanged(); | 176 | void roleChanged(); | ||
156 | /** | 177 | /** | ||
157 | * A change of the panel behavior has been requested. | 178 | * A change of the panel behavior has been requested. | ||
158 | **/ | 179 | **/ | ||
159 | void panelBehaviorChanged(); | 180 | void panelBehaviorChanged(); | ||
160 | /** | 181 | /** | ||
161 | * A change in the skip taskbar property has been requested | 182 | * A change in the skip taskbar property has been requested | ||
162 | */ | 183 | */ | ||
163 | void skipTaskbarChanged(); | 184 | void skipTaskbarChanged(); | ||
164 | 185 | | |||
186 | /** | ||||
187 | * A surface with Role Panel and PanelBehavior AutoHide requested to be hidden. | ||||
188 | * | ||||
189 | * The compositor should inform the PlasmaShellSurfaceInterface about the actual change. | ||||
190 | * Once the surface is hidden it should invoke @link{hideAutoHidingPanel}. If the compositor | ||||
191 | * cannot hide the surface (e.g. because it doesn't border a screen edge) it should inform | ||||
192 | * the surface through invoking @link{showAutoHidingPanel}. This method should also be invoked | ||||
193 | * whenever the surface gets shown again due to triggering the screen edge. | ||||
194 | * | ||||
195 | * @see hideAutoHidingPanel | ||||
196 | * @see showAutoHidingPanel | ||||
197 | * @see panelAutoHideShowRequested | ||||
198 | * @since 5.28 | ||||
199 | **/ | ||||
200 | void panelAutoHideHideRequested(); | ||||
201 | | ||||
202 | /** | ||||
203 | * A surface with Role Panel and PanelBehavior AutoHide requested to be shown. | ||||
204 | * | ||||
205 | * The compositor should inform the PlasmaShellSurfaceInterface about the actual change. | ||||
206 | * Once the surface is shown it should invoke @link{showAutoHidingPanel}. | ||||
207 | * | ||||
208 | * @see hideAutoHidingPanel | ||||
209 | * @see showAutoHidingPanel | ||||
210 | * @see panelAutoHideHideRequested | ||||
211 | * @since 5.28 | ||||
212 | **/ | ||||
213 | void panelAutoHideShowRequested(); | ||||
214 | | ||||
165 | private: | 215 | private: | ||
166 | friend class PlasmaShellInterface; | 216 | friend class PlasmaShellInterface; | ||
167 | explicit PlasmaShellSurfaceInterface(PlasmaShellInterface *shell, SurfaceInterface *parent, wl_resource *parentResource); | 217 | explicit PlasmaShellSurfaceInterface(PlasmaShellInterface *shell, SurfaceInterface *parent, wl_resource *parentResource); | ||
168 | class Private; | 218 | class Private; | ||
169 | Private *d_func() const; | 219 | Private *d_func() const; | ||
170 | }; | 220 | }; | ||
171 | 221 | | |||
172 | } | 222 | } | ||
173 | } | 223 | } | ||
174 | 224 | | |||
175 | Q_DECLARE_METATYPE(KWayland::Server::PlasmaShellSurfaceInterface::Role) | 225 | Q_DECLARE_METATYPE(KWayland::Server::PlasmaShellSurfaceInterface::Role) | ||
176 | Q_DECLARE_METATYPE(KWayland::Server::PlasmaShellSurfaceInterface::PanelBehavior) | 226 | Q_DECLARE_METATYPE(KWayland::Server::PlasmaShellSurfaceInterface::PanelBehavior) | ||
177 | 227 | | |||
178 | #endif | 228 | #endif |