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 :: ui ::

unpublished service ModuleUICommandDescription
Usage Restrictions
not published
Description
a service which provides information about the user interface commands of a single module.

Every OpenOffice.org module has an amount of commands that can be used by user interface elements. This service provides access to the user interface commands that are part of a single OpenOffice.org module, like Writer or Calc.

Since
OOo 2.0

Exported Interfaces - Summary
::com::sun::star::container::XNameAccess

provides access to user interface commands of an installed module. (details)

Exported Interfaces - Details
::com::sun::star::container::XNameAccess
Description
provides access to user interface commands of an installed module.

An implementation must provide a com::sun::star::uno::Sequence which has ::com::sun::star::beans::PropertyValue as entries. The following entries a defined:

  • Label
    a string which specifies the short name of the user interface command with mnemonic and optional subsequent ... if the command needs additional user input. This string can directly be used to set the text of a menu item.
  • Name
    a string which specifies the short name of the user interface command without any additional information. It can be used for the bubble help.
  • Popup
    a boolean which specifies if the user interface command is a unique identifer for a popup menu. A popup menu has a label, but is not bound to a command.
The key to a user interface command description is the user interface command itself which has the following syntax ".uno:$Command". For example ".uno:Open" shows the file open dialog. A complete list of user interface commands can be found inside the latest OpenOffice Developers Guide or online at http://framework.openoffice.org.

See also
::com::sun::star::frame::ModuleManager

 
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.