Mir
Public Member Functions | List of all members
mir_test_framework::CanonicalWindowManagerPolicy Struct Reference

#include <canonical_window_manager_policy.h>

Inheritance diagram for mir_test_framework::CanonicalWindowManagerPolicy:
[legend]

Public Member Functions

bool handle_keyboard_event (MirKeyboardEvent const *) override
 keyboard event handler More...
 
bool handle_pointer_event (MirPointerEvent const *) override
 pointer event handler More...
 
bool handle_touch_event (MirTouchEvent const *) override
 touch event handler More...
 
mir::geometry::Rectangle confirm_placement_on_display (miral::WindowInfo const &, MirWindowState, mir::geometry::Rectangle const &new_placement)
 Confirm (and optionally adjust) the placement of a window on the display. More...
 
- Public Member Functions inherited from miral::CanonicalWindowManagerPolicy
 CanonicalWindowManagerPolicy (WindowManagerTools const &tools)
 
virtual auto place_new_window (ApplicationInfo const &app_info, WindowSpecification const &request_parameters) -> WindowSpecification override
 Customize initial window placement. More...
 
void handle_window_ready (WindowInfo &window_info) override
 Tries to focus on the newly ready window. More...
 
void handle_modify_window (WindowInfo &window_info, WindowSpecification const &modifications) override
 Applies the requested modifications. More...
 
void handle_raise_window (WindowInfo &window_info) override
 Tries to focus on the newly ready window. More...
 
void advise_focus_gained (WindowInfo const &info) override
 Raises the window (and any children) More...
 
auto confirm_inherited_move (WindowInfo const &window_info, Displacement movement) -> Rectangle override
 Move the child window with the parent. More...
 
- Public Member Functions inherited from miral::WindowManagementPolicy
virtual void advise_begin ()
 before any related calls begin More...
 
virtual void advise_end ()
 after any related calls end More...
 
virtual ~WindowManagementPolicy ()=default
 
 WindowManagementPolicy ()=default
 
 WindowManagementPolicy (WindowManagementPolicy const &)=delete
 
WindowManagementPolicyoperator= (WindowManagementPolicy const &)=delete
 
virtual void advise_new_app (ApplicationInfo &application)
 Notification that a new application has connected. More...
 
virtual void advise_delete_app (ApplicationInfo const &application)
 Notification that an application has disconnected. More...
 
virtual void advise_new_window (WindowInfo const &window_info)
 Notification that a window has been created. More...
 
virtual void advise_focus_lost (WindowInfo const &window_info)
 Notification that a window has lost focus. More...
 
virtual void advise_state_change (WindowInfo const &window_info, MirWindowState state)
 Notification that a window is about to change state. More...
 
virtual void advise_move_to (WindowInfo const &window_info, Point top_left)
 Notification that a window is about to move. More...
 
virtual void advise_resize (WindowInfo const &window_info, Size const &new_size)
 Notification that a window is about to resize. More...
 
virtual void advise_delete_window (WindowInfo const &window_info)
 Notification that a window is about to be destroyed. More...
 
virtual void advise_raise (std::vector< Window > const &windows)
 Notification that windows are being raised to the top. More...
 
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. More...
 
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. More...
 
virtual void handle_request_drag_and_drop (WindowInfo &window_info)=0
 request from client to initiate drag and drop More...
 
virtual void handle_request_move (WindowInfo &window_info, MirInputEvent const *input_event)=0
 request from client to initiate move More...
 
virtual void handle_request_resize (WindowInfo &window_info, MirInputEvent const *input_event, MirResizeEdge edge)=0
 request from client to initiate resize More...
 
virtual void advise_output_create (Output const &output)
 
virtual void advise_output_update (Output const &updated, Output const &original)
 
virtual void advise_output_delete (Output const &output)
 

Additional Inherited Members

- Protected Attributes inherited from miral::CanonicalWindowManagerPolicy
WindowManagerTools tools
 

Member Function Documentation

◆ confirm_placement_on_display()

mir::geometry::Rectangle mir_test_framework::CanonicalWindowManagerPolicy::confirm_placement_on_display ( miral::WindowInfo const &  window_info,
MirWindowState  new_state,
mir::geometry::Rectangle const &  new_placement 
)
inlinevirtual

Confirm (and optionally adjust) the placement of a window on the display.

Called when (re)placing fullscreen, maximized, horizontally maximised and vertically maximized windows to allow adjustment for decorations.

Parameters
window_infothe window
new_statethe new state
new_placementthe suggested placement
Returns
the confirmed placement of the window

Implements miral::WindowManagementPolicy.

◆ handle_keyboard_event()

bool mir_test_framework::CanonicalWindowManagerPolicy::handle_keyboard_event ( MirKeyboardEvent const *  event)
inlineoverridevirtual

keyboard event handler

Parameters
eventthe event
Returns
whether the policy has consumed the event

Implements miral::WindowManagementPolicy.

◆ handle_pointer_event()

bool mir_test_framework::CanonicalWindowManagerPolicy::handle_pointer_event ( MirPointerEvent const *  event)
inlineoverridevirtual

pointer event handler

Parameters
eventthe event
Returns
whether the policy has consumed the event

Implements miral::WindowManagementPolicy.

◆ handle_touch_event()

bool mir_test_framework::CanonicalWindowManagerPolicy::handle_touch_event ( MirTouchEvent const *  event)
inlineoverridevirtual

touch event handler

Parameters
eventthe event
Returns
whether the policy has consumed the event

Implements miral::WindowManagementPolicy.


The documentation for this struct was generated from the following file:

Copyright © 2012-2018 Canonical Ltd.
Generated on Thu Mar 15 13:06:27 UTC 2018