LibreOffice
LibreOffice 24.2 SDK API Reference
List of all members
theUICategoryDescription Singleton Reference

a singleton which provides information about user interface command categories. More...

import"theUICategoryDescription.idl";

Inheritance diagram for theUICategoryDescription:
XNameAccess XElementAccess XInterface

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 singleton which provides information about user interface command categories.

OpenOffice.org has an amount of commands that can be used by user interface elements. Every command is member of a single category. Categories makes it easier to handle to huge amount of commands provided by OpenOffice.org. This singleton is normally used by UI implementations which provides all commands to a user.

Provides access to user interface command categories of the installed modules.

To access the user interface command categories of a module, a unique module specifier must be provided to com::sun::star::container::XNameAccess::getByName() function. The module specifier can be retrieved from the com::sun::star::frame::ModuleManager service. The interface provides references to com::sun:star::ui::ModuleUICommandDescription.

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

Prior to LibreOffice 4.3, this singleton was only available as a (single-instance) UICategoryDescription service.

Since
LibreOffice 4.3

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