include/sfx2/sidebar/CommandInfoProvider.hxx

   1 /*
   2  * This file is part of the LibreOffice project.
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7  *
   8  * This file incorporates work covered by the following license notice:
   9  *
  10  *   Licensed to the Apache Software Foundation (ASF) under one or more
  11  *   contributor license agreements. See the NOTICE file distributed
  12  *   with this work for additional information regarding copyright
  13  *   ownership. The ASF licenses this file to you under the Apache
  14  *   License, Version 2.0 (the "License"); you may not use this file
  15  *   except in compliance with the License. You may obtain a copy of
  16  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17  */
  18 #ifndef SIDEBAR_COMMAND_INFO_PROVIDER_HXX
  19 #define SIDEBAR_COMMAND_INFO_PROVIDER_HXX
  20
  21 #include "sfx2/dllapi.h"
  22
  23 #include <com/sun/star/frame/XFrame.hpp>
  24 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  25 #include <com/sun/star/ui/XAcceleratorConfiguration.hpp>
  26
  27
  28 namespace css = ::com::sun::star;
  29 namespace cssu = ::com::sun::star::uno;
  30
  31 namespace sfx2 { namespace sidebar {
  32
  33 /** Provide information about UNO commands like tooltip text with
  34     keyboard accelerator.
  35 */
  36 class SFX2_DLLPUBLIC CommandInfoProvider
  37 {
  38 public:
  39     /** Return the singleton instance.
  40
  41         It caches some objects for the last XFrame object given to
  42         GetLabelForCommand.  These objects are release and created new
  43         when that method is called with a different XFrame from the
  44         last call.
  45
  46         Lifetime control should work but could be more elegant.
  47     */
  48     static CommandInfoProvider& Instance (void);
  49
  50     /** Return a label for the given command.
  51         @param rsCommandName
  52             The command name is expected to start with .uno:
  53         @param rxFrame
  54             The frame is used to identify the module and document.
  55         @return
  56             The returned label contains the keyboard accelerator, if
  57             one is defined.
  58     */
  59     ::rtl::OUString GetLabelForCommand (
  60         const ::rtl::OUString& rsCommandName,
  61         const cssu::Reference<css::frame::XFrame>& rxFrame);
  62
  63     /** Do not call.  Should be part of a local and hidden interface.
  64     */
  65     void SetFrame (const cssu::Reference<css::frame::XFrame>& rxFrame);
  66
  67   private:
  68     cssu::Reference<css::lang::XMultiServiceFactory> mxServiceFactory;
  69     cssu::Reference<css::frame::XFrame> mxCachedDataFrame;
  70     cssu::Reference<css::ui::XAcceleratorConfiguration> mxCachedDocumentAcceleratorConfiguration;
  71     cssu::Reference<css::ui::XAcceleratorConfiguration> mxCachedModuleAcceleratorConfiguration;
  72     cssu::Reference<css::ui::XAcceleratorConfiguration> mxCachedGlobalAcceleratorConfiguration;
  73     ::rtl::OUString msCachedModuleIdentifier;
  74     cssu::Reference<css::lang::XComponent> mxFrameListener;
  75
  76     CommandInfoProvider (void);
  77     ~CommandInfoProvider (void);
  78
  79     cssu::Reference<css::ui::XAcceleratorConfiguration> GetDocumentAcceleratorConfiguration (void);
  80     cssu::Reference<css::ui::XAcceleratorConfiguration> GetModuleAcceleratorConfiguration (void);
  81     cssu::Reference<css::ui::XAcceleratorConfiguration> GetGlobalAcceleratorConfiguration(void);
  82     ::rtl::OUString GetModuleIdentifier (void);
  83     ::rtl::OUString GetCommandShortcut (const ::rtl::OUString& rCommandName);
  84     cssu::Sequence<css::beans::PropertyValue> GetCommandProperties (
  85         const ::rtl::OUString& rsCommandName);
  86     ::rtl::OUString GetCommandLabel (const ::rtl::OUString& rsCommandName);
  87     rtl::OUString RetrieveShortcutsFromConfiguration(
  88         const cssu::Reference<css::ui::XAcceleratorConfiguration>& rxConfiguration,
  89         const rtl::OUString& rsCommandName);
  90 };
  91
  92 } } // end of namespace sfx2/framework
  93
  94 #endif