LibreOffice Module vcl (master)  1
Functions
vcl::CommandInfoProvider Namespace Reference

Functions

static Reference< container::XNameAccess > GetCommandDescription ()
 
static Reference< ui::XModuleUIConfigurationManagerSupplier > GetModuleConfigurationSupplier ()
 
static Reference< ui::XAcceleratorConfiguration > GetGlobalAcceleratorConfiguration ()
 
static Reference< ui::XAcceleratorConfiguration > GetDocumentAcceleratorConfiguration (const Reference< frame::XFrame > &rxFrame)
 
static Reference< ui::XAcceleratorConfiguration > GetModuleAcceleratorConfiguration (const Reference< frame::XFrame > &rxFrame)
 
static vcl::KeyCode AWTKey2VCLKey (const awt::KeyEvent &aAWTKey)
 
static OUString RetrieveShortcutsFromConfiguration (const Reference< ui::XAcceleratorConfiguration > &rxConfiguration, const OUString &rsCommandName)
 
static bool ResourceHasKey (const OUString &rsResourceName, const OUString &rsCommandName, const OUString &rsModuleName)
 
static Sequence< beans::PropertyValue > GetCommandProperties (const OUString &rsCommandName, const OUString &rsModuleName)
 
static OUString GetCommandProperty (const OUString &rsProperty, const OUString &rsCommandName, const OUString &rsModuleName)
 
OUString GetLabelForCommand (const OUString &rsCommandName, const OUString &rsModuleName)
 Return a label for the given command. More...
 
OUString GetMenuLabelForCommand (const OUString &rsCommandName, const OUString &rsModuleName)
 
OUString GetPopupLabelForCommand (const OUString &rsCommandName, const OUString &rsModuleName)
 
OUString GetTooltipForCommand (const OUString &rsCommandName, const Reference< frame::XFrame > &rxFrame)
 
OUString GetCommandShortcut (const OUString &rsCommandName, const Reference< frame::XFrame > &rxFrame)
 
OUString GetRealCommandForCommand (const OUString &rCommandName, const OUString &rsModuleName)
 
Reference< graphic::XGraphic > GetXGraphicForCommand (const OUString &rsCommandName, const Reference< frame::XFrame > &rxFrame, vcl::ImageType eImageType)
 
Image GetImageForCommand (const OUString &rsCommandName, const Reference< frame::XFrame > &rxFrame, vcl::ImageType eImageType)
 
sal_Int32 GetPropertiesForCommand (const OUString &rsCommandName, const OUString &rsModuleName)
 
bool IsRotated (const OUString &rsCommandName, const OUString &rsModuleName)
 
bool IsMirrored (const OUString &rsCommandName, const OUString &rsModuleName)
 
bool IsExperimental (const OUString &rsCommandName, const OUString &rModuleName)
 Returns whether the command is experimental. More...
 
OUString GetModuleIdentifier (const Reference< frame::XFrame > &rxFrame)
 
VCL_DLLPUBLIC OUString GetTooltipForCommand (const OUString &rsCommandName, const css::uno::Reference< css::frame::XFrame > &rxFrame)
 Return a tooltip for the given command. More...
 
VCL_DLLPUBLIC OUString GetCommandShortcut (const OUString &rCommandName, const css::uno::Reference< css::frame::XFrame > &rxFrame)
 Returns the shortcut for a command in human-readable form. More...
 
VCL_DLLPUBLIC css::uno::Reference< css::graphic::XGraphic > GetXGraphicForCommand (const OUString &rsCommandName, const css::uno::Reference< css::frame::XFrame > &rxFrame, vcl::ImageType eImageType=vcl::ImageType::Small)
 
VCL_DLLPUBLIC Image GetImageForCommand (const OUString &rsCommandName, const css::uno::Reference< css::frame::XFrame > &rxFrame, vcl::ImageType eImageType=vcl::ImageType::Small)
 
