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 vcl::KeyCode	RetrieveKeyCodeShortcutsFromConfiguration (const Reference< ui::XAcceleratorConfiguration > &rxConfiguration, const OUString &rsCommandName)

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

Sequence< beans::PropertyValue >	GetCommandProperties (const OUString &rsCommandName, const OUString &rsModuleName)
	Return a label for the given command. More...

static OUString	GetCommandProperty (const OUString &rsProperty, const Sequence< beans::PropertyValue > &rProperties)

OUString	GetLabelForCommand (const css::uno::Sequence< css::beans::PropertyValue > &rProperties)
	Return a label for the given command. More...

OUString	GetMenuLabelForCommand (const css::uno::Sequence< css::beans::PropertyValue > &rProperties)

OUString	GetPopupLabelForCommand (const css::uno::Sequence< css::beans::PropertyValue > &rProperties)

OUString	GetTooltipLabelForCommand (const css::uno::Sequence< css::beans::PropertyValue > &rProperties)

OUString	GetTooltipForCommand (const OUString &rsCommandName, const css::uno::Sequence< css::beans::PropertyValue > &rProperties, const Reference< frame::XFrame > &rxFrame)

OUString	GetCommandShortcut (const OUString &rsCommandName, const Reference< frame::XFrame > &rxFrame)

vcl::KeyCode	GetCommandKeyCodeShortcut (const OUString &rsCommandName, const Reference< frame::XFrame > &rxFrame)

OUString	GetRealCommandForCommand (const css::uno::Sequence< css::beans::PropertyValue > &rProperties)

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::Sequence< css::beans::PropertyValue > &rProperties, 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 KeyCode	GetCommandKeyCodeShortcut (const OUString &rCommandName, const css::uno::Reference< css::frame::XFrame > &rxFrame)

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

◆ AWTKey2VCLKey()

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

static

Definition at line 123 of file commandinfoprovider.cxx.

Referenced by RetrieveKeyCodeShortcutsFromConfiguration(), and RetrieveShortcutsFromConfiguration().

◆ GetCommandDescription()

static Reference< container::XNameAccess > vcl::CommandInfoProvider::GetCommandDescription ( )

static

Definition at line 43 of file commandinfoprovider.cxx.

References comphelper::getProcessComponentContext().

Referenced by GetCommandProperties(), IsExperimental(), and ResourceHasKey().

◆ GetCommandKeyCodeShortcut() [1/2]

VCL_DLLPUBLIC KeyCode vcl::CommandInfoProvider::GetCommandKeyCodeShortcut	(	const OUString &	rCommandName,
		const css::uno::Reference< css::frame::XFrame > &	rxFrame
	)

◆ GetCommandKeyCodeShortcut() [2/2]

vcl::KeyCode vcl::CommandInfoProvider::GetCommandKeyCodeShortcut	(	const OUString &	rsCommandName,
		const Reference< frame::XFrame > &	rxFrame
	)

Definition at line 316 of file commandinfoprovider.cxx.

References vcl::KeyCode::GetCode(), GetDocumentAcceleratorConfiguration(), GetGlobalAcceleratorConfiguration(), GetModuleAcceleratorConfiguration(), and RetrieveKeyCodeShortcutsFromConfiguration().

◆ GetCommandProperties()

VCL_DLLPUBLIC css::uno::Sequence< css::beans::PropertyValue > vcl::CommandInfoProvider::GetCommandProperties	(	const OUString &	rsCommandName,
		const OUString &	rsModuleName
	)

Return a label for the given command.

Parameters

rsCommandName	The command name is expected to start with .uno:
rsModuleName	The current application module.

Returns: The command properties.

Definition at line 211 of file commandinfoprovider.cxx.

References aProperties, Exception, and GetCommandDescription().

Referenced by GetPropertiesForCommand(), and ToolBox::InsertItem().

◆ GetCommandProperty()

static OUString vcl::CommandInfoProvider::GetCommandProperty	(	const OUString &	rsProperty,
		const Sequence< beans::PropertyValue > &	rProperties
	)

static

Definition at line 232 of file commandinfoprovider.cxx.

Referenced by GetLabelForCommand(), GetMenuLabelForCommand(), GetPopupLabelForCommand(), GetRealCommandForCommand(), GetTooltipForCommand(), and GetTooltipLabelForCommand().

◆ GetCommandShortcut() [1/2]

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.

