include/sfx2/sidebar/ResourceManager.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef INCLUDED_SFX2_SOURCE_SIDEBAR_RESOURCEMANAGER_HXX
  20 #define INCLUDED_SFX2_SOURCE_SIDEBAR_RESOURCEMANAGER_HXX
  21
  22 #include "DeckDescriptor.hxx"
  23 #include "PanelDescriptor.hxx"
  24 #include <sfx2/sidebar/Context.hxx>
  25 #include <unotools/confignode.hxx>
  26 #include <com/sun/star/frame/XController.hpp>
  27 #include <set>
  28 #include <svtools/miscopt.hxx>
  29
  30 namespace sfx2 { namespace sidebar {
  31
  32 class Context;
  33 class ContextList;
  34
  35 /** Read the content of the Sidebar.xcu file and provide access
  36     methods so that the sidebar can easily decide which content panels
  37     to display for a certain context.
  38 */
  39 class ResourceManager
  40 {
  41 public:
  42
  43      ResourceManager();
  44     ~ResourceManager();
  45
  46     std::shared_ptr<DeckDescriptor> GetDeckDescriptor(const OUString& rsDeckId) const;
  47     std::shared_ptr<PanelDescriptor> GetPanelDescriptor(const OUString& rsPanelId) const;
  48
  49     void UpdateModel(const css::uno::Reference<css::frame::XModel>& xModel);
  50
  51     void InitDeckContext(const Context& rContex);
  52     void SaveDecksSettings(const Context& rContext);
  53     void SaveDeckSettings(const DeckDescriptor* pDeckDesc);
  54
  55     void disposeDecks();
  56
  57     class DeckContextDescriptor
  58     {
  59     public:
  60         OUString msId;
  61         bool mbIsEnabled;
  62     };
  63     typedef std::vector<DeckContextDescriptor> DeckContextDescriptorContainer;
  64
  65     class PanelContextDescriptor
  66     {
  67     public:
  68         OUString msId;
  69         OUString msMenuCommand;
  70         bool mbIsInitiallyVisible;
  71         bool mbShowForReadOnlyDocuments;
  72     };
  73     typedef std::vector<PanelContextDescriptor> PanelContextDescriptorContainer;
  74
  75     const DeckContextDescriptorContainer& GetMatchingDecks(
  76                                             DeckContextDescriptorContainer& rDeckDescriptors,
  77                                             const Context& rContext,
  78                                             const bool bIsDocumentReadOnly,
  79                                             const css::uno::Reference<css::frame::XController>& rxController);
  80
  81     const PanelContextDescriptorContainer& GetMatchingPanels(
  82                                             PanelContextDescriptorContainer& rPanelDescriptors,
  83                                             const Context& rContext,
  84                                             const OUString& rsDeckId,
  85                                             const css::uno::Reference<css::frame::XController>& rxController);
  86
  87     /** Remember the expansions state per panel and context.
  88     */
  89     void StorePanelExpansionState(const OUString& rsPanelId,
  90                                   const bool bExpansionState,
  91                                   const Context& rContext);
  92
  93 private:
  94
  95
  96     typedef std::vector<std::shared_ptr<DeckDescriptor>> DeckContainer;
  97     DeckContainer maDecks;
  98
  99     typedef std::vector<std::shared_ptr<PanelDescriptor>> PanelContainer;
 100     PanelContainer maPanels;
 101     mutable std::set<rtl::OUString> maProcessedApplications;
 102
 103     SvtMiscOptions maMiscOptions;
 104
 105     void ReadDeckList();
 106     void ReadPanelList();
 107     static void ReadContextList(const utl::OConfigurationNode& rNode,
 108                          ContextList& rContextList,
 109                          const OUString& rsDefaultMenuCommand);
 110
 111     void ReadLegacyAddons(const css::uno::Reference<css::frame::XController>& rxController);
 112     static utl::OConfigurationTreeRoot GetLegacyAddonRootNode(const OUString& rsModuleName);
 113     static void GetToolPanelNodeNames(std::vector<OUString>& rMatchingNames,
 114                                const utl::OConfigurationTreeRoot& aRoot);
 115     bool IsDeckEnabled(const OUString& rsDeckId,
 116                        const Context& rContext,
 117                        const css::uno::Reference<css::frame::XController>& rxController);
 118
 119     std::shared_ptr<DeckDescriptor> ImplGetDeckDescriptor(const OUString& rsDeckId) const;
 120     std::shared_ptr<PanelDescriptor> ImplGetPanelDescriptor(const OUString& rsPanelId) const;
 121 };
 122
 123 } } // end of namespace sfx2::sidebar
 124
 125 #endif
 126
 127 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */