Mir
window_management_policy.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2016-2020 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 
17 #ifndef MIRAL_WINDOW_MANAGEMENT_POLICY_H
18 #define MIRAL_WINDOW_MANAGEMENT_POLICY_H
19 
22 #include <mir_toolkit/common.h>
23 
24 struct MirKeyboardEvent;
25 struct MirTouchEvent;
26 struct MirPointerEvent;
27 struct MirInputEvent;
28 
29 #include <memory>
30 
31 namespace miral
32 {
33 class Window;
34 class WindowSpecification;
35 struct ApplicationInfo;
36 class Output;
37 class Zone;
38 struct WindowInfo;
39 
44 class Workspace;
45 
46 using namespace mir::geometry;
47 
50 {
51 public:
53  virtual void advise_begin();
54 
56  virtual void advise_end();
57 
64  virtual auto place_new_window(
65  ApplicationInfo const& app_info,
66  WindowSpecification const& requested_specification) -> WindowSpecification = 0;
67 
75  virtual void handle_window_ready(WindowInfo& window_info) = 0;
76 
83  virtual void handle_modify_window(WindowInfo& window_info, WindowSpecification const& modifications) = 0;
84 
90  virtual void handle_raise_window(WindowInfo& window_info) = 0;
91 
103  WindowInfo const& window_info,
104  MirWindowState new_state,
105  Rectangle const& new_placement) -> Rectangle = 0;
116  virtual bool handle_keyboard_event(MirKeyboardEvent const* event) = 0;
117 
123  virtual bool handle_touch_event(MirTouchEvent const* event) = 0;
124 
130  virtual bool handle_pointer_event(MirPointerEvent const* event) = 0;
141  virtual void advise_new_app(ApplicationInfo& application);
142 
147  virtual void advise_delete_app(ApplicationInfo const& application);
148 
153  virtual void advise_new_window(WindowInfo const& window_info);
154 
159  virtual void advise_focus_lost(WindowInfo const& window_info);
160 
165  virtual void advise_focus_gained(WindowInfo const& window_info);
166 
172  virtual void advise_state_change(WindowInfo const& window_info, MirWindowState state);
173 
179  virtual void advise_move_to(WindowInfo const& window_info, Point top_left);
180 
186  virtual void advise_resize(WindowInfo const& window_info, Size const& new_size);
187 
192  virtual void advise_delete_window(WindowInfo const& window_info);
193 
201  virtual void advise_raise(std::vector<Window> const& windows);
215  std::shared_ptr<Workspace> const& workspace,
216  std::vector<Window> const& windows);
217 
226  std::shared_ptr<Workspace> const& workspace,
227  std::vector<Window> const& windows);
238  virtual void handle_request_drag_and_drop(WindowInfo& window_info) = 0;
239 
246  virtual void handle_request_move(WindowInfo& window_info, MirInputEvent const* input_event) = 0;
247 
255  virtual void handle_request_resize(WindowInfo& window_info, MirInputEvent const* input_event, MirResizeEdge edge) = 0;
260  virtual void advise_output_create(Output const& output);
261  virtual void advise_output_update(Output const& updated, Output const& original);
262  virtual void advise_output_delete(Output const& output);
263 
273  virtual auto confirm_inherited_move(WindowInfo const& window_info, Displacement movement) -> Rectangle = 0;
274 
281  virtual void advise_application_zone_create(Zone const& application_zone);
282  virtual void advise_application_zone_update(Zone const& updated, Zone const& original);
283  virtual void advise_application_zone_delete(Zone const& application_zone);
286  virtual ~WindowManagementPolicy() = default;
290 };
291 
292 class WindowManagerTools;
293 }
294 
295 #endif //MIRAL_WINDOW_MANAGEMENT_POLICY_H
Definition: output.h:34
The interface through which the window management policy is determined.
Definition: window_management_policy.h:50
virtual void advise_delete_window(WindowInfo const &window_info)
Notification that a window is about to be destroyed.
virtual void advise_move_to(WindowInfo const &window_info, Point top_left)
Notification that a window is about to move.
virtual void advise_removing_from_workspace(std::shared_ptr< Workspace > const &workspace, std::vector< Window > const &windows)
Notification that windows are being removed from a workspace.
virtual void handle_raise_window(WindowInfo &window_info)=0
request from client to raise the window
virtual void handle_request_resize(WindowInfo &window_info, MirInputEvent const *input_event, MirResizeEdge edge)=0
request from client to initiate resize
virtual void advise_application_zone_update(Zone const &updated, Zone const &original)
virtual auto confirm_placement_on_display(WindowInfo const &window_info, MirWindowState new_state, Rectangle const &new_placement) -> Rectangle=0
Confirm (and optionally adjust) the placement of a window on the display.
virtual void handle_request_drag_and_drop(WindowInfo &window_info)=0
request from client to initiate drag and drop
virtual void advise_focus_lost(WindowInfo const &window_info)
Notification that a window has lost focus.
virtual ~WindowManagementPolicy()=default
virtual void handle_window_ready(WindowInfo &window_info)=0
notification that the first buffer has been posted
virtual void advise_begin()
before any related calls begin
virtual void handle_request_move(WindowInfo &window_info, MirInputEvent const *input_event)=0
request from client to initiate move
virtual void advise_output_create(Output const &output)
virtual auto confirm_inherited_move(WindowInfo const &window_info, Displacement movement) -> Rectangle=0
Confirm (and optionally adjust) the motion of a child window when the parent is moved.
virtual auto place_new_window(ApplicationInfo const &app_info, WindowSpecification const &requested_specification) -> WindowSpecification=0
Customize initial window placement.
virtual void advise_output_update(Output const &updated, Output const &original)
virtual void advise_focus_gained(WindowInfo const &window_info)
Notification that a window has gained focus.
virtual void advise_new_window(WindowInfo const &window_info)
Notification that a window has been created.
virtual void advise_delete_app(ApplicationInfo const &application)
Notification that an application has disconnected.
virtual void advise_output_delete(Output const &output)
virtual void advise_application_zone_delete(Zone const &application_zone)
WindowManagementPolicy & operator=(WindowManagementPolicy const &)=delete
virtual bool handle_pointer_event(MirPointerEvent const *event)=0
pointer event handler
WindowManagementPolicy(WindowManagementPolicy const &)=delete
virtual void advise_resize(WindowInfo const &window_info, Size const &new_size)
Notification that a window is about to resize.
virtual void advise_state_change(WindowInfo const &window_info, MirWindowState state)
Notification that a window is about to change state.
virtual void advise_application_zone_create(Zone const &application_zone)
virtual void advise_raise(std::vector< Window > const &windows)
Notification that windows are being raised to the top.
virtual bool handle_touch_event(MirTouchEvent const *event)=0
touch event handler
virtual void advise_adding_to_workspace(std::shared_ptr< Workspace > const &workspace, std::vector< Window > const &windows)
Notification that windows are being added to a workspace.
virtual void handle_modify_window(WindowInfo &window_info, WindowSpecification const &modifications)=0
request from client to modify the window specification.
virtual void advise_end()
after any related calls end
virtual void advise_new_app(ApplicationInfo &application)
Notification that a new application has connected.
virtual bool handle_keyboard_event(MirKeyboardEvent const *event)=0
keyboard event handler
Window management functions for querying and updating MirAL's model.
Definition: window_manager_tools.h:58
Definition: window_specification.h:42
A rectangular area of the display. Not tied to a specific output.
Definition: zone.h:34
MirResizeEdge
Hints for resizing a window.
Definition: common.h:331
MirWindowState
Definition: common.h:71
Basic geometry types. Types for dimensions, displacements, etc. and the operations that they support.
Definition: dimensions.h:29
Mir Abstraction Layer.
Definition: floating_window_manager.h:29
Definition: displacement.h:30
Definition: point.h:30
Definition: rectangle.h:31
Definition: size.h:30
Definition: application_info.h:30
Definition: window_info.h:31

Copyright © 2012-2022 Canonical Ltd.
Generated on Tue May 31 01:20:27 UTC 2022
This documentation is licensed under the GPL version 2 or 3.