◆ GetCommandShortcut() [2/2]

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

Definition at line 295 of file commandinfoprovider.cxx.

References GetDocumentAcceleratorConfiguration(), GetGlobalAcceleratorConfiguration(), GetModuleAcceleratorConfiguration(), and RetrieveShortcutsFromConfiguration().

Referenced by GetTooltipForCommand().

◆ GetDocumentAcceleratorConfiguration()

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 GetCommandKeyCodeShortcut(), and GetCommandShortcut().

◆ GetGlobalAcceleratorConfiguration()

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

static

Definition at line 71 of file commandinfoprovider.cxx.

References comphelper::getProcessComponentContext().

Referenced by GetCommandKeyCodeShortcut(), and GetCommandShortcut().

◆ GetImageForCommand() [1/2]

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

◆ GetImageForCommand() [2/2]

Image vcl::CommandInfoProvider::GetImageForCommand	(	const OUString &	rsCommandName,
		const Reference< frame::XFrame > &	rxFrame,
		vcl::ImageType	eImageType
	)

Definition at line 395 of file commandinfoprovider.cxx.

References GetXGraphicForCommand().

Referenced by CreateNotebookBarToolBox(), and ToolBox::InsertItem().

◆ GetLabelForCommand()

VCL_DLLPUBLIC OUString vcl::CommandInfoProvider::GetLabelForCommand ( const css::uno::Sequence< css::beans::PropertyValue > & rProperties )

Return a label for the given command.

Parameters

rProperties The properties from GetCommandProperties.

Returns: The command label.

Definition at line 245 of file commandinfoprovider.cxx.

References GetCommandProperty().

Referenced by ToolBox::InsertItem().

◆ GetMenuLabelForCommand()

VCL_DLLPUBLIC OUString vcl::CommandInfoProvider::GetMenuLabelForCommand ( const css::uno::Sequence< css::beans::PropertyValue > & rProperties )

Definition at line 250 of file commandinfoprovider.cxx.

References GetCommandProperty().

◆ GetModuleAcceleratorConfiguration()

static Reference< ui::XAcceleratorConfiguration > vcl::CommandInfoProvider::GetModuleAcceleratorConfiguration ( const Reference< frame::XFrame > & rxFrame )

static

Definition at line 104 of file commandinfoprovider.cxx.

References Exception, GetModuleConfigurationSupplier(), and GetModuleIdentifier().

Referenced by GetCommandKeyCodeShortcut(), and GetCommandShortcut().

◆ GetModuleConfigurationSupplier()

static Reference< ui::XModuleUIConfigurationManagerSupplier > vcl::CommandInfoProvider::GetModuleConfigurationSupplier ( )

static

Definition at line 57 of file commandinfoprovider.cxx.

References comphelper::getProcessComponentContext().

Referenced by GetModuleAcceleratorConfiguration(), and GetXGraphicForCommand().

◆ GetModuleIdentifier() [1/2]

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

◆ GetModuleIdentifier() [2/2]

OUString vcl::CommandInfoProvider::GetModuleIdentifier ( const Reference< frame::XFrame > & rxFrame )

Definition at line 454 of file commandinfoprovider.cxx.

References Exception, and comphelper::getProcessComponentContext().

Referenced by GetModuleAcceleratorConfiguration(), GetXGraphicForCommand(), and ToolBox::InsertItem().

◆ GetPopupLabelForCommand()

VCL_DLLPUBLIC OUString vcl::CommandInfoProvider::GetPopupLabelForCommand ( const css::uno::Sequence< css::beans::PropertyValue > & rProperties )

Definition at line 257 of file commandinfoprovider.cxx.

References GetCommandProperty().

Referenced by GetTooltipForCommand().

◆ GetPropertiesForCommand()

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

Definition at line 402 of file commandinfoprovider.cxx.

References aProperties, GetCommandProperties(), and nValue.

◆ GetRealCommandForCommand()

VCL_DLLPUBLIC OUString vcl::CommandInfoProvider::GetRealCommandForCommand ( const css::uno::Sequence< css::beans::PropertyValue > & rProperties )

Definition at line 335 of file commandinfoprovider.cxx.

References GetCommandProperty().

Referenced by GetTooltipForCommand().

◆ GetTooltipForCommand() [1/2]

