LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XCommandInfo Interface Referencepublished

provides access to information on a set of commands. More...

import"XCommandInfo.idl";

Inheritance diagram for XCommandInfo:
XInterface

Public Member Functions

sequence< com::sun::star::ucb::CommandInfogetCommands ()
 obtains information for all supported commands. More...
 
com::sun::star::ucb::CommandInfo getCommandInfoByName ([in] string Name) raises ( com::sun::star::ucb::UnsupportedCommandException )
 returns information for a specific command. More...
 
com::sun::star::ucb::CommandInfo getCommandInfoByHandle ([in] long Handle) raises ( com::sun::star::ucb::UnsupportedCommandException )
 returns information for a specific command. More...
 
boolean hasCommandByName ([in] string Name)
 checks whether a command specific is supported. More...
 
boolean hasCommandByHandle ([in] long Handle)
 checks whether a specific command is supported. 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...
 

Detailed Description

provides access to information on a set of commands.

Version
1.0
Author
Kai Sommerfeld

Member Function Documentation

com::sun::star::ucb::CommandInfo getCommandInfoByHandle ( [in] long  Handle)
raises (com::sun::star::ucb::UnsupportedCommandException
)

returns information for a specific command.

Returns
the information for the requested command.
Parameters
Handlespecifies the handle of the requested command.
Exceptions
UnsupportedCommandExceptionif the command is not supported.
com::sun::star::ucb::CommandInfo getCommandInfoByName ( [in] string  Name)
raises (com::sun::star::ucb::UnsupportedCommandException
)

returns information for a specific command.

Returns
the information for the requested command.
Parameters
Namespecifies the name of the requested command.
Exceptions
UnsupportedCommandExceptionif the command is not supported.
sequence<com::sun::star::ucb::CommandInfo> getCommands ( )

obtains information for all supported commands.

Returns
a sequence with information for all supported commands.
boolean hasCommandByHandle ( [in] long  Handle)

checks whether a specific command is supported.

Returns
TRUE if a command with the specified handle is supported; otherwise FALSE is returned.
Parameters
Handlespecifies the handle of the requested command.
boolean hasCommandByName ( [in] string  Name)

checks whether a command specific is supported.

Returns
TRUE if a command with the specified name is supported; otherwise FALSE is returned.
Parameters
Namespecifies the name of the requested command.

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