Mir
Public Member Functions | Protected Member Functions | List of all members
mir::scene::PromptSessionManager Class Referenceabstract

#include <prompt_session_manager.h>

Public Member Functions

virtual ~PromptSessionManager ()=default
 
virtual std::shared_ptr< PromptSessionstart_prompt_session_for (std::shared_ptr< Session > const &session, PromptSessionCreationParameters const &params) const =0
 Start a new prompt session. More...
 
virtual void stop_prompt_session (std::shared_ptr< PromptSession > const &prompt_session) const =0
 Stop a started prompt session. More...
 
virtual void suspend_prompt_session (std::shared_ptr< PromptSession > const &prompt_session) const =0
 Suspend a prompt session. More...
 
virtual void resume_prompt_session (std::shared_ptr< PromptSession > const &prompt_session) const =0
 Resume a suspended prompt session. More...
 
virtual void add_prompt_provider (std::shared_ptr< PromptSession > const &prompt_session, std::shared_ptr< Session > const &prompt_provider) const =0
 Add a prompt provider to an existing prompt session. More...
 
virtual void remove_session (std::shared_ptr< Session > const &session) const =0
 Remove a session from all associated prompt sessions. More...
 
virtual std::shared_ptr< Sessionapplication_for (std::shared_ptr< PromptSession > const &prompt_session) const =0
 Retrieve the application session for a prompt session. More...
 
virtual std::shared_ptr< Sessionhelper_for (std::shared_ptr< PromptSession > const &prompt_session) const =0
 Retrieve the helper session for a prompt session. More...
 
virtual 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 =0
 Iterate over all the prompt providers associated with a prompt session. More...
 

Protected Member Functions

 PromptSessionManager ()=default
 
 PromptSessionManager (const PromptSessionManager &)=delete
 
PromptSessionManageroperator= (const PromptSessionManager &)=delete
 

Constructor & Destructor Documentation

virtual mir::scene::PromptSessionManager::~PromptSessionManager ( )
virtualdefault
mir::scene::PromptSessionManager::PromptSessionManager ( )
protecteddefault
mir::scene::PromptSessionManager::PromptSessionManager ( const PromptSessionManager )
protecteddelete

Member Function Documentation

virtual void mir::scene::PromptSessionManager::add_prompt_provider ( std::shared_ptr< PromptSession > const &  prompt_session,
std::shared_ptr< Session > const &  prompt_provider 
) const
pure virtual

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
virtual std::shared_ptr<Session> mir::scene::PromptSessionManager::application_for ( std::shared_ptr< PromptSession > const &  prompt_session) const
pure virtual

Retrieve the application session for a prompt session.

Parameters
[in]prompt_sessionThe prompt session
virtual void mir::scene::PromptSessionManager::for_each_provider_in ( std::shared_ptr< PromptSession > const &  prompt_session,
std::function< void(std::shared_ptr< Session > const &prompt_provider)> const &  f 
) const
pure virtual

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
virtual std::shared_ptr<Session> mir::scene::PromptSessionManager::helper_for ( std::shared_ptr< PromptSession > const &  prompt_session) const
pure virtual

Retrieve the helper session for a prompt session.

Parameters
[in]prompt_sessionThe prompt session
PromptSessionManager& mir::scene::PromptSessionManager::operator= ( const PromptSessionManager )
protecteddelete
virtual void mir::scene::PromptSessionManager::remove_session ( std::shared_ptr< Session > const &  session) const
pure virtual

Remove a session from all associated prompt sessions.

Parameters
[in]sessionThe new session that is to be removed
virtual void mir::scene::PromptSessionManager::resume_prompt_session ( std::shared_ptr< PromptSession > const &  prompt_session) const
pure virtual

Resume a suspended prompt session.

Parameters
[in]prompt_sessionThe prompt session
virtual std::shared_ptr<PromptSession> mir::scene::PromptSessionManager::start_prompt_session_for ( std::shared_ptr< Session > const &  session,
PromptSessionCreationParameters const &  params 
) const
pure virtual

Start a new prompt session.

Parameters
[in]sessionThe prompt helper session
[in]paramsThe creation parameters for constructing the prompt session
virtual void mir::scene::PromptSessionManager::stop_prompt_session ( std::shared_ptr< PromptSession > const &  prompt_session) const
pure virtual

Stop a started prompt session.

Parameters
[in]prompt_sessionThe prompt session
virtual void mir::scene::PromptSessionManager::suspend_prompt_session ( std::shared_ptr< PromptSession > const &  prompt_session) const
pure virtual

Suspend a prompt session.

Parameters
[in]prompt_sessionThe prompt session

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

Copyright © 2012-2016 Canonical Ltd.
Generated on Mon Jun 5 11:05:03 UTC 2017