LibreOffice
LibreOffice 24.2 SDK API Reference
|
specifies a user interface element factory that can create and initialize user interface elements. More...
import"XUIElementFactory.idl";
Public Member Functions | |
::com::sun::star::ui::XUIElement | createUIElement ([in] string ResourceURL, [in] sequence< com::sun::star::beans::PropertyValue > Args) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::IllegalArgumentException ) |
creates a new instances of a specific user interface element. 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... | |
specifies a user interface element factory that can create and initialize user interface elements.
User interface element factories must be registered at a UIElementFactoryManager service to provide access to itself.
Currently the following user interface element types are defined:
::com::sun::star::ui::XUIElement createUIElement | ( | [in] string | ResourceURL, |
[in] sequence< com::sun::star::beans::PropertyValue > | Args | ||
) | |||
raises | ( | com::sun::star::container::NoSuchElementException, | |
com::sun::star::lang::IllegalArgumentException | |||
) |
creates a new instances of a specific user interface element.
ResourceURL | specifies which unique user interface element should be created by the factory. A resource URL must meet the following syntax: "private:resource/$type/$name. It is only allowed to use ASCII characters for type and name. This argument must not be empty to have a working user interface element instance.The implementation can throw an com::sun::star::container::NoSuchElementException if it doesn't know how to create the request user interface element. |
Args | The following arguments are supported:
|
An implementation is responsible to initialize every newly created user interface element if the necessary properties are provided. Especially it must connect a configurable user interface element to the correct user interface configuration manager. Without this connection the configurable user interface element cannot retrieve its structure data and changes to the user interface element structure won't be persistent. It is up to the implementation to throw an com::sun::star::lang::IllegalArgumentException if it cannot create a user interface element with the provided arguments.