VCL_DLLPUBLIC OUString vcl::CommandInfoProvider::GetTooltipForCommand	(	const OUString &	rsCommandName,
		const css::uno::Sequence< css::beans::PropertyValue > &	rProperties,
		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

rsCommandName	The command name is expected to start with .uno:
rProperties	The properties from GetCommandProperties.
rxFrame	The 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.

◆ GetTooltipForCommand() [2/2]

OUString vcl::CommandInfoProvider::GetTooltipForCommand	(	const OUString &	rsCommandName,
		const css::uno::Sequence< css::beans::PropertyValue > &	rProperties,
		const Reference< frame::XFrame > &	rxFrame
	)

Definition at line 273 of file commandinfoprovider.cxx.

References MnemonicGenerator::EraseAllMnemonicChars(), GetCommandProperty(), GetCommandShortcut(), GetPopupLabelForCommand(), GetRealCommandForCommand(), and comphelper::string::stripEnd().

Referenced by ToolBox::InsertItem().

◆ GetTooltipLabelForCommand()

VCL_DLLPUBLIC OUString vcl::CommandInfoProvider::GetTooltipLabelForCommand ( const css::uno::Sequence< css::beans::PropertyValue > & rProperties )

Definition at line 265 of file commandinfoprovider.cxx.

References GetCommandProperty().

◆ GetXGraphicForCommand() [1/2]

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`
	)

◆ GetXGraphicForCommand() [2/2]

Reference< graphic::XGraphic > vcl::CommandInfoProvider::GetXGraphicForCommand	(	const OUString &	rsCommandName,
		const Reference< frame::XFrame > &	rxFrame,
		vcl::ImageType	eImageType
	)

Definition at line 340 of file commandinfoprovider.cxx.

References Exception, GetModuleConfigurationSupplier(), GetModuleIdentifier(), vcl::Size26, vcl::Size32, and xController.

Referenced by GetImageForCommand().

◆ IsExperimental()

VCL_DLLPUBLIC bool vcl::CommandInfoProvider::IsExperimental	(	const OUString &	rsCommandName,
		const OUString &	rModuleName
	)

Returns whether the command is experimental.

Definition at line 427 of file commandinfoprovider.cxx.

References aProperties, Exception, and GetCommandDescription().

◆ IsMirrored()

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

Definition at line 422 of file commandinfoprovider.cxx.

References ResourceHasKey().

◆ IsRotated()

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

Definition at line 417 of file commandinfoprovider.cxx.

References ResourceHasKey().

◆ ResourceHasKey()

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

static

Definition at line 188 of file commandinfoprovider.cxx.

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

Referenced by IsMirrored(), and IsRotated().

◆ RetrieveKeyCodeShortcutsFromConfiguration()

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

static

Definition at line 161 of file commandinfoprovider.cxx.

References AWTKey2VCLKey().

Referenced by GetCommandKeyCodeShortcut().

◆ RetrieveShortcutsFromConfiguration()

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().

Functions

Function Documentation

◆ AWTKey2VCLKey()

◆ GetCommandDescription()

◆ GetCommandKeyCodeShortcut() [1/2]

◆ GetCommandKeyCodeShortcut() [2/2]

◆ GetCommandProperties()

◆ GetCommandProperty()

◆ GetCommandShortcut() [1/2]

◆ GetCommandShortcut() [2/2]

◆ GetDocumentAcceleratorConfiguration()

◆ GetGlobalAcceleratorConfiguration()

◆ GetImageForCommand() [1/2]

◆ GetImageForCommand() [2/2]

◆ GetLabelForCommand()

◆ GetMenuLabelForCommand()

◆ GetModuleAcceleratorConfiguration()

◆ GetModuleConfigurationSupplier()

◆ GetModuleIdentifier() [1/2]

◆ GetModuleIdentifier() [2/2]

◆ GetPopupLabelForCommand()

◆ GetPropertiesForCommand()

◆ GetRealCommandForCommand()

◆ GetTooltipForCommand() [1/2]

◆ GetTooltipForCommand() [2/2]

◆ GetTooltipLabelForCommand()

◆ GetXGraphicForCommand() [1/2]

◆ GetXGraphicForCommand() [2/2]

◆ IsExperimental()

◆ IsMirrored()

◆ IsRotated()

◆ ResourceHasKey()

◆ RetrieveKeyCodeShortcutsFromConfiguration()

◆ RetrieveShortcutsFromConfiguration()