LibreOffice
LibreOffice 6.4 SDK API Reference
Exported Interfaces | List of all members
ModuleUICommandDescription Service Reference

a service which provides information about the user interface commands of a single module. More...

import"ModuleUICommandDescription.idl";

Inheritance diagram for ModuleUICommandDescription:
XNameAccess XElementAccess XInterface

Exported Interfaces

interface com::sun::star::container::XNameAccess
 provides access to user interface commands of an installed module. More...
 

Additional Inherited Members

- Public Member Functions inherited from XNameAccess
any getByName ([in] string aName) raises ( com::sun::star::container::NoSuchElementException, com::sun::star::lang::WrappedTargetException )
 
sequence< string > getElementNames ()
 
boolean hasByName ([in] string aName)
 
- Public Member Functions inherited from XElementAccess
type getElementType ()
 
boolean hasElements ()
 
- 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

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

◆ com::sun::star::container::XNameAccess

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 identifier for a pop-up menu. A pop-up 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

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