KioskWindowManagerPolicy Class Reference

#include <kiosk_window_manager.h>

Inheritance diagram for KioskWindowManagerPolicy:

Public Member Functions
	KioskWindowManagerPolicy (miral::WindowManagerTools const &tools, SwSplash const &)
auto	place_new_window (miral::ApplicationInfo const &app_info, miral::WindowSpecification const &request) -> miral::WindowSpecification override
	Customize initial window placement. More...
void	advise_focus_gained (miral::WindowInfo const &info) override
	Notification that a window has gained focus. More...
bool	handle_keyboard_event (MirKeyboardEvent const *event) override
	keyboard event handler More...
bool	handle_touch_event (MirTouchEvent const *event) override
	touch event handler More...
bool	handle_pointer_event (MirPointerEvent const *event) override
	pointer event handler More...
void	handle_modify_window (miral::WindowInfo &window_info, miral::WindowSpecification const &modifications) override
	request from client to modify the window specification. More...
Public Member Functions inherited from miral::CanonicalWindowManagerPolicy
	CanonicalWindowManagerPolicy (WindowManagerTools const &tools)
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
WindowManagementPolicy &	operator= (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...

Additional Inherited Members
Protected Attributes inherited from miral::CanonicalWindowManagerPolicy
WindowManagerTools	tools

Constructor & Destructor Documentation

KioskWindowManagerPolicy()

KioskWindowManagerPolicy::KioskWindowManagerPolicy	(	miral::WindowManagerTools const &	tools,
		SwSplash const &	splash
	)

Member Function Documentation

advise_focus_gained()

void KioskWindowManagerPolicy::advise_focus_gained ( miral::WindowInfo const &  window_info )

overridevirtual

Notification that a window has gained focus.

Parameters

window_info

the window

Reimplemented from miral::WindowManagementPolicy.

handle_keyboard_event()

bool KioskWindowManagerPolicy::handle_keyboard_event ( MirKeyboardEvent const *  event )

overridevirtual

keyboard event handler

Parameters

event

the event

Returns

whether the policy has consumed the event

Implements miral::WindowManagementPolicy.

handle_modify_window()

void KioskWindowManagerPolicy::handle_modify_window ( miral::WindowInfo &  window_info, miral::WindowSpecification const &  modifications  )

overridevirtual

request from client to modify the window specification.

Note

the request has already been validated against the type definition

Parameters

window_info	the window
modifications	the requested changes

Implements miral::WindowManagementPolicy.

handle_pointer_event()

bool KioskWindowManagerPolicy::handle_pointer_event ( MirPointerEvent const *  event )

overridevirtual

pointer event handler

Parameters

event

the event

Returns

whether the policy has consumed the event

Implements miral::WindowManagementPolicy.

handle_touch_event()

bool KioskWindowManagerPolicy::handle_touch_event ( MirTouchEvent const *  event )

overridevirtual

touch event handler

Parameters

event

the event

Returns

whether the policy has consumed the event

Implements miral::WindowManagementPolicy.

place_new_window()

auto KioskWindowManagerPolicy::place_new_window ( miral::ApplicationInfo const &  app_info, miral::WindowSpecification const &  requested_specification  ) -> miral::WindowSpecification

overridevirtual

Customize initial window placement.

Parameters

app_info	the application requesting a new window
requested_specification	the requested specification (updated with default placement)

Returns

the customized specification

Reimplemented from miral::CanonicalWindowManagerPolicy.

---

The documentation for this class was generated from the following files:

• examples/miral-kiosk/kiosk_window_manager.h
• examples/miral-kiosk/kiosk_window_manager.cpp