LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
ConfigurationController Service Reference

See XConfigurationController for a description of the configuration controller. More...

import"ConfigurationController.idl";

Inheritance diagram for ConfigurationController:
XConfigurationController XConfigurationControllerRequestQueue XConfigurationControllerBroadcaster XResourceFactoryManager

Public Member Functions

 create ([in]::com::sun::star::frame::XController xController)
 
- Public Member Functions inherited from XConfigurationController
void requestResourceActivation ([in] XResourceId xResourceId, [in] ResourceActivationMode eMode)
 Request the activation of a resource. More...
 
void requestResourceDeactivation ([in] XResourceId xResourceId)
 Request the deactivation of a resource. More...
 
XResource getResource ([in] XResourceId xResourceId)
 Return the active resource specified by the given resource id. More...
 
void lock ()
 Lock the processing of configuration change requests. More...
 
void unlock ()
 Unlock the processing of configuration change requests. More...
 
void update ()
 Explicitly request an update of the current configuration. More...
 
XConfiguration getRequestedConfiguration ()
 Return a copy of the requested configuration. More...
 
XConfiguration getCurrentConfiguration ()
 Return a copy of the current configuration. More...
 
void restoreConfiguration ([in] XConfiguration xConfiguration)
 Replace the requested configuration with the given configuration and schedule an update of the current configuration. More...
 
- Public Member Functions inherited from XConfigurationControllerRequestQueue
boolean hasPendingRequests ()
 Return whether there are pending requests for configuration changes. More...
 
void postChangeRequest ([in] XConfigurationChangeRequest xRequest)
 Add a request for a configuration change to the request queue. More...
 
- Public Member Functions inherited from XConfigurationControllerBroadcaster
void addConfigurationChangeListener ([in] XConfigurationChangeListener xListener, [in] string sEventType, [in] any aUserData)
 Add a new listener for configuration changes. More...
 
void removeConfigurationChangeListener ([in] XConfigurationChangeListener xListener)
 Remove a listener for configuration changes. More...
 
void notifyEvent ([in] ConfigurationChangeEvent aEvent)
 With this method other objects can send events to all the registered listeners. More...
 
- Public Member Functions inherited from XResourceFactoryManager
void addResourceFactory ([in] string sResourceURL, [in] XResourceFactory xResourceFactory)
 Register a new resource factory for the given URL. More...
 
void removeResourceFactoryForURL ([in] string sResourceURL)
 Remove a resource factory for one type of resource. More...
 
void removeResourceFactoryForReference ([in] XResourceFactory xResourceFactory)
 Remove a resource factory for all resource types it has been registered for. More...
 
XResourceFactory getResourceFactory ([in] string sResourceURL)
 Return the resource factory that was previously registered for the given resource type. More...
 

Additional Inherited Members

- Exported Interfaces inherited from XConfigurationController
interface XConfigurationControllerRequestQueue
 
interface XConfigurationControllerBroadcaster
 
interface XResourceFactoryManager
 

Detailed Description

See XConfigurationController for a description of the configuration controller.

This service is used at the moment by the XControllerManager to create a configuration controller. This allows developers to replace the default implementation of the configuration controller with their own. This may not be a useful feature. Furthermore the sub controllers may need a tighter coupling than the interfaces allow. These are reasons for removing this service in the future and let the controller manager create the sub controllers directly.

Member Function Documentation

create ( [in] ::com::sun::star::frame::XController  xController)

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