LibreOffice Module sd (master) 1
Classes | Public Member Functions | Private Member Functions | Private Attributes | List of all members
sd::framework::ConfigurationController Class Referencefinal

The configuration controller is responsible for maintaining the current configuration. More...

#include <ConfigurationController.hxx>

Inheritance diagram for sd::framework::ConfigurationController:
[legend]
Collaboration diagram for sd::framework::ConfigurationController:
[legend]

Classes

class  Implementation
 
class  Lock
 Use this class instead of calling lock() and unlock() directly in order to be exception safe. More...
 

Public Member Functions

 ConfigurationController (const rtl::Reference<::sd::DrawController > &rxController)
 
virtual ~ConfigurationController () noexcept override
 
 ConfigurationController (const ConfigurationController &)=delete
 
ConfigurationControlleroperator= (const ConfigurationController &)=delete
 
virtual void SAL_CALL disposing () override
 
void ProcessEvent ()
 
void RequestSynchronousUpdate ()
 Normally the requested changes of the configuration are executed asynchronously. More...
 
virtual void SAL_CALL lock () override
 
virtual void SAL_CALL unlock () override
 
virtual void SAL_CALL requestResourceActivation (const css::uno::Reference< css::drawing::framework::XResourceId > &rxResourceId, css::drawing::framework::ResourceActivationMode eMode) override
 
virtual void SAL_CALL requestResourceDeactivation (const css::uno::Reference< css::drawing::framework::XResourceId > &rxResourceId) override
 
virtual css::uno::Reference< css::drawing::framework::XResource > SAL_CALL getResource (const css::uno::Reference< css::drawing::framework::XResourceId > &rxResourceId) override
 
virtual void SAL_CALL update () override
 
virtual css::uno::Reference< css::drawing::framework::XConfiguration > SAL_CALL getRequestedConfiguration () override
 
virtual css::uno::Reference< css::drawing::framework::XConfiguration > SAL_CALL getCurrentConfiguration () override
 
virtual void SAL_CALL restoreConfiguration (const css::uno::Reference< css::drawing::framework::XConfiguration > &rxConfiguration) override
 The given configuration is restored by generating the appropriate set of activation and deactivation requests. More...
 
virtual void SAL_CALL addConfigurationChangeListener (const css::uno::Reference< css::drawing::framework::XConfigurationChangeListener > &rxListener, const OUString &rsEventType, const css::uno::Any &rUserData) override
 
virtual void SAL_CALL removeConfigurationChangeListener (const css::uno::Reference< css::drawing::framework::XConfigurationChangeListener > &rxListener) override
 
virtual void SAL_CALL notifyEvent (const css::drawing::framework::ConfigurationChangeEvent &rEvent) override
 
virtual sal_Bool SAL_CALL hasPendingRequests () override
 
virtual void SAL_CALL postChangeRequest (const css::uno::Reference< css::drawing::framework::XConfigurationChangeRequest > &rxRequest) override
 
virtual void SAL_CALL addResourceFactory (const OUString &sResourceURL, const css::uno::Reference< css::drawing::framework::XResourceFactory > &rxResourceFactory) override
 
virtual void SAL_CALL removeResourceFactoryForURL (const OUString &sResourceURL) override
 
virtual void SAL_CALL removeResourceFactoryForReference (const css::uno::Reference< css::drawing::framework::XResourceFactory > &rxResourceFactory) override
 
virtual css::uno::Reference< css::drawing::framework::XResourceFactory > SAL_CALL getResourceFactory (const OUString &sResourceURL) override
 

Private Member Functions

void ThrowIfDisposed () const
 When the called object has already been disposed this method throws an exception and does not return. More...
 

Private Attributes

std::unique_ptr< ImplementationmpImplementation
 
bool mbIsDisposed
 
- Private Attributes inherited from cppu::BaseMutex
mutable::osl::Mutex m_aMutex
 

Detailed Description

The configuration controller is responsible for maintaining the current configuration.

See also
css::drawing::framework::XConfigurationController for an extended documentation.

Definition at line 51 of file ConfigurationController.hxx.

Constructor & Destructor Documentation

◆ ConfigurationController() [1/2]

sd::framework::ConfigurationController::ConfigurationController ( const rtl::Reference<::sd::DrawController > &  rxController)

Definition at line 105 of file ConfigurationController.cxx.

References mpImplementation.

◆ ~ConfigurationController()

sd::framework::ConfigurationController::~ConfigurationController ( )
overridevirtualnoexcept

Definition at line 116 of file ConfigurationController.cxx.

◆ ConfigurationController() [2/2]

sd::framework::ConfigurationController::ConfigurationController ( const ConfigurationController )
delete

Member Function Documentation

◆ addConfigurationChangeListener()

void SAL_CALL sd::framework::ConfigurationController::addConfigurationChangeListener ( const css::uno::Reference< css::drawing::framework::XConfigurationChangeListener > &  rxListener,
const OUString &  rsEventType,
const css::uno::Any &  rUserData 
)
overridevirtual

