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 class Zone;
35 struct WindowInfo;
36 
41 class Workspace;
42 
43 using namespace mir::geometry;
44 
47 {
48 public:
50  virtual void advise_begin();
51 
53  virtual void advise_end();
54 
61  virtual auto place_new_window(
62  ApplicationInfo const& app_info,
63  WindowSpecification const& requested_specification) -> WindowSpecification = 0;
64 
72  virtual void handle_window_ready(WindowInfo& window_info) = 0;
73 
80  virtual void handle_modify_window(WindowInfo& window_info, WindowSpecification const& modifications) = 0;
81 
87  virtual void handle_raise_window(WindowInfo& window_info) = 0;
88 
100  WindowInfo const& window_info,
101  MirWindowState new_state,
102  Rectangle const& new_placement) -> Rectangle = 0;
113  virtual bool handle_keyboard_event(MirKeyboardEvent const* event) = 0;
114 
120  virtual bool handle_touch_event(MirTouchEvent const* event) = 0;
121 
127  virtual bool handle_pointer_event(MirPointerEvent const* event) = 0;
138  virtual void advise_new_app(ApplicationInfo& application);
139 
144  virtual void advise_delete_app(ApplicationInfo const& application);
145 
150  virtual void advise_new_window(WindowInfo const& window_info);
151 
156  virtual void advise_focus_lost(WindowInfo const& window_info);
157 
162  virtual void advise_focus_gained(WindowInfo const& window_info);
163 
169  virtual void advise_state_change(WindowInfo const& window_info, MirWindowState state);
170 
176  virtual void advise_move_to(WindowInfo const& window_info, Point top_left);
177 
183  virtual void advise_resize(WindowInfo const& window_info, Size const& new_size);
184 
189  virtual void advise_delete_window(WindowInfo const& window_info);
190 
198  virtual void advise_raise(std::vector<Window> const& windows);
212  std::shared_ptr<Workspace> const& workspace,
213  std::vector<Window> const& windows);
214 
223  std::shared_ptr<Workspace> const& workspace,
224  std::vector<Window> const& windows);
235  virtual void handle_request_drag_and_drop(WindowInfo& window_info) = 0;
236 
243  virtual void handle_request_move(WindowInfo& window_info, MirInputEvent const* input_event) = 0;
244 
252  virtual void handle_request_resize(WindowInfo& window_info, MirInputEvent const* input_event, MirResizeEdge edge) = 0;
257  virtual void advise_output_create(Output const& output);
258  virtual void advise_output_update(Output const& updated, Output const& original);
259  virtual void advise_output_delete(Output const& output);
260 
270  virtual auto confirm_inherited_move(WindowInfo const& window_info, Displacement movement) -> Rectangle = 0;
271 
272  virtual ~WindowManagementPolicy() = default;
276 
285  {
286  public:
288  virtual ~ApplicationZoneAddendum() = default;
297 
304  virtual void advise_application_zone_create(Zone const& application_zone);
305  virtual void advise_application_zone_update(Zone const& updated, Zone const& original);
306  virtual void advise_application_zone_delete(Zone const& application_zone);
308  };
310 };
311 
312 class WindowManagerTools;
313 }
314 
315 #endif //MIRAL_WINDOW_MANAGEMENT_POLICY_H
Definition: wayland_helpers.h:37
Definition: output.h:36
Handle additional requests related to application zones.
Definition: window_management_policy.h:285
ApplicationZoneAddendum(ApplicationZoneAddendum const &)=delete
static auto from(WindowManagementPolicy *policy) -> ApplicationZoneAddendum *
Attempts to dynamic_cast the given policy into an ApplicationZoneAddendum.
virtual void advise_application_zone_delete(Zone const &application_zone)
ApplicationZoneAddendum & operator=(ApplicationZoneAddendum const &)=delete
virtual void advise_application_zone_update(Zone const &updated, Zone const &original)
virtual void advise_application_zone_create(Zone const &application_zone)
The interface through which the window management policy is determined.
Definition: window_management_policy.h:47
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 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)
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_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:59
Definition: window_specification.h:44
A rectangular area of the display. Not tied to a specific output.
Definition: zone.h:36
MirResizeEdge
Hints for resizing a window.
Definition: common.h:413
struct MirPointerEvent MirPointerEvent
An event type describing a change in pointer device state.
Definition: pointer_event.h:35
MirWindowState
Definition: common.h:142
struct MirKeyboardEvent MirKeyboardEvent
An event type describing a change in keyboard state.
Definition: keyboard_event.h:41
struct MirInputEvent MirInputEvent
Definition: event.h:70
struct MirTouchEvent MirTouchEvent
An event type describing a change in touch device state.
Definition: touch_event.h:33
Basic geometry types. Types for dimensions, displacements, etc. and the operations that they support.
Definition: dimensions.h:31
Mir Abstraction Layer.
Definition: floating_window_manager.h:29
Definition: displacement.h:34
Definition: point.h:31
Definition: rectangle.h:34
Definition: size.h:32
Definition: application_info.h:32
Definition: window_info.h:33

Copyright © 2012-2021 Canonical Ltd.
Generated on Fri Jan 29 22:31:44 UTC 2021
This documentation is licensed under the GPL version 2 or 3.