diff options
Diffstat (limited to '')
| -rw-r--r-- | include/vcl/commandinfoprovider.hxx | 107 |
1 files changed, 107 insertions, 0 deletions
diff --git a/include/vcl/commandinfoprovider.hxx b/include/vcl/commandinfoprovider.hxx new file mode 100644 index 000000000..016e53f79 --- /dev/null +++ b/include/vcl/commandinfoprovider.hxx @@ -0,0 +1,107 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef INCLUDED_VCL_COMMANDINFOPROVIDER_HXX +#define INCLUDED_VCL_COMMANDINFOPROVIDER_HXX + +#include <vcl/dllapi.h> +#include <vcl/image.hxx> +#include <vcl/keycod.hxx> + +namespace com::sun::star::frame { class XFrame; } +namespace com::sun::star::beans { struct PropertyValue; } + +namespace vcl::CommandInfoProvider { + + /** Return a label for the given command. + @param rsCommandName + The command name is expected to start with .uno: + @param rsModuleName + The current application module. + @return + The command properties. + */ + VCL_DLLPUBLIC css::uno::Sequence<css::beans::PropertyValue> GetCommandProperties(const OUString& rsCommandName, const OUString& rsModuleName); + + /** Return a label for the given command. + @param rProperties + The properties from GetCommandProperties. + @return + The command label. + */ + VCL_DLLPUBLIC OUString GetLabelForCommand(const css::uno::Sequence<css::beans::PropertyValue>& rProperties); + + VCL_DLLPUBLIC OUString GetMenuLabelForCommand(const css::uno::Sequence<css::beans::PropertyValue>& rProperties); + + VCL_DLLPUBLIC OUString GetPopupLabelForCommand(const css::uno::Sequence<css::beans::PropertyValue>& rProperties); + + VCL_DLLPUBLIC OUString GetTooltipLabelForCommand(const css::uno::Sequence<css::beans::PropertyValue>& rProperties); + + /** Return a tooltip for the given command. Falls back to label if command has no tooltip. + @param rsCommandName + The command name is expected to start with .uno: + @param rProperties + The properties from GetCommandProperties. + @param rxFrame + The frame is used to identify the module and document. + @return + The returned label contains the keyboard accelerator, if + one is defined and bIncludeShortcut is true. + */ + VCL_DLLPUBLIC OUString GetTooltipForCommand ( + const OUString& rsCommandName, + const css::uno::Sequence<css::beans::PropertyValue>& rProperties, + const css::uno::Reference<css::frame::XFrame>& rxFrame); + + /** Returns the shortcut for a command in human-readable form */ + VCL_DLLPUBLIC OUString GetCommandShortcut (const OUString& rCommandName, + const css::uno::Reference<css::frame::XFrame>& rxFrame); + + VCL_DLLPUBLIC KeyCode GetCommandKeyCodeShortcut (const OUString& rCommandName, + const css::uno::Reference<css::frame::XFrame>& rxFrame); + + VCL_DLLPUBLIC OUString GetRealCommandForCommand(const css::uno::Sequence<css::beans::PropertyValue>& rProperties); + + 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 sal_Int32 GetPropertiesForCommand( + const OUString& rsCommandName, + const OUString& rsModuleName); + + VCL_DLLPUBLIC bool IsRotated(const OUString& rsCommandName, const OUString& rsModuleName); + VCL_DLLPUBLIC bool IsMirrored(const OUString& rsCommandName, const OUString& rsModuleName); + + /** Returns whether the command is experimental. */ + VCL_DLLPUBLIC bool IsExperimental( + const OUString& rsCommandName, + const OUString& rModuleName); + + VCL_DLLPUBLIC OUString GetModuleIdentifier(const css::uno::Reference<css::frame::XFrame>& rxFrame); +} + +#endif // INCLUDED_VCL_COMMANDINFOPROVIDER_HXX + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |