- fdo#35973 - Remember the state of the sidebar pane in Impress (ToolPanel)

Change-Id: Ifd45a289a5a7b0cb87100e1ff3854ec72143019c
Reviewed-on: https://gerrit.libreoffice.org/526Reviewed-by: Thorsten Behrens <tbehrens@suse.com>
Tested-by: Thorsten Behrens <tbehrens@suse.com>

officecfg/registry/data/org/openoffice/Office/Impress.xcu

@@ -28,6 +28,25 @@
 <!DOCTYPE oor:component-data SYSTEM "../../../../component-update.dtd">
 <oor:component-data oor:name="Impress" oor:package="org.openoffice.Office" xmlns:install="http://openoffice.org/2004/installation" xmlns:oor="http://openoffice.org/2001/registry" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <node oor:name="MultiPaneGUI">
+    <node oor:name="ToolPanel">
+      <node oor:name="Visible">
+        <prop oor:name="ImpressView">
+          <value>true</value>
+        </prop>
+        <prop oor:name="OutlineView">
+          <value>false</value>
+        </prop>
+        <prop oor:name="NotesView">
+          <value>true</value>
+        </prop>
+        <prop oor:name="HandoutView">
+          <value>true</value>
+        </prop>
+        <prop oor:name="SlideSorterView">
+          <value>true</value>
+        </prop>
+      </node>
+    </node>
     <node oor:name="SlideSorterBar">
       <node oor:name="Visible">
         <prop oor:name="ImpressView">
@@ -48,7 +67,7 @@
         <prop oor:name="DrawView">
           <value>true</value>
         </prop>
-     </node>
+      </node>
     </node>
     <node oor:name="Framework">
       <node oor:name="ResourceFactories">

officecfg/registry/schema/org/openoffice/Office/Impress.xcs

@@ -1393,6 +1393,42 @@
           <desc>Options that control the tool panel.</desc>
           <label>Tool Panel Options</label>
         </info>
+        <group oor:name="Visible">
+          <info>
+            <desc>Options that control the visibility of the ToolPanel.</desc>
+            <label>ToolPanel Visibility</label>
+          </info>
+          <prop oor:name="ImpressView" oor:type="xs:boolean">
+            <info>
+              <desc>Visibility of the ToolPanel in the Impress view.</desc>
+              <label>ToolPanel Visibility ImpressView</label>
+            </info>
+          </prop>
+          <prop oor:name="OutlineView" oor:type="xs:boolean">
+            <info>
+              <desc>Visibility of the ToolPanel in the Outline view.</desc>
+              <label>ToolPanel Visibility OutlineView</label>
+            </info>
+          </prop>
+          <prop oor:name="NotesView" oor:type="xs:boolean">
+            <info>
+              <desc>Visibility of the ToolPanel in the Notes view.</desc>
+              <label>ToolPanel Visibility NotesView</label>
+            </info>
+          </prop>
+          <prop oor:name="HandoutView" oor:type="xs:boolean">
+            <info>
+              <desc>Visibility of the ToolPanel in the HandOut view.</desc>
+              <label>ToolPanel Visibility HandOutView</label>
+            </info>
+          </prop>
+          <prop oor:name="SlideSorterView" oor:type="xs:boolean">
+            <info>
+              <desc>Visibility of the ToolPanel in the SlideSorter view.</desc>
+              <label>ToolPanel Visibility SlideSorterView</label>
+            </info>
+          </prop>
+        </group>
         <set oor:name="RecentlyUsedMasterPages" oor:node-type="MasterPageDescriptor">
           <info>
             <desc>List of the URLs of the most recently used master pages.</desc>

sd/source/ui/framework/module/ImpressModule.cxx

@@ -45,7 +45,9 @@ void ImpressModule::Initialize (Reference<frame::XController>& rxController)
     new SlideSorterModule(
         rxController,
         FrameworkHelper::msLeftImpressPaneURL);
-    ToolPanelModule::Initialize(rxController);
+    new ToolPanelModule(
+        rxController,
+        FrameworkHelper::msRightPaneURL);
     new ToolBarModule(rxController);
     new ShellStackGuard(rxController);
 }

sd/source/ui/framework/module/ToolPanelModule.cxx

@@ -19,136 +19,75 @@
 
 
 #include "ToolPanelModule.hxx"
-#include "ReadOnlyModeObserver.hxx"
-#include "framework/FrameworkHelper.hxx"
 
-#include <com/sun/star/lang/XInitialization.hpp>
-#include <com/sun/star/drawing/framework/XControllerManager.hpp>
+#include "framework/FrameworkHelper.hxx"
+#include <com/sun/star/drawing/framework/XTabBar.hpp>
+#include <com/sun/star/drawing/framework/TabBarButton.hpp>
 
