| LibreOffice
    LibreOffice 25.2 SDK API Reference | 
is used to query, register and deregister user interface element factories. More...
import "XUIElementFactoryRegistration.idl";
 
  
| Public Member Functions | |
| sequence< sequence< com::sun::star::beans::PropertyValue > > | getRegisteredFactories () | 
| function to retrieve a list of all registered user interface element factories | |
| ::com::sun::star::ui::XUIElementFactory | getFactory ([in] string ResourceURL, [in] string ModuleIdentifier) | 
| function to retrieve a previously registered user interface element factory. | |
| void | registerFactory ([in] string aType, [in] string aName, [in] string aModuleIdentifier, [in] string aFactoryImplementationName) raises (com::sun::star::container::ElementExistException) | 
| function to register a user interface element factory. | |
| void | deregisterFactory ([in] string aType, [in] string aName, [in] string ModuleIdentifier) raises (com::sun::star::container::NoSuchElementException) | 
| function to remove a previously defined user interface element factory. | |
| Public Member Functions inherited from XInterface | |
| any | queryInterface ([in] type aType) | 
| queries for a new interface to an existing UNO object. | |
| void | acquire () | 
| increases the reference counter by one. | |
| void | release () | 
| decreases the reference counter by one. | |
is used to query, register and deregister user interface element factories.
A user interface element factory is registered for a set of three properties.
A combination of these three property values can uniquely identify every user interface element within OpenOffice.
Currently the following user interface element types are defined:
| void deregisterFactory | ( | [in] string | aType, | |||
| [in] string | aName, | |||||
| [in] string | ModuleIdentifier ) | |||||
| raises | ( | com::sun::star::container::NoSuchElementException ) | ||||
function to remove a previously defined user interface element factory.
| aType | a string that identifies a type of a user interface element. Currently the following types are supported: 
 | 
| aName | an optional name of a single user interface element. This name must be unique within a user interface element type class. This value can remain empty if no special factory for a single user interface element should be deregistered. | 
| ModuleIdentifier | an optional module name that can be used to deregister a factory only for a single module. This value can remain empty if not a module based factory should be deregistered. The module identifier can be retrieved from the com::sun::star::frame::ModuleManager service. | 
Using this function can be very dangerous as other implementation with OpenOffice may not be able to create their user interface element anymore.
| ::com::sun::star::ui::XUIElementFactory getFactory | ( | [in] string | ResourceURL, | 
| [in] string | ModuleIdentifier ) | 
function to retrieve a previously registered user interface element factory.
| ResourceURL | a resource URL which identifies a user interface element. A resource URL uses the following syntax: "private:resource/$type/$name". It is only allowed to use ASCII characters for type and name. | 
| ModuleIdentifier | an optional module identifier. This value can remain empty, if a generic factory is requested. The module identifier can be retrieved from the com::sun::star::frame::ModuleManager service. | 
| sequence< sequence< com::sun::star::beans::PropertyValue > > getRegisteredFactories | ( | ) | 
function to retrieve a list of all registered user interface element factories
The following properties are defined:
| void registerFactory | ( | [in] string | aType, | |||
| [in] string | aName, | |||||
| [in] string | aModuleIdentifier, | |||||
| [in] string | aFactoryImplementationName ) | |||||
| raises | ( | com::sun::star::container::ElementExistException ) | ||||
function to register a user interface element factory.
| aType | a string that identifies a type of a user interface element. Currently the following types are supported: 
 | 
| aName | an optional name of a single user interface element. This name must be unique within a user interface element type class. This value can remain empty if no special factory for a single user interface element is needed. | 
| aModuleIdentifier | an optional module identifier that can be used to register a factory only for a single module. This value can remain empty if no special factory for a single module is needed. The module identifier can be retrieved from the com::sun::star::frame::ModuleManager service. | 
| aFactoryImplementationName | a UNO implementation name that can be used by an implementation to create a factory instance. |