LibreOffice
LibreOffice 5.0 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
UniversalContentBroker Service Referencepublished

is a one-instance service that provides access to a set of Contents via ContentProviders. More...

import "UniversalContentBroker.idl";

Inheritance diagram for UniversalContentBroker:
XUniversalContentBroker XComponent XContentProvider XContentProviderManager XContentIdentifierFactory XCommandProcessor2 XInterface XInterface XInterface XInterface XCommandProcessor XInterface

Public Member Functions

 create ()
 The (default) constructor. More...
 

Additional Inherited Members

- Exported Interfaces inherited from XUniversalContentBroker
interface com::sun::star::lang::XComponent
 must be implemented to make it possible to resolve cyclic object references. More...
 
interface com::sun::star::ucb::XContentProvider
 provides access to all kind of contents provided by the registered content providers. More...
 
interface com::sun::star::ucb::XContentProviderManager
 provides access to a set of content providers registered with the UCB. More...
 
interface com::sun::star::ucb::XContentIdentifierFactory
 creates XContentIdentifier implementation objects for all kind of contents provided by the UCB. More...
 
interface com::sun::star::ucb::XCommandProcessor2
 Enables the caller to execute commands at the broker. More...
 

Detailed Description

is a one-instance service that provides access to a set of Contents via ContentProviders.

Traditionally, this service implements com::sun::star::lang::XInitialization and needed to be instantiated once with two arguments via com::sun::star::lang::XMultiComponentFactory::createInstanceWithArgumentsAndContext() for configuration before it could be obtained via plain com::sun::star::lang::XMultiComponentFactory::createInstanceWithContext().

However, the only pair of initialization arguments used in practice is "Local"/"Office", so this service is simplified now to automatically configure itself with that argument pair upon first instantiation.

(For backwards compatibility, the service implementation still supports com::sun::star::lang::XInitialization and can still explicitly be initialized via com::sun::star::lang::XMultiComponentFactory::createInstanceWithArgumentsAndContext() with two arguments of type string. These strings are used as a pair of keys to retrieve a set of content provider descriptions from the configuration management (stored at org.openoffice.ucb.Configuration.ContentProviders.key1.SecondaryKeys.key2.ProviderData within the configuration management's hierarchy). The retrieved descriptions are in turn used to register the corresponding content provider services at the broker.)

Developers Guide
UCB - Universal Content Broker - Capabilities
UCB - Instantiating the UCB

Member Function Documentation

create ( )

The (default) constructor.

(This default constructor is only mentioned explicitly for technical reasons, so that its implementation calls the service implementation's com::sun::star::lang::XInitialization::initialize().)


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