VCL_DLLPUBLIC OUString GetModuleIdentifier (const css::uno::Reference< css::frame::XFrame > &rxFrame)
 

Function Documentation

static vcl::KeyCode vcl::CommandInfoProvider::AWTKey2VCLKey ( const awt::KeyEvent &  aAWTKey)
static

Definition at line 123 of file commandinfoprovider.cxx.

Referenced by RetrieveShortcutsFromConfiguration().

static Reference<container::XNameAccess> vcl::CommandInfoProvider::GetCommandDescription ( )
static
static Sequence<beans::PropertyValue> vcl::CommandInfoProvider::GetCommandProperties ( const OUString &  rsCommandName,
const OUString &  rsModuleName 
)
static

Definition at line 184 of file commandinfoprovider.cxx.

References Exception, and GetCommandDescription().

Referenced by GetCommandProperty(), and GetPropertiesForCommand().

static OUString vcl::CommandInfoProvider::GetCommandProperty ( const OUString &  rsProperty,
const OUString &  rsCommandName,
const OUString &  rsModuleName 
)
static
VCL_DLLPUBLIC OUString vcl::CommandInfoProvider::GetCommandShortcut ( const OUString &  rCommandName,
const css::uno::Reference< css::frame::XFrame > &  rxFrame 
)

Returns the shortcut for a command in human-readable form.

OUString vcl::CommandInfoProvider::GetCommandShortcut ( const OUString &  rsCommandName,
const Reference< frame::XFrame > &  rxFrame 
)
static Reference<ui::XAcceleratorConfiguration> vcl::CommandInfoProvider::GetDocumentAcceleratorConfiguration ( const Reference< frame::XFrame > &  rxFrame)
static

Definition at line 85 of file commandinfoprovider.cxx.

References xController.

Referenced by GetCommandShortcut().

static Reference<ui::XAcceleratorConfiguration> vcl::CommandInfoProvider::GetGlobalAcceleratorConfiguration ( )
static

Definition at line 71 of file commandinfoprovider.cxx.

References comphelper::getProcessComponentContext().

Referenced by GetCommandShortcut().

VCL_DLLPUBLIC Image vcl::CommandInfoProvider::GetImageForCommand ( const OUString &  rsCommandName,
const css::uno::Reference< css::frame::XFrame > &  rxFrame,
vcl::ImageType  eImageType = vcl::ImageType::Small 
)
Image vcl::CommandInfoProvider::GetImageForCommand ( const OUString &  rsCommandName,
const Reference< frame::XFrame > &  rxFrame,
vcl::ImageType  eImageType 
)
VCL_DLLPUBLIC OUString vcl::CommandInfoProvider::GetLabelForCommand ( const OUString &  rsCommandName,
const OUString &  rsModuleName 
)

Return a label for the given command.

Parameters
rsCommandNameThe command name is expected to start with .uno:
rsModuleNameThe current application module.
Returns
The command label.

Definition at line 219 of file commandinfoprovider.cxx.

References GetCommandProperty().

Referenced by ToolBox::InsertItem(), and weld::ToolbarUnoDispatcher::ToolbarUnoDispatcher().

VCL_DLLPUBLIC OUString vcl::CommandInfoProvider::GetMenuLabelForCommand ( const OUString &  rsCommandName,
const OUString &  rsModuleName 
)

Definition at line 226 of file commandinfoprovider.cxx.

References GetCommandProperty().

static Reference<ui::XAcceleratorConfiguration> vcl::CommandInfoProvider::GetModuleAcceleratorConfiguration ( const Reference< frame::XFrame > &  rxFrame)
static
static Reference<ui::XModuleUIConfigurationManagerSupplier> vcl::CommandInfoProvider::GetModuleConfigurationSupplier ( )
static
VCL_DLLPUBLIC OUString vcl::CommandInfoProvider::GetModuleIdentifier ( const css::uno::Reference< css::frame::XFrame > &  rxFrame)
OUString vcl::CommandInfoProvider::GetModuleIdentifier ( const Reference< frame::XFrame > &  rxFrame)
VCL_DLLPUBLIC OUString vcl::CommandInfoProvider::GetPopupLabelForCommand ( const OUString &  rsCommandName,
const OUString &  rsModuleName 
)

