Mir
Public Member Functions | List of all members
mir::shell::DefaultShell Class Reference

Default shell implementation. More...

#include <default_shell.h>

Inheritance diagram for mir::shell::DefaultShell:
[legend]

Public Member Functions

 DefaultShell (std::shared_ptr< InputTargeter > const &input_targeter, std::shared_ptr< scene::SurfaceCoordinator > const &surface_coordinator, std::shared_ptr< scene::SessionCoordinator > const &session_coordinator, std::shared_ptr< scene::PromptSessionManager > const &prompt_session_manager, std::shared_ptr< scene::PlacementStrategy > const &placement_strategy, std::shared_ptr< scene::SurfaceConfigurator > const &surface_configurator)
 
these come from frontend::Shell
std::shared_ptr< scene::Sessionopen_session (pid_t client_pid, std::string const &name, std::shared_ptr< frontend::EventSink > const &sink) override
 
void close_session (std::shared_ptr< scene::Session > const &session) override
 
void handle_surface_created (std::shared_ptr< scene::Session > const &session) override
 
frontend::SurfaceId create_surface (std::shared_ptr< scene::Session > const &session, scene::SurfaceCreationParameters const &params) override
 
int set_surface_attribute (std::shared_ptr< scene::Session > const &session, std::shared_ptr< scene::Surface > const &surface, MirSurfaceAttrib attrib, int value) override
 
- Public Member Functions inherited from mir::shell::AbstractShell
 AbstractShell (std::shared_ptr< InputTargeter > const &input_targeter, std::shared_ptr< scene::SurfaceCoordinator > const &surface_coordinator, std::shared_ptr< scene::SessionCoordinator > const &session_coordinator, std::shared_ptr< scene::PromptSessionManager > const &prompt_session_manager)
 
 ~AbstractShell () noexcept
 
std::shared_ptr< scene::Sessionopen_session (pid_t client_pid, std::string const &name, std::shared_ptr< frontend::EventSink > const &sink) override
 
void close_session (std::shared_ptr< scene::Session > const &session) override
 
frontend::SurfaceId create_surface (std::shared_ptr< scene::Session > const &session, scene::SurfaceCreationParameters const &params) override
 
void destroy_surface (std::shared_ptr< scene::Session > const &session, frontend::SurfaceId surface) override
 
void handle_surface_created (std::shared_ptr< scene::Session > const &session) override
 
int set_surface_attribute (std::shared_ptr< scene::Session > const &session, std::shared_ptr< scene::Surface > const &surface, MirSurfaceAttrib attrib, int value) override
 
int get_surface_attribute (std::shared_ptr< scene::Surface > const &surface, MirSurfaceAttrib attrib) override
 
std::shared_ptr< scene::PromptSessionstart_prompt_session_for (std::shared_ptr< scene::Session > const &session, scene::PromptSessionCreationParameters const &params) override
 
void add_prompt_provider_for (std::shared_ptr< scene::PromptSession > const &prompt_session, std::shared_ptr< scene::Session > const &session) override
 
void stop_prompt_session (std::shared_ptr< scene::PromptSession > const &prompt_session) override
 
void focus_next () override
 
std::weak_ptr< scene::Sessionfocussed_application () const override
 
void set_focus_to (std::shared_ptr< scene::Session > const &focus) override
 
these functions support frontend requests
- Public Member Functions inherited from mir::shell::FocusController
virtual ~FocusController ()=default
 

Additional Inherited Members

- Protected Member Functions inherited from mir::shell::FocusController
 FocusController ()=default
 
 FocusController (FocusController const &)=delete
 
FocusControlleroperator= (FocusController const &)=delete
 
- Protected Attributes inherited from mir::shell::AbstractShell
std::shared_ptr< InputTargeter > const input_targeter
 
std::shared_ptr< scene::SurfaceCoordinator > const surface_coordinator
 
std::shared_ptr< scene::SessionCoordinator > const session_coordinator
 
std::shared_ptr< scene::PromptSessionManager > const prompt_session_manager
 

Detailed Description

Default shell implementation.

To customise derive from this class and override the methods you want to change

Constructor & Destructor Documentation

mir::shell::DefaultShell::DefaultShell ( std::shared_ptr< InputTargeter > const &  input_targeter,
std::shared_ptr< scene::SurfaceCoordinator > const &  surface_coordinator,
std::shared_ptr< scene::SessionCoordinator > const &  session_coordinator,
std::shared_ptr< scene::PromptSessionManager > const &  prompt_session_manager,
std::shared_ptr< scene::PlacementStrategy > const &  placement_strategy,
std::shared_ptr< scene::SurfaceConfigurator > const &  surface_configurator 
)

Member Function Documentation

void mir::shell::DefaultShell::close_session ( std::shared_ptr< scene::Session > const &  session)
overridevirtual

Implements mir::shell::Shell.

mf::SurfaceId mir::shell::DefaultShell::create_surface ( std::shared_ptr< scene::Session > const &  session,
scene::SurfaceCreationParameters const &  params 
)
overridevirtual

Implements mir::shell::Shell.

void mir::shell::DefaultShell::handle_surface_created ( std::shared_ptr< scene::Session > const &  session)
overridevirtual

Implements mir::shell::Shell.

std::shared_ptr< ms::Session > mir::shell::DefaultShell::open_session ( pid_t  client_pid,
std::string const &  name,
std::shared_ptr< frontend::EventSink > const &  sink 
)
overridevirtual

Implements mir::shell::Shell.

int mir::shell::DefaultShell::set_surface_attribute ( std::shared_ptr< scene::Session > const &  session,
std::shared_ptr< scene::Surface > const &  surface,
MirSurfaceAttrib  attrib,
int  value 
)
overridevirtual

Implements mir::shell::Shell.


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

Copyright © 2012,2013 Canonical Ltd.
Generated on Tue Mar 24 16:15:19 UTC 2015