LibreOffice
LibreOffice 6.4 SDK API Reference
Public Member Functions | List of all members
XUIElementFactoryRegistration Interface Reference

is used to query, register and deregister user interface element factories. More...

import"XUIElementFactoryRegistration.idl";

Inheritance diagram for XUIElementFactoryRegistration:
XInterface XUIElementFactoryManager theUIElementFactoryManager UIElementFactoryManager

Public Member Functions

sequence< sequence< com::sun::star::beans::PropertyValue > > getRegisteredFactories ()
 function to retrieve a list of all registered user interface element factories More...
 
::com::sun::star::ui::XUIElementFactory getFactory ([in] string ResourceURL, [in] string ModuleIdentifier)
 function to retrieve a previously registered user interface element factory. More...
 
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. More...
 
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. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

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:

Since
OOo 2.0

Member Function Documentation

◆ deregisterFactory()

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.

Parameters
aTypea string that identifies a type of a user interface element. Currently the following types are supported:
  • menubar
  • toolbar
  • statusbar
aNamean 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.
ModuleIdentifieran 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.

◆ getFactory()

::com::sun::star::ui::XUIElementFactory getFactory ( [in] string  ResourceURL,
[in] string  ModuleIdentifier 
)

function to retrieve a previously registered user interface element factory.

Returns
a reference to a registered user interface element factory if a factory has been found. An empty reference when no factory has been found. The defined search order of factories must be from special to generic ones.
Parameters
ResourceURLa 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.
ModuleIdentifieran 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.

◆ getRegisteredFactories()

sequence< sequence< com::sun::star::beans::PropertyValue > > getRegisteredFactories ( )

function to retrieve a list of all registered user interface element factories

Returns
a sequence of sequence of property values which describe every registered user interface element factory.

The following properties are defined:

  • Typea string property that identifies the type of the user interface element which this factory can create.
  • Namean optional string property which identifies a single user interface element within a type class which this factory can create. If this property is not returned, the factory is a generic factory for all user interface elements of the same type.
  • Modulean optional string property that specifies to which module this factory is bound to. If this property is not returned, the factory is a generic factory.

◆ registerFactory()

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.

Parameters
aTypea string that identifies a type of a user interface element. Currently the following types are supported:
  • menubar
  • toolbar
  • statusbar
aNamean 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.
aModuleIdentifieran 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.
aFactoryImplementationNamea UNO implementation name that can be used by an implementation to create a factory instance.

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