-#include <comphelper/processfactory.hxx>
-#include <cppuhelper/compbase1.hxx>
-#include <boost/enable_shared_from_this.hpp>
+#include "strings.hrc"
+#include "sdresid.hxx"
+#include "svtools/toolpanelopt.hxx"
 
 using namespace ::com::sun::star;
 using namespace ::com::sun::star::uno;
 using namespace ::com::sun::star::drawing::framework;
+
 using ::rtl::OUString;
 using ::sd::framework::FrameworkHelper;
 
 
 namespace sd { namespace framework {
 
-namespace {
-
-typedef ::cppu::WeakComponentImplHelper1 <
-      ::com::sun::star::frame::XStatusListener
-    > LocalReadOnlyModeObserverInterfaceBase;
-
-/** This local class enables or disables the ResourceManager of a
-    ToolPanelModule.  It connects to a ReadOnlyModeObserver and is called
-    when the state of the .uno:EditDoc command changes.  When either the
-    ResourceManager or the ReadOnlyModeObserver are disposed then the
-    LocalReadOnlyModeObserver disposes itself.  The link
-    between the ResourceManager and the ReadOnlyModeObserver is removed and
-    the ReadOnlyModeObserver typically looses its last reference and is
-    destroyed.
-*/
-class LocalReadOnlyModeObserver
-    : private MutexOwner,
-      public LocalReadOnlyModeObserverInterfaceBase
-{
-public:
-    LocalReadOnlyModeObserver (
-        const Reference<frame::XController>& rxController,
-        const ::rtl::Reference<ResourceManager>& rpResourceManager)
-        : MutexOwner(),
-          LocalReadOnlyModeObserverInterfaceBase(maMutex),
-          mpResourceManager(rpResourceManager),
-          mpObserver(new ReadOnlyModeObserver(rxController))
-    {
-        mpObserver->AddStatusListener(this);
 
-        Reference<lang::XComponent> xComponent (
-            static_cast<XWeak*>(mpResourceManager.get()), UNO_QUERY);
-        if (xComponent.is())
-            xComponent->addEventListener(this);
-    }
+//===== ToolPanelModule ==================================================
 
-    ~LocalReadOnlyModeObserver (void)
-    {
-    }
-
-    virtual void SAL_CALL disposing (void)
-    {
-        Reference<lang::XComponent> xComponent (static_cast<XWeak*>(mpObserver.get()), UNO_QUERY);
-        if (xComponent.is())
-            xComponent->dispose();
-
-        xComponent = Reference<lang::XComponent>(
-            static_cast<XWeak*>(mpResourceManager.get()), UNO_QUERY);
-        if (xComponent.is())
-            xComponent->removeEventListener(this);
-
-    }
-
-    virtual void SAL_CALL disposing (const com::sun::star::lang::EventObject& rEvent)
-        throw(RuntimeException)
-    {
-        if (rEvent.Source == Reference<XInterface>(static_cast<XWeak*>(mpObserver.get())))
-        {
-            mpObserver = NULL;
-        }
-        else if (rEvent.Source == Reference<XInterface>(
-            static_cast<XWeak*>(mpResourceManager.get())))
-        {
-            mpResourceManager = NULL;
-        }
-        dispose();
-    }
-
-    virtual void SAL_CALL statusChanged (const com::sun::star::frame::FeatureStateEvent& rEvent)
-        throw(RuntimeException)
+ToolPanelModule::ToolPanelModule (
+    const Reference<frame::XController>& rxController,
+    const OUString& rsRightPaneURL)
+    : ResourceManager(rxController,
+        FrameworkHelper::CreateResourceId(FrameworkHelper::msTaskPaneURL, rsRightPaneURL)),
+      mxControllerManager(rxController,UNO_QUERY)
+{
+    if (mxConfigurationController.is())
     {
-        bool bReadWrite (true);
-        if (rEvent.IsEnabled)
-            rEvent.State >>= bReadWrite;
-
-        if (bReadWrite)
-            mpResourceManager->Enable();
-        else
-            mpResourceManager->Disable();
+        if (SvtToolPanelOptions().GetVisibleImpressView()==sal_True)
+            AddActiveMainView(FrameworkHelper::msImpressViewURL);
+        if (SvtToolPanelOptions().GetVisibleOutlineView()==sal_True)
+            AddActiveMainView(FrameworkHelper::msOutlineViewURL);
+        if (SvtToolPanelOptions().GetVisibleNotesView()==sal_True)
+            AddActiveMainView(FrameworkHelper::msNotesViewURL);
+        if (SvtToolPanelOptions().GetVisibleHandoutView()==sal_True)
+            AddActiveMainView(FrameworkHelper::msHandoutViewURL);
+        if (SvtToolPanelOptions().GetVisibleSlideSorterView()==sal_True)
+            AddActiveMainView(FrameworkHelper::msSlideSorterURL);
+
+        mxConfigurationController->addConfigurationChangeListener(
+            this,
+            FrameworkHelper::msResourceActivationEvent,
+            Any());
     }
-
-private:
-    ::rtl::Reference<ResourceManager> mpResourceManager;
-    ::rtl::Reference<ReadOnlyModeObserver> mpObserver;
-
-};
 }
 
-
-
-
-//===== ToolPanelModule ====================================================
-
-void ToolPanelModule::Initialize (const Reference<frame::XController>& rxController)
+ToolPanelModule::~ToolPanelModule (void)
 {
-    ::rtl::Reference<ResourceManager> pResourceManager (
-        new ResourceManager(
-            rxController,
-            FrameworkHelper::CreateResourceId(
-                FrameworkHelper::msTaskPaneURL,
-                FrameworkHelper::msRightPaneURL)));
-    pResourceManager->AddActiveMainView(FrameworkHelper::msImpressViewURL);
-    pResourceManager->AddActiveMainView(FrameworkHelper::msNotesViewURL);
-    pResourceManager->AddActiveMainView(FrameworkHelper::msHandoutViewURL);
-    pResourceManager->AddActiveMainView(FrameworkHelper::msSlideSorterURL);
-
-    new LocalReadOnlyModeObserver(rxController, pResourceManager);
 }
 
+void ToolPanelModule::SaveResourceState (void)
+{
+    SvtToolPanelOptions().SetVisibleImpressView(IsResourceActive(FrameworkHelper::msImpressViewURL));
+    SvtToolPanelOptions().SetVisibleOutlineView(IsResourceActive(FrameworkHelper::msOutlineViewURL));
+    SvtToolPanelOptions().SetVisibleNotesView(IsResourceActive(FrameworkHelper::msNotesViewURL));
+    SvtToolPanelOptions().SetVisibleHandoutView(IsResourceActive(FrameworkHelper::msHandoutViewURL));
+    SvtToolPanelOptions().SetVisibleSlideSorterView(IsResourceActive(FrameworkHelper::msSlideSorterURL));
+}
 
-
+void SAL_CALL ToolPanelModule::notifyConfigurationChange (
+    const ConfigurationChangeEvent& rEvent)
+    throw (RuntimeException)
+{
+    if (!rEvent.Type.equals(FrameworkHelper::msResourceActivationEvent))
+        ResourceManager::notifyConfigurationChange(rEvent);
+}
 
 } } // end of namespace sd::framework
 

sd/source/ui/framework/module/ToolPanelModule.hxx

@@ -17,22 +17,38 @@
  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  */
 
-#ifndef SD_FRAMEWORK_TOOL_PANEL_MODULE_HXX
-#define SD_FRAMEWORK_TOOL_PANEL_MODULE_HXX
+#ifndef SD_FRAMEWORK_TOOLPANEL_MODULE_HXX
+#define SD_FRAMEWORK_TOOLPANEL_MODULE_HXX
 
 #include "ResourceManager.hxx"
 
-#include <rtl/ref.hxx>
+#include <com/sun/star/drawing/framework/XControllerManager.hpp>
+#include <com/sun/star/drawing/framework/XTabBar.hpp>
+
+namespace css = ::com::sun::star;
 
 namespace sd { namespace framework {
 
-/** This module is responsible for showing the task pane.
+/** This module is responsible for showing the toolpanel bar.
 */
 class ToolPanelModule
+    : public ResourceManager
 {
 public:
-    static void Initialize (
-        const ::com::sun::star::uno::Reference<com::sun::star::frame::XController>& rxController);
+    ToolPanelModule (
+        const css::uno::Reference<css::frame::XController>& rxController,
+        const ::rtl::OUString& rsRightPaneURL);
+    virtual ~ToolPanelModule (void);
+
+    virtual void SaveResourceState (void);
+    // XConfigurationChangeListener
+
+    virtual void SAL_CALL notifyConfigurationChange (
+        const css::drawing::framework::ConfigurationChangeEvent& rEvent)
+        throw (css::uno::RuntimeException);
+
+private:
+    css::uno::Reference<css::drawing::framework::XControllerManager> mxControllerManager;
 };
 
 } } // end of namespace sd::framework

svtools/Library_svt.mk

@@ -90,6 +90,7 @@ $(eval $(call gb_Library_add_exception_objects,svt,\
     svtools/source/config/menuoptions \
     svtools/source/config/miscopt \
     svtools/source/config/slidesorterbaropt \
+    svtools/source/config/toolpanelopt \
     svtools/source/config/optionsdrawinglayer \
     svtools/source/config/printoptions \
     svtools/source/contnr/DocumentInfoPreview \

svtools/Package_inc.mk

@@ -109,6 +109,7 @@ $(eval $(call gb_Package_add_file,svtools_inc,inc/svtools/localresaccess.hxx,svt
 $(eval $(call gb_Package_add_file,svtools_inc,inc/svtools/menuoptions.hxx,svtools/menuoptions.hxx))
 $(eval $(call gb_Package_add_file,svtools_inc,inc/svtools/miscopt.hxx,svtools/miscopt.hxx))
 $(eval $(call gb_Package_add_file,svtools_inc,inc/svtools/slidesorterbaropt.hxx,svtools/slidesorterbaropt.hxx))
+$(eval $(call gb_Package_add_file,svtools_inc,inc/svtools/toolpanelopt.hxx,svtools/toolpanelopt.hxx))
 $(eval $(call gb_Package_add_file,svtools_inc,inc/svtools/optionsdrawinglayer.hxx,svtools/optionsdrawinglayer.hxx))
 $(eval $(call gb_Package_add_file,svtools_inc,inc/svtools/parhtml.hxx,svtools/parhtml.hxx))
 $(eval $(call gb_Package_add_file,svtools_inc,inc/svtools/parrtf.hxx,svtools/parrtf.hxx))

svtools/inc/svtools/toolpanelopt.hxx

+/* -*- 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_SVTOOLS_TOOLPANELOPT_HXX
+#define INCLUDED_SVTOOLS_TOOLPANELOPT_HXX
+
+#include "svtools/svtdllapi.h"
+#include <sal/types.h>
+#include <osl/mutex.hxx>
+#include <com/sun/star/uno/Sequence.h>
+#include <rtl/ustring.hxx>
+#include <unotools/options.hxx>
+
+/** forward declaration to our private date container implementation
+
+    We use these class as internal member to support small memory requirements.
+    You can create the container if it is neccessary. The class which use these mechanism
+    is faster and smaller then a complete implementation!
+*/
+class SvtToolPanelOptions_Impl;
+class Link;
+
+/** collect informations about sidebar group
+
+    \attention This class is partially threadsafe.
+*/
+class SVT_DLLPUBLIC SvtToolPanelOptions: public utl::detail::Options
+{
+    public:
+        /** standard constructor and destructor
+
+            This will initialize an instance with default values.
+            We implement these class with a refcount mechanism! Every instance of this class increase it
+            at create and decrease it at delete time - but all instances use the same data container!
+            He is implemented as a static member ...
+
+            \sa    member m_nRefCount
+            \sa    member m_pDataContainer
+        */
+        SvtToolPanelOptions();
+        virtual ~SvtToolPanelOptions();
+
+        void AddListenerLink( const Link& rLink );
+        void RemoveListenerLink( const Link& rLink );
+
+        bool GetVisibleImpressView() const;
+        void SetVisibleImpressView( bool bVisible );
+        bool GetVisibleOutlineView() const;
+        void SetVisibleOutlineView( bool bVisible );
+        bool GetVisibleNotesView() const;
+        void SetVisibleNotesView( bool bVisible );
+        bool GetVisibleHandoutView() const;
+        void SetVisibleHandoutView( bool bVisible );
+        bool GetVisibleSlideSorterView() const;
+        void SetVisibleSlideSorterView( bool bVisible );
+        bool GetVisibleDrawView() const;
+        void SetVisibleDrawView( bool bVisible );
+
+
+    private:
+        /** return a reference to a static mutex
+
+            These class is partially threadsafe (for de-/initialization only).
+            All access methods are'nt safe!
+            We create a static mutex only for one ime and use at different times.
+
+            \return     A reference to a static mutex member.*/
+        SVT_DLLPRIVATE static ::osl::Mutex& GetInitMutex();
+
+    private:
+
+        /**
+            \attention
+            Don't initialize these static member in these header!
+            \li Double defined symbols will be detected ...
+            \li and unresolved externals exist at linking time.
+            Do it in your source only.
+        */
+        static SvtToolPanelOptions_Impl* m_pDataContainer;   ///< impl. data container as dynamic pointer for smaller memory requirements!
+        static sal_Int32                 m_nRefCount;        ///< internal ref count mechanism
+
+};
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */