diff options
author | Samuel Mehrbrodt <Samuel.Mehrbrodt@cib.de> | 2015-11-16 12:23:25 +0100 |
---|---|---|
committer | Samuel Mehrbrodt <Samuel.Mehrbrodt@cib.de> | 2015-11-16 14:48:47 +0000 |
commit | 40fa83871e18bf7ff54f853e6b665f207ee8fb78 (patch) | |
tree | 01d9d3c2a627e1b38ed7451d0be89cb045692de7 /include/svtools | |
parent | 396b5f411f7ecc7d600efdc0bb2381a7d1ed6d88 (diff) |
Move CommandInfoProvider to vcl and use it from there
Change-Id: If7e3ef81cad8974bc54f359096e3ecc700fa62d6
Reviewed-on: https://gerrit.libreoffice.org/19984
Tested-by: Jenkins <ci@libreoffice.org>
Reviewed-by: Samuel Mehrbrodt <Samuel.Mehrbrodt@cib.de>
Diffstat (limited to 'include/svtools')
-rw-r--r-- | include/svtools/commandinfoprovider.hxx | 112 |
1 files changed, 0 insertions, 112 deletions
diff --git a/include/svtools/commandinfoprovider.hxx b/include/svtools/commandinfoprovider.hxx deleted file mode 100644 index 6c0431bf7d7c..000000000000 --- a/include/svtools/commandinfoprovider.hxx +++ /dev/null @@ -1,112 +0,0 @@ -/* -*- 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_COMPHELPER_COMMANDINFOPROVIDER_HXX -#define INCLUDED_COMPHELPER_COMMANDINFOPROVIDER_HXX - -#include <svtools/svtdllapi.h> - -#include <com/sun/star/frame/XFrame.hpp> -#include <com/sun/star/uno/XComponentContext.hpp> -#include <com/sun/star/ui/XAcceleratorConfiguration.hpp> - - -namespace svt { - -/** Provide information about UNO commands like tooltip text with - keyboard accelerator. -*/ -class SVT_DLLPUBLIC CommandInfoProvider -{ -public: - /** Return the singleton instance. - - It caches some objects for the last XFrame object given to - GetLabelForCommand. These objects are release and created new - when that method is called with a different XFrame from the - last call. - - Lifetime control should work but could be more elegant. - */ - static CommandInfoProvider& Instance(); - - /** Return a label for the given command. - @param rsCommandName - The command name is expected to start with .uno: - @param rxFrame - The frame is used to identify the module and document. - @return - The command labe. - */ - OUString GetLabelForCommand ( - 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. - @param rsCommandName - The command name is expected to start with .uno: - @param rxFrame - The frame is used to identify the module and document. - @param bIncludeShortcut - Whether the shortcut should be appended in brackets - @return - The returned label contains the keyboard accelerator, if - one is defined and bIncludeShortcut is true. - */ - OUString GetTooltipForCommand ( - const OUString& rsCommandName, - const css::uno::Reference<css::frame::XFrame>& rxFrame, - bool bIncludeShortcut = true); - - /** Returns the shortcut for a command in human-readable form */ - OUString GetCommandShortcut (const OUString& rCommandName, - const css::uno::Reference<css::frame::XFrame>& rxFrame); - - /** Do not call. Should be part of a local and hidden interface. - */ - void SetFrame (const css::uno::Reference<css::frame::XFrame>& rxFrame); - - private: - css::uno::Reference<css::uno::XComponentContext> mxContext; - css::uno::Reference<css::frame::XFrame> mxCachedDataFrame; - css::uno::Reference<css::ui::XAcceleratorConfiguration> mxCachedDocumentAcceleratorConfiguration; - css::uno::Reference<css::ui::XAcceleratorConfiguration> mxCachedModuleAcceleratorConfiguration; - css::uno::Reference<css::ui::XAcceleratorConfiguration> mxCachedGlobalAcceleratorConfiguration; - OUString msCachedModuleIdentifier; - css::uno::Reference<css::lang::XComponent> mxFrameListener; - - CommandInfoProvider(); - ~CommandInfoProvider(); - - css::uno::Reference<css::ui::XAcceleratorConfiguration> GetDocumentAcceleratorConfiguration(); - css::uno::Reference<css::ui::XAcceleratorConfiguration> GetModuleAcceleratorConfiguration(); - css::uno::Reference<css::ui::XAcceleratorConfiguration> GetGlobalAcceleratorConfiguration(); - OUString GetModuleIdentifier(); - css::uno::Sequence<css::beans::PropertyValue> GetCommandProperties ( - const OUString& rsCommandName); - OUString GetCommandProperty(const OUString& rsProperty, const OUString& rsCommandName); - static OUString RetrieveShortcutsFromConfiguration( - const css::uno::Reference<css::ui::XAcceleratorConfiguration>& rxConfiguration, - const OUString& rsCommandName); -}; - -} // end of namespace svt - -#endif // INCLUDED_COMPHELPER_COMMANDINFOPROVIDER_HXX - -/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |