Mir
window_management_policy.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2016 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 namespace miral
27 {
28 class Window;
29 class WindowSpecification;
30 struct ApplicationInfo;
31 struct WindowInfo;
32 
33 using namespace mir::geometry;
34 
37 {
38 public:
40  virtual void advise_begin();
41 
43  virtual void advise_end();
44 
51  virtual auto place_new_window(
52  ApplicationInfo const& app_info,
53  WindowSpecification const& requested_specification) -> WindowSpecification = 0;
54 
62  virtual void handle_window_ready(WindowInfo& window_info) = 0;
63 
70  virtual void handle_modify_window(WindowInfo& window_info, WindowSpecification const& modifications) = 0;
71 
77  virtual void handle_raise_window(WindowInfo& window_info) = 0;
88  virtual bool handle_keyboard_event(MirKeyboardEvent const* event) = 0;
89 
95  virtual bool handle_touch_event(MirTouchEvent const* event) = 0;
96 
102  virtual bool handle_pointer_event(MirPointerEvent const* event) = 0;
113  virtual void advise_new_app(ApplicationInfo& application);
114 
119  virtual void advise_delete_app(ApplicationInfo const& application);
120 
125  virtual void advise_new_window(WindowInfo const& window_info);
126 
131  virtual void advise_focus_lost(WindowInfo const& window_info);
132 
137  virtual void advise_focus_gained(WindowInfo const& window_info);
138 
144  virtual void advise_state_change(WindowInfo const& window_info, MirWindowState state);
145 
151  virtual void advise_move_to(WindowInfo const& window_info, Point top_left);
152 
158  virtual void advise_resize(WindowInfo const& window_info, Size const& new_size);
159 
164  virtual void advise_delete_window(WindowInfo const& window_info);
165 
173  virtual void advise_raise(std::vector<Window> const& windows);
183  virtual auto confirm_inherited_move(WindowInfo const& window_info, Displacement movement) -> Rectangle = 0;
184 
185  virtual ~WindowManagementPolicy() = default;
186  WindowManagementPolicy() = default;
188  WindowManagementPolicy& operator=(WindowManagementPolicy const&) = delete;
189 };
190 
191 class WindowManagerTools;
192 }
193 
194 #endif //MIRAL_WINDOW_MANAGEMENT_POLICY_H
Definition: size.h:30
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: 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:36
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
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:32

Copyright © 2012-2017 Canonical Ltd.
Generated on Mon Oct 30 19:44:55 UTC 2017