Mir
Public Member Functions | List of all members
mir::scene::PromptSessionManagerImpl Class Reference

#include <prompt_session_manager_impl.h>

Inheritance diagram for mir::scene::PromptSessionManagerImpl:
[legend]

Public Member Functions

 PromptSessionManagerImpl (std::shared_ptr< SessionContainer > const &app_container, std::shared_ptr< PromptSessionListener > const &prompt_session_listener)
 
std::shared_ptr< PromptSessionstart_prompt_session_for (std::shared_ptr< Session > const &session, PromptSessionCreationParameters const &params) const override
 Start a new prompt session. More...
 
void stop_prompt_session (std::shared_ptr< PromptSession > const &prompt_session) const override
 Stop a started prompt session. More...
 
void suspend_prompt_session (std::shared_ptr< PromptSession > const &prompt_session) const override
 Suspend a prompt session. More...
 
void resume_prompt_session (std::shared_ptr< PromptSession > const &prompt_session) const override
 Resume a suspended prompt session. More...
 
void add_prompt_provider (std::shared_ptr< PromptSession > const &prompt_session, std::shared_ptr< Session > const &prompt_provider) const override
 Add a prompt provider to an existing prompt session. More...
 
void remove_session (std::shared_ptr< Session > const &session) const override
 Remove a session from all associated prompt sessions. More...
 
std::shared_ptr< Sessionapplication_for (std::shared_ptr< PromptSession > const &prompt_session) const override
 Retrieve the application session for a prompt session. More...
 
std::shared_ptr< Sessionhelper_for (std::shared_ptr< PromptSession > const &prompt_session) const override
 Retrieve the helper session for a prompt session. More...
 
void for_each_provider_in (std::shared_ptr< PromptSession > const &prompt_session, std::function< void(std::shared_ptr< Session > const &prompt_provider)> const &f) const override
 Iterate over all the prompt providers associated with a prompt session. More...
 
- Public Member Functions inherited from mir::scene::PromptSessionManager
virtual ~PromptSessionManager ()=default
 

Additional Inherited Members

- Protected Member Functions inherited from mir::scene::PromptSessionManager
 PromptSessionManager ()=default
 
 PromptSessionManager (const PromptSessionManager &)=delete
 
PromptSessionManageroperator= (const PromptSessionManager &)=delete
 

Constructor & Destructor Documentation

mir::scene::PromptSessionManagerImpl::PromptSessionManagerImpl ( std::shared_ptr< SessionContainer > const &  app_container,
std::shared_ptr< PromptSessionListener > const &  prompt_session_listener 
)
explicit

Member Function Documentation

void mir::scene::PromptSessionManagerImpl::add_prompt_provider ( std::shared_ptr< PromptSession > const &  prompt_session,
std::shared_ptr< Session > const &  prompt_provider 
) const
overridevirtual

Add a prompt provider to an existing prompt session.

Parameters
[in]prompt_sessionThe prompt session
[in]prompt_providerThe prompt provider to add to the prompt session

Implements mir::scene::PromptSessionManager.

std::shared_ptr< ms::Session > mir::scene::PromptSessionManagerImpl::application_for ( std::shared_ptr< PromptSession > const &  prompt_session) const
overridevirtual

Retrieve the application session for a prompt session.

Parameters
[in]prompt_sessionThe prompt session

Implements mir::scene::PromptSessionManager.

void mir::scene::PromptSessionManagerImpl::for_each_provider_in ( std::shared_ptr< PromptSession > const &  prompt_session,
std::function< void(std::shared_ptr< Session > const &prompt_provider)> const &  f 
) const
overridevirtual

Iterate over all the prompt providers associated with a prompt session.

Parameters
[in]prompt_sessionThe prompt session
[in]fThe callback function to call for each provider

Implements mir::scene::PromptSessionManager.

std::shared_ptr< ms::Session > mir::scene::PromptSessionManagerImpl::helper_for ( std::shared_ptr< PromptSession > const &  prompt_session) const
overridevirtual

Retrieve the helper session for a prompt session.

Parameters
[in]prompt_sessionThe prompt session

Implements mir::scene::PromptSessionManager.

void mir::scene::PromptSessionManagerImpl::remove_session ( std::shared_ptr< Session > const &  session) const
overridevirtual

Remove a session from all associated prompt sessions.

Parameters
[in]sessionThe new session that is to be removed

Implements mir::scene::PromptSessionManager.

void mir::scene::PromptSessionManagerImpl::resume_prompt_session ( std::shared_ptr< PromptSession > const &  prompt_session) const
overridevirtual

Resume a suspended prompt session.

Parameters
[in]prompt_sessionThe prompt session

Implements mir::scene::PromptSessionManager.

std::shared_ptr< ms::PromptSession > mir::scene::PromptSessionManagerImpl::start_prompt_session_for ( std::shared_ptr< Session > const &  session,
PromptSessionCreationParameters const &  params 
) const
overridevirtual

Start a new prompt session.

Parameters
[in]sessionThe prompt helper session
[in]paramsThe creation parameters for constructing the prompt session

Implements mir::scene::PromptSessionManager.

void mir::scene::PromptSessionManagerImpl::stop_prompt_session ( std::shared_ptr< PromptSession > const &  prompt_session) const
overridevirtual

Stop a started prompt session.

Parameters
[in]prompt_sessionThe prompt session

Implements mir::scene::PromptSessionManager.

void mir::scene::PromptSessionManagerImpl::suspend_prompt_session ( std::shared_ptr< PromptSession > const &  prompt_session) const
overridevirtual

Suspend a prompt session.

Parameters
[in]prompt_sessionThe prompt session

Implements mir::scene::PromptSessionManager.


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

Copyright © 2012-2015 Canonical Ltd.
Generated on Thu Sep 8 14:50:19 UTC 2016