◆ addResourceFactory()

void SAL_CALL sd::framework::ConfigurationController::addResourceFactory ( const OUString &  sResourceURL,
const css::uno::Reference< css::drawing::framework::XResourceFactory > &  rxResourceFactory 
)
overridevirtual

◆ disposing()

void SAL_CALL sd::framework::ConfigurationController::disposing ( )
overridevirtual

◆ getCurrentConfiguration()

Reference< XConfiguration > SAL_CALL sd::framework::ConfigurationController::getCurrentConfiguration ( )
overridevirtual

◆ getRequestedConfiguration()

Reference< XConfiguration > SAL_CALL sd::framework::ConfigurationController::getRequestedConfiguration ( )
overridevirtual

◆ getResource()

Reference< XResource > SAL_CALL sd::framework::ConfigurationController::getResource ( const css::uno::Reference< css::drawing::framework::XResourceId > &  rxResourceId)
overridevirtual

◆ getResourceFactory()

Reference< XResourceFactory > SAL_CALL sd::framework::ConfigurationController::getResourceFactory ( const OUString &  sResourceURL)
overridevirtual

◆ hasPendingRequests()

sal_Bool SAL_CALL sd::framework::ConfigurationController::hasPendingRequests ( )
overridevirtual

◆ lock()

void SAL_CALL sd::framework::ConfigurationController::lock ( )
overridevirtual

◆ notifyEvent()

void SAL_CALL sd::framework::ConfigurationController::notifyEvent ( const css::drawing::framework::ConfigurationChangeEvent &  rEvent)
overridevirtual

Definition at line 194 of file ConfigurationController.cxx.

References mpImplementation, and ThrowIfDisposed().

◆ operator=()

ConfigurationController & sd::framework::ConfigurationController::operator= ( const ConfigurationController )
delete

◆ postChangeRequest()

void SAL_CALL sd::framework::ConfigurationController::postChangeRequest ( const css::uno::Reference< css::drawing::framework::XConfigurationChangeRequest > &  rxRequest)
overridevirtual

◆ ProcessEvent()

void sd::framework::ConfigurationController::ProcessEvent ( )

Definition at line 152 of file ConfigurationController.cxx.

References mpImplementation.

Referenced by sd::ViewShellBase::LateInit().

◆ removeConfigurationChangeListener()

void SAL_CALL sd::framework::ConfigurationController::removeConfigurationChangeListener ( const css::uno::Reference< css::drawing::framework::XConfigurationChangeListener > &  rxListener)
overridevirtual

◆ removeResourceFactoryForReference()

void SAL_CALL sd::framework::ConfigurationController::removeResourceFactoryForReference ( const css::uno::Reference< css::drawing::framework::XResourceFactory > &  rxResourceFactory)
overridevirtual

◆ removeResourceFactoryForURL()

void SAL_CALL sd::framework::ConfigurationController::removeResourceFactoryForURL ( const OUString &  sResourceURL)
overridevirtual

◆ requestResourceActivation()

void SAL_CALL sd::framework::ConfigurationController::requestResourceActivation ( const css::uno::Reference< css::drawing::framework::XResourceId > &  rxResourceId,
css::drawing::framework::ResourceActivationMode  eMode 
)
overridevirtual

◆ requestResourceDeactivation()

void SAL_CALL sd::framework::ConfigurationController::requestResourceDeactivation ( const css::uno::Reference< css::drawing::framework::XResourceId > &  rxResourceId)
overridevirtual

◆ RequestSynchronousUpdate()

void sd::framework::ConfigurationController::RequestSynchronousUpdate ( )

Normally the requested changes of the configuration are executed asynchronously.

However, there is at least one situation (searching with the Outliner) where the surrounding code does not cope with this. So, instead of calling Reschedule until the global event loop executes the configuration update, this method does (almost) the same without the reschedules.

Do not use this method until there is absolutely no other way.

Definition at line 162 of file ConfigurationController.cxx.

References mpImplementation.

◆ restoreConfiguration()

void SAL_CALL sd::framework::ConfigurationController::restoreConfiguration ( const css::uno::Reference< css::drawing::framework::XConfiguration > &  rxConfiguration)
overridevirtual

◆ ThrowIfDisposed()

void sd::framework::ConfigurationController::ThrowIfDisposed ( ) const
private

◆ unlock()

void SAL_CALL sd::framework::ConfigurationController::unlock ( )
overridevirtual

◆ update()

void SAL_CALL sd::framework::ConfigurationController::update ( )
overridevirtual

Member Data Documentation

◆ mbIsDisposed

bool sd::framework::ConfigurationController::mbIsDisposed
private

Definition at line 164 of file ConfigurationController.hxx.

Referenced by disposing(), and ThrowIfDisposed().

◆ mpImplementation

std::unique_ptr<Implementation> sd::framework::ConfigurationController::mpImplementation
private

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