Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: frame ::

interface XUIControllerRegistration
Description
is used to query, register and unregister user interface controller.

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.

Since
OOo 2.0
See also
PopupMenuControllerFactory


Methods' Summary
hasController function to check if an user interface controller is registered for a command URL and optional module.  
registerController function to create an association between a user interface controller implementation and a command URL and optional module.  
deregisterController function to remove a previously defined association between a user interface controller implementation and a command URL and optional module.  
Methods' Details
hasController
boolean
hasController( [in] string  aCommandURL,
[in] string  aModelName );

Description
function to check if an user interface controller is registered for a command URL and optional module.
Returns
true if a controller was registered for the combination of command URL and model name.
Parameter aCommandURL
a command URL which specifies an action.
Parameter aModelName
an optional name of an OpenOffice model service. This value can remain empty if no model service name was specified.
registerController
void
registerController( [in] string  aCommandURL,
[in] string  aModelName,
[in] string  aControllerImplementationName );

Description
function to create an association between a user interface controller implementation and a command URL and optional module.
Parameter aCommandURL
a command URL which specifies an action which shoudl be associated with a user interface controller.
Parameter aModelName
an optional name of an OpenOffice model service. This value can remain empty if no model service name was specified.
Parameter aControllerImplementationName
a UNO implementation name that can be used to create a user interface controller with the OpenOffice service manager.
deregisterController
void
deregisterController( [in] string  aCommandURL,
[in] string  aModelName );

Description
function to remove a previously defined association between a user interface controller implementation and a command URL and optional module.
Parameter aCommandURL
a command URL which specifies an action which shoudl be associated with a user interface controller.
Parameter aModelName
an optional name of an OpenOffice model service. This value can remain empty if no model service name was specified.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.