LibreOffice
LibreOffice 6.0 SDK API Reference
Exported Interfaces | List of all members
XUIControllerFactory Interface Reference

a factory to create User Interface controllers. More...

import"XUIControllerFactory.idl";

Inheritance diagram for XUIControllerFactory:
XMultiComponentFactory XUIControllerRegistration XInterface XInterface PopupMenuControllerFactory StatusbarControllerFactory thePopupMenuControllerFactory theStatusbarControllerFactory theToolbarControllerFactory ToolbarControllerFactory

Exported Interfaces

interface com::sun::star::lang::XMultiComponentFactory
 this interface provides functions to create new instances of a registered UI controller. More...
 
interface XUIControllerRegistration
 provides functions to query for, register and deregister a popup menu controller. More...
 

Additional Inherited Members

- Public Member Functions inherited from XMultiComponentFactory
com::sun::star::uno::XInterface createInstanceWithContext ([in] string aServiceSpecifier, [in] com::sun::star::uno::XComponentContext Context) raises (com::sun::star::uno::Exception)
 Creates an instance of a component which supports the services specified by the factory. More...
 
com::sun::star::uno::XInterface createInstanceWithArgumentsAndContext ([in] string ServiceSpecifier, [in] sequence< any > Arguments, [in] com::sun::star::uno::XComponentContext Context) raises (com::sun::star::uno::Exception)
 Creates an instance of a component which supports the services specified by the factory, and initializes the new instance with the given arguments and context. More...
 
sequence< string > getAvailableServiceNames ()
 Gets the names of all supported services. 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...
 
- Public Member Functions inherited from XUIControllerRegistration
boolean hasController ([in] string aCommandURL, [in] string aModelName)
 function to check if an user interface controller is registered for a command URL and optional module. More...
 
void registerController ([in] string aCommandURL, [in] string aModelName, [in] string aControllerImplementationName)
 function to create an association between a user interface controller implementation and a command URL and optional module. More...
 
void deregisterController ([in] string aCommandURL, [in] string aModelName)
 function to remove a previously defined association between a user interface controller implementation and a command URL and optional module. More...
 

Detailed Description

a factory to create User Interface controllers.

A user interface controller can be registered for a command URL. A certain user interface controller will be created when a user interface element contains a registered command URL.

See also
PopupMenuControllerFactory
StatusbarControllerFactory
ToolbarControllerFactory
Since
LibreOffice 4.1

Exported Interfaces

this interface provides functions to create new instances of a registered UI controller.

Use com::sun::star::lang::XMultiComponentFactory::createInstanceWithArgumentsAndContext() to create a new UI controller instance. Use the CommandURL as the service specifier.

This call supports the following arguments provided as com::sun::star::beans::PropertyValue:

  • Frame
    specifies the com::sun::star::frame::XFrame instance to which the UI controller belongs to. This property must be provided to the UI controller, otherwise it cannot dispatch its internal commands.
  • ModuleIdentifier
    optional string that specifies in which module context the UI controller should be created.
    The module identifier can be retrieved using the ModuleManager.

provides functions to query for, register and deregister a popup menu controller.


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