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  * 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/common.h>
25 
26 struct MirKeyboardEvent;
27 struct MirTouchEvent;
28 struct MirPointerEvent;
29 struct MirInputEvent;
30 
31 #include <memory>
32 
33 namespace miral
34 {
35 class Window;
36 class WindowSpecification;
37 struct ApplicationInfo;
38 class Output;
39 class Zone;
40 struct WindowInfo;
41 
46 class Workspace;
47 
48 using namespace mir::geometry;
49 
52 {
53 public:
55  virtual void advise_begin();
56 
58  virtual void advise_end();
59 
66  virtual auto place_new_window(
67  ApplicationInfo const& app_info,
68  WindowSpecification const& requested_specification) -> WindowSpecification = 0;
69 
77  virtual void handle_window_ready(WindowInfo& window_info) = 0;
78 
85  virtual void handle_modify_window(WindowInfo& window_info, WindowSpecification const& modifications) = 0;
86 
92  virtual void handle_raise_window(WindowInfo& window_info) = 0;
93 
105  WindowInfo const& window_info,
106  MirWindowState new_state,
107  Rectangle const& new_placement) -> Rectangle = 0;
118  virtual bool handle_keyboard_event(MirKeyboardEvent const* event) = 0;
119 
125  virtual bool handle_touch_event(MirTouchEvent const* event) = 0;
126 
132  virtual bool handle_pointer_event(MirPointerEvent const* event) = 0;
143  virtual void advise_new_app(ApplicationInfo& application);
144 
149  virtual void advise_delete_app(ApplicationInfo const& application);
150 
155  virtual void advise_new_window(WindowInfo const& window_info);
156 
161  virtual void advise_focus_lost(WindowInfo const& window_info);
162 
167  virtual void advise_focus_gained(WindowInfo const& window_info);
168 
174  virtual void advise_state_change(WindowInfo const& window_info, MirWindowState state);
175 
181  virtual void advise_move_to(WindowInfo const& window_info, Point top_left);
182 
188  virtual void advise_resize(WindowInfo const& window_info, Size const& new_size);
189 
194  virtual void advise_delete_window(WindowInfo const& window_info);
195 
203  virtual void advise_raise(std::vector<Window> const& windows);
217  std::shared_ptr<Workspace> const& workspace,
218  std::vector<Window> const& windows);
219 
228  std::shared_ptr<Workspace> const& workspace,
229  std::vector<Window> const& windows);
240  virtual void handle_request_drag_and_drop(WindowInfo& window_info) = 0;
241 
248  virtual void handle_request_move(WindowInfo& window_info, MirInputEvent const* input_event) = 0;
249 
257  virtual void handle_request_resize(WindowInfo& window_info, MirInputEvent const* input_event, MirResizeEdge edge) = 0;
262  virtual void advise_output_create(Output const& output);
263  virtual void advise_output_update(Output const& updated, Output const& original);
264  virtual void advise_output_delete(Output const& output);
265 
275  virtual auto confirm_inherited_move(WindowInfo const& window_info, Displacement movement) -> Rectangle = 0;
276 
283  virtual void advise_application_zone_create(Zone const& application_zone);
284  virtual void advise_application_zone_update(Zone const& updated, Zone const& original);
285  virtual void advise_application_zone_delete(Zone const& application_zone);
288  virtual ~WindowManagementPolicy() = default;
292 };
293 
294 class WindowManagerTools;
295 }
296 
297 #endif //MIRAL_WINDOW_MANAGEMENT_POLICY_H
miral::WindowManagementPolicy::WindowManagementPolicy
WindowManagementPolicy()=default
rectangles.h
MirKeyboardEvent
struct MirKeyboardEvent MirKeyboardEvent
An event type describing a change in keyboard state.
Definition: keyboard_event.h:41
miral::WindowManagementPolicy::advise_application_zone_create
virtual void advise_application_zone_create(Zone const &application_zone)
miral
Mir Abstraction Layer.
Definition: floating_window_manager.h:31
miral::ApplicationInfo
Definition: application_info.h:32
displacement.h
miral::WindowManagementPolicy::~WindowManagementPolicy
virtual ~WindowManagementPolicy()=default
miral::WindowManagementPolicy::advise_state_change
virtual void advise_state_change(WindowInfo const &window_info, MirWindowState state)
Notification that a window is about to change state.
miral::WindowManagementPolicy::advise_output_delete
virtual void advise_output_delete(Output const &output)
miral::WindowManagementPolicy::advise_focus_lost
virtual void advise_focus_lost(WindowInfo const &window_info)
Notification that a window has lost focus.
miral::WindowManagementPolicy::advise_begin
virtual void advise_begin()
before any related calls begin
miral::WindowManagementPolicy::advise_focus_gained
virtual void advise_focus_gained(WindowInfo const &window_info)
Notification that a window has gained focus.
miral::WindowSpecification
Definition: window_specification.h:44
miral::WindowManagementPolicy::confirm_inherited_move
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.
miral::WindowManagementPolicy::advise_new_window
virtual void advise_new_window(WindowInfo const &window_info)
Notification that a window has been created.
miral::WindowManagementPolicy::advise_output_update
virtual void advise_output_update(Output const &updated, Output const &original)
miral::WindowManagementPolicy::advise_removing_from_workspace
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.
miral::WindowManagementPolicy::advise_move_to
virtual void advise_move_to(WindowInfo const &window_info, Point top_left)
Notification that a window is about to move.
mir::geometry::Rectangle
Definition: rectangle.h:34
miral::WindowManagementPolicy::handle_window_ready
virtual void handle_window_ready(WindowInfo &window_info)=0
notification that the first buffer has been posted
miral::WindowManagementPolicy
The interface through which the window management policy is determined.
Definition: window_management_policy.h:52
miral::WindowManagementPolicy::advise_delete_window
virtual void advise_delete_window(WindowInfo const &window_info)
Notification that a window is about to be destroyed.
MirResizeEdge
MirResizeEdge
Hints for resizing a window.
Definition: common.h:347
miral::WindowManagementPolicy::handle_request_resize
virtual void handle_request_resize(WindowInfo &window_info, MirInputEvent const *input_event, MirResizeEdge edge)=0
request from client to initiate resize
miral::WindowManagementPolicy::advise_output_create
virtual void advise_output_create(Output const &output)
miral::WindowManagementPolicy::advise_adding_to_workspace
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.
miral::WindowManagementPolicy::handle_touch_event
virtual bool handle_touch_event(MirTouchEvent const *event)=0
touch event handler
MirPointerEvent
struct MirPointerEvent MirPointerEvent
An event type describing a change in pointer device state.
Definition: pointer_event.h:35
MirWindowState
MirWindowState
Definition: common.h:88
miral::WindowManagementPolicy::handle_request_move
virtual void handle_request_move(WindowInfo &window_info, MirInputEvent const *input_event)=0
request from client to initiate move
miral::WindowManagementPolicy::handle_raise_window
virtual void handle_raise_window(WindowInfo &window_info)=0
request from client to raise the window
miral::WindowManagementPolicy::handle_keyboard_event
virtual bool handle_keyboard_event(MirKeyboardEvent const *event)=0
keyboard event handler
miral::Output
Definition: output.h:36
mir::geometry
Basic geometry types. Types for dimensions, displacements, etc. and the operations that they support.
Definition: dimensions.h:31
MirInputEvent
struct MirInputEvent MirInputEvent
Definition: event.h:42
mir::geometry::Displacement
Definition: displacement.h:34
miral::WindowManagerTools
Window management functions for querying and updating MirAL's model.
Definition: window_manager_tools.h:60
miral::WindowManagementPolicy::advise_application_zone_delete
virtual void advise_application_zone_delete(Zone const &application_zone)
common.h
miral::WindowInfo
Definition: window_info.h:33
miral::WindowManagementPolicy::advise_application_zone_update
virtual void advise_application_zone_update(Zone const &updated, Zone const &original)
miral::WindowManagementPolicy::place_new_window
virtual auto place_new_window(ApplicationInfo const &app_info, WindowSpecification const &requested_specification) -> WindowSpecification=0
Customize initial window placement.
miral::WindowManagementPolicy::confirm_placement_on_display
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.
miral::WindowManagementPolicy::advise_new_app
virtual void advise_new_app(ApplicationInfo &application)
Notification that a new application has connected.
MirTouchEvent
struct MirTouchEvent MirTouchEvent
An event type describing a change in touch device state.
Definition: touch_event.h:33
mir::geometry::Point
Definition: point.h:31
miral::WindowManagementPolicy::advise_end
virtual void advise_end()
after any related calls end
miral::WindowManagementPolicy::operator=
WindowManagementPolicy & operator=(WindowManagementPolicy const &)=delete
miral::WindowManagementPolicy::handle_pointer_event
virtual bool handle_pointer_event(MirPointerEvent const *event)=0
pointer event handler
miral::Zone
A rectangular area of the display. Not tied to a specific output.
Definition: zone.h:36
miral::WindowManagementPolicy::handle_modify_window
virtual void handle_modify_window(WindowInfo &window_info, WindowSpecification const &modifications)=0
request from client to modify the window specification.
miral::WindowManagementPolicy::advise_raise
virtual void advise_raise(std::vector< Window > const &windows)
Notification that windows are being raised to the top.
Output
Definition: wayland_helpers.h:37
miral::WindowManagementPolicy::advise_resize
virtual void advise_resize(WindowInfo const &window_info, Size const &new_size)
Notification that a window is about to resize.
miral::WindowManagementPolicy::WindowManagementPolicy
WindowManagementPolicy(WindowManagementPolicy const &)=delete
miral::WindowManagementPolicy::advise_delete_app
virtual void advise_delete_app(ApplicationInfo const &application)
Notification that an application has disconnected.
mir::geometry::Size
Definition: size.h:32
miral::WindowManagementPolicy::handle_request_drag_and_drop
virtual void handle_request_drag_and_drop(WindowInfo &window_info)=0
request from client to initiate drag and drop

Copyright © 2012-2020 Canonical Ltd.
Generated on Thu Dec 17 06:53:45 UTC 2020
This documentation is licensed under the GPL version 2 or 3.