Mir
window_management_policy.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2016-2018 Canonical Ltd.
3  *
4  * This program is free software: you can redistribute it and/or modify it
5  * under the terms of the GNU General Public License version 2 or 3 as
6  * published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * Authored by: Alan Griffiths <alan@octopull.co.uk>
17  */
18 
19 #ifndef MIRAL_WINDOW_MANAGEMENT_POLICY_H
20 #define MIRAL_WINDOW_MANAGEMENT_POLICY_H
21 
24 #include <mir_toolkit/event.h>
25 
26 #include <memory>
27 
28 namespace miral
29 {
30 class Window;
31 class WindowSpecification;
32 struct ApplicationInfo;
33 class Output;
34 struct WindowInfo;
35 
40 class Workspace;
41 
42 using namespace mir::geometry;
43 
46 {
47 public:
49  virtual void advise_begin();
50 
52  virtual void advise_end();
53 
60  virtual auto place_new_window(
61  ApplicationInfo const& app_info,
62  WindowSpecification const& requested_specification) -> WindowSpecification = 0;
63 
71  virtual void handle_window_ready(WindowInfo& window_info) = 0;
72 
79  virtual void handle_modify_window(WindowInfo& window_info, WindowSpecification const& modifications) = 0;
80 
86  virtual void handle_raise_window(WindowInfo& window_info) = 0;
87 
98  virtual auto confirm_placement_on_display(
99  WindowInfo const& window_info,
100  MirWindowState new_state,
101  Rectangle const& new_placement) -> Rectangle = 0;
112  virtual bool handle_keyboard_event(MirKeyboardEvent const* event) = 0;
113 
119  virtual bool handle_touch_event(MirTouchEvent const* event) = 0;
120 
126  virtual bool handle_pointer_event(MirPointerEvent const* event) = 0;
137  virtual void advise_new_app(ApplicationInfo& application);
138 
143  virtual void advise_delete_app(ApplicationInfo const& application);
144 
149  virtual void advise_new_window(WindowInfo const& window_info);
150 
155  virtual void advise_focus_lost(WindowInfo const& window_info);
156 
161  virtual void advise_focus_gained(WindowInfo const& window_info);
162 
168  virtual void advise_state_change(WindowInfo const& window_info, MirWindowState state);
169 
175  virtual void advise_move_to(WindowInfo const& window_info, Point top_left);
176 
182  virtual void advise_resize(WindowInfo const& window_info, Size const& new_size);
183 
188  virtual void advise_delete_window(WindowInfo const& window_info);
189 
197  virtual void advise_raise(std::vector<Window> const& windows);
210  virtual void advise_adding_to_workspace(
211  std::shared_ptr<Workspace> const& workspace,
212  std::vector<Window> const& windows);
213 
221  virtual void advise_removing_from_workspace(
222  std::shared_ptr<Workspace> const& workspace,
223  std::vector<Window> const& windows);
234  virtual void handle_request_drag_and_drop(WindowInfo& window_info) = 0;
235 
242  virtual void handle_request_move(WindowInfo& window_info, MirInputEvent const* input_event) = 0;
243 
251  virtual void handle_request_resize(WindowInfo& window_info, MirInputEvent const* input_event, MirResizeEdge edge) = 0;
256  virtual void advise_output_create(Output const& output);
257  virtual void advise_output_update(Output const& updated, Output const& original);
258  virtual void advise_output_delete(Output const& output);
259 
269  virtual auto confirm_inherited_move(WindowInfo const& window_info, Displacement movement) -> Rectangle = 0;
270 
271  virtual ~WindowManagementPolicy() = default;
272  WindowManagementPolicy() = default;
274  WindowManagementPolicy& operator=(WindowManagementPolicy const&) = delete;
275 };
276 
277 class WindowManagerTools;
278 }
279 
280 #endif //MIRAL_WINDOW_MANAGEMENT_POLICY_H
Definition: size.h:30
MirResizeEdge
Hints for resizing a window.
Definition: common.h:409
Definition: point.h:30
struct MirPointerEvent MirPointerEvent
An event type describing a change in pointer device state.
Definition: pointer_event.h:35
Definition: application_info.h:31
Definition: window_info.h:32
Definition: output.h:35
Definition: window_specification.h:43
struct MirTouchEvent MirTouchEvent
An event type describing a change in touch device state.
Definition: touch_event.h:33
The interface through which the window management policy is determined.
Definition: window_management_policy.h:45
Definition: displacement.h:32
Window management functions for querying and updating MirAL&#39;s model.
Definition: window_manager_tools.h:58
struct MirKeyboardEvent MirKeyboardEvent
An event type describing a change in keyboard state.
Definition: keyboard_event.h:41
Definition: rectangle.h:33
struct MirInputEvent MirInputEvent
Definition: event.h:70
Basic geometry types. Types for dimensions, displacements, etc. and the operations that they support...
Definition: dimensions.h:30
MirWindowState
Definition: common.h:139
Mir Abstraction Layer.
Definition: floating_window_manager.h:29

Copyright © 2012-2018 Canonical Ltd.
Generated on Sat Sep 29 01:47:23 UTC 2018
This documentation is licensed under the GPL version 2 or 3.