Definition at line 235 of file commandinfoprovider.cxx.

References GetCommandProperty().

Referenced by GetTooltipForCommand(), and Menu::InsertItem().

VCL_DLLPUBLIC sal_Int32 vcl::CommandInfoProvider::GetPropertiesForCommand ( const OUString &  rsCommandName,
const OUString &  rsModuleName 
)

Definition at line 359 of file commandinfoprovider.cxx.

References GetCommandProperties().

VCL_DLLPUBLIC OUString vcl::CommandInfoProvider::GetRealCommandForCommand ( const OUString &  rCommandName,
const OUString &  rsModuleName 
)

Definition at line 288 of file commandinfoprovider.cxx.

References GetCommandProperty().

Referenced by GetTooltipForCommand().

VCL_DLLPUBLIC OUString vcl::CommandInfoProvider::GetTooltipForCommand ( const OUString &  rsCommandName,
const css::uno::Reference< css::frame::XFrame > &  rxFrame 
)

Return a tooltip for the given command.

Falls back to label if command has no tooltip.

Parameters
rsCommandNameThe command name is expected to start with .uno:
rxFrameThe frame is used to identify the module and document.
Returns
The returned label contains the keyboard accelerator, if one is defined and bIncludeShortcut is true.
OUString vcl::CommandInfoProvider::GetTooltipForCommand ( const OUString &  rsCommandName,
const Reference< frame::XFrame > &  rxFrame 
)
VCL_DLLPUBLIC css::uno::Reference<css::graphic::XGraphic> vcl::CommandInfoProvider::GetXGraphicForCommand ( const OUString &  rsCommandName,
const css::uno::Reference< css::frame::XFrame > &  rxFrame,
vcl::ImageType  eImageType = vcl::ImageType::Small 
)
Reference<graphic::XGraphic> vcl::CommandInfoProvider::GetXGraphicForCommand ( const OUString &  rsCommandName,
const Reference< frame::XFrame > &  rxFrame,
vcl::ImageType  eImageType 
)
VCL_DLLPUBLIC bool vcl::CommandInfoProvider::IsExperimental ( const OUString &  rsCommandName,
const OUString &  rModuleName 
)

Returns whether the command is experimental.

Definition at line 384 of file commandinfoprovider.cxx.

References Exception, and GetCommandDescription().

VCL_DLLPUBLIC bool vcl::CommandInfoProvider::IsMirrored ( const OUString &  rsCommandName,
const OUString &  rsModuleName 
)

Definition at line 379 of file commandinfoprovider.cxx.

References IsMirrored(), and ResourceHasKey().

Referenced by ToolBox::statusChanged().

VCL_DLLPUBLIC bool vcl::CommandInfoProvider::IsRotated ( const OUString &  rsCommandName,
const OUString &  rsModuleName 
)

Definition at line 374 of file commandinfoprovider.cxx.

References ResourceHasKey().

Referenced by ToolBox::statusChanged().

static bool vcl::CommandInfoProvider::ResourceHasKey ( const OUString &  rsResourceName,
const OUString &  rsCommandName,
const OUString &  rsModuleName 
)
static

Definition at line 161 of file commandinfoprovider.cxx.

References Exception, comphelper::findValue(), and GetCommandDescription().

Referenced by IsMirrored(), and IsRotated().

static OUString vcl::CommandInfoProvider::RetrieveShortcutsFromConfiguration ( const Reference< ui::XAcceleratorConfiguration > &  rxConfiguration,
const OUString &  rsCommandName 
)
static

Definition at line 134 of file commandinfoprovider.cxx.

References AWTKey2VCLKey(), and vcl::KeyCode::GetName().

Referenced by GetCommandShortcut().