Adding upstream version 1:7.0.4.upstream/1%7.0.4upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 413 insertions, 0 deletions

diff --git a/svtools/source/config/menuoptions.cxx b/svtools/source/config/menuoptions.cxx
new file mode 100644
index 000000000..a86bdc6e3
--- /dev/null
+++ b/svtools/source/config/menuoptions.cxx
@@ -0,0 +1,413 @@
+/* -*- 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 .
+ */
+
+#include <svtools/menuoptions.hxx>
+#include <unotools/configitem.hxx>
+#include <tools/debug.hxx>
+#include <com/sun/star/uno/Any.hxx>
+#include <com/sun/star/uno/Sequence.hxx>
+#include <vcl/svapp.hxx>
+#include <vcl/settings.hxx>
+
+#include "itemholder2.hxx"
+
+//  namespaces
+
+using namespace ::utl                   ;
+using namespace ::osl                   ;
+using namespace ::com::sun::star::uno   ;
+
+#define ROOTNODE_MENU                           "Office.Common/View/Menu"
+#define DEFAULT_DONTHIDEDISABLEDENTRIES         false
+#define DEFAULT_FOLLOWMOUSE                     true
+#define DEFAULT_MENUICONS                       TRISTATE_INDET
+#define DEFAULT_CONTEXTMENUSHORTCUTS            TRISTATE_INDET
+
+#define PROPERTYNAME_DONTHIDEDISABLEDENTRIES    "DontHideDisabledEntry"
+#define PROPERTYNAME_FOLLOWMOUSE                "FollowMouse"
+#define PROPERTYNAME_SHOWICONSINMENUES          "ShowIconsInMenues"
+#define PROPERTYNAME_SYSTEMICONSINMENUES        "IsSystemIconsInMenus"
+#define PROPERTYNAME_SHORTCUTSINCONTEXMENU      "ShortcutsInContextMenus"
+
+#define PROPERTYHANDLE_DONTHIDEDISABLEDENTRIES  0
+#define PROPERTYHANDLE_FOLLOWMOUSE              1
+#define PROPERTYHANDLE_SHOWICONSINMENUES        2
+#define PROPERTYHANDLE_SYSTEMICONSINMENUES      3
+#define PROPERTYHANDLE_SHORTCUTSINCONTEXMENU    4
+
+//  private declarations!
+
+class SvtMenuOptions_Impl : public ConfigItem
+{
+
+    //  private member
+
+    private:
+        bool        m_bDontHideDisabledEntries          ;   /// cache "DontHideDisabledEntries" of Menu section
+        bool        m_bFollowMouse                      ;   /// cache "FollowMouse" of Menu section
+        TriState    m_eMenuIcons                        ;   /// cache "MenuIcons" of Menu section
+        TriState    m_eContextMenuShortcuts             ;   /// cache "ShortcutsInContextMenus" of Menu section
+
+    //  public methods
+
+    public:
+
+        //  constructor / destructor
+
+         SvtMenuOptions_Impl();
+        virtual ~SvtMenuOptions_Impl() override;
+
+        //  override methods of baseclass
+
+        /*-****************************************************************************************************
+            @short      called for notify of configmanager
+            @descr      This method is called from the ConfigManager before application ends or from the
+                        PropertyChangeListener if the sub tree broadcasts changes. You must update your
+                        internal values.
+
+            @seealso    baseclass ConfigItem
+
+            @param      "seqPropertyNames" is the list of properties which should be updated.
+        *//*-*****************************************************************************************************/
+
+        virtual void Notify( const Sequence< OUString >& seqPropertyNames ) override;
+
+        //  public interface
+
+        /*-****************************************************************************************************
+            @short      access method to get internal values
+            @descr      These methods give us a chance to regulate access to our internal values.
+                        It's not used at the moment - but it's possible for the future!
+        *//*-*****************************************************************************************************/
+
+        bool        IsEntryHidingEnabled() const
+                    { return m_bDontHideDisabledEntries; }
+
+        TriState    GetMenuIconsState() const
+                    { return m_eMenuIcons; }
+
+        void        SetMenuIconsState(TriState eState)
+                    {
+                        m_eMenuIcons = eState;
+                        SetModified();
+                        // tdf#93451: don't Commit() here, it's too early
+                    }
+
+        TriState    GetContextMenuShortcuts() const
+                    { return m_eContextMenuShortcuts; }
+
+        void        SetContextMenuShortcuts(TriState eState)
+                    {
+                        m_eContextMenuShortcuts = eState;
+                        SetModified();
+                        Commit();
+                    }
+
+    //  private methods
+
+    private:
+
+        virtual void ImplCommit() override;
+
+        /*-****************************************************************************************************
+            @short      return list of fix key names of our configuration management which represent our module tree
+            @descr      This method returns a static const list of key names. We need it to get needed values from our
+                        configuration management.
+            @return     A list of needed configuration keys is returned.
+        *//*-*****************************************************************************************************/
+
+        static Sequence< OUString > const & impl_GetPropertyNames();
+};
+
+//  constructor
+
+SvtMenuOptions_Impl::SvtMenuOptions_Impl()
+    // Init baseclasses first
+    :   ConfigItem                  ( ROOTNODE_MENU                     )
+    // Init member then.
+    ,   m_bDontHideDisabledEntries  ( DEFAULT_DONTHIDEDISABLEDENTRIES   )
+    ,   m_bFollowMouse              ( DEFAULT_FOLLOWMOUSE               )
+    ,   m_eMenuIcons                ( DEFAULT_MENUICONS                 )
+    ,   m_eContextMenuShortcuts     ( DEFAULT_CONTEXTMENUSHORTCUTS      )
+{
+    // Use our static list of configuration keys to get his values.
+    Sequence< OUString >    seqNames    = impl_GetPropertyNames();
+    Sequence< Any >         seqValues   = GetProperties( seqNames ) ;
+
+    // Safe impossible cases.
+    // We need values from ALL configuration keys.
+    // Follow assignment use order of values in relation to our list of key names!
+    DBG_ASSERT( !(seqNames.getLength()!=seqValues.getLength()), "SvtMenuOptions_Impl::SvtMenuOptions_Impl()\nI miss some values of configuration keys!\n" );
+
+    bool bMenuIcons = true;
+    bool bSystemMenuIcons = true;
+    if (m_eMenuIcons == TRISTATE_INDET)
+        bMenuIcons = Application::GetSettings().GetStyleSettings().GetPreferredUseImagesInMenus();
+    else
+    {
+        bSystemMenuIcons = false;
+        bMenuIcons = m_eMenuIcons != TRISTATE_FALSE;
+    }
+
+    // Copy values from list in right order to our internal member.
+    sal_Int32 nPropertyCount    =   seqValues.getLength()   ;
+    sal_Int32 nProperty         =   0                       ;
+    for( nProperty=0; nProperty<nPropertyCount; ++nProperty )
+    {
+        // Safe impossible cases.
+        // Check any for valid value.
+        DBG_ASSERT( seqValues[nProperty].hasValue(), "SvtMenuOptions_Impl::SvtMenuOptions_Impl()\nInvalid property value for property detected!\n" );
+
+        if (!seqValues[nProperty].hasValue())
+            continue;
+
+        switch( nProperty )
+        {
+            case PROPERTYHANDLE_DONTHIDEDISABLEDENTRIES :   {
+                                                                DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_BOOLEAN), "SvtMenuOptions_Impl::SvtMenuOptions_Impl()\nWho has changed the value type of \"Office.Common\\View\\Menu\\DontHideDisabledEntry\"?" );
+                                                                seqValues[nProperty] >>= m_bDontHideDisabledEntries;
+                                                            }
+                                                            break;
+
+            case PROPERTYHANDLE_FOLLOWMOUSE             :   {
+                                                                DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_BOOLEAN), "SvtMenuOptions_Impl::SvtMenuOptions_Impl()\nWho has changed the value type of \"Office.Common\\View\\Menu\\FollowMouse\"?" );
+                                                                seqValues[nProperty] >>= m_bFollowMouse;
+                                                            }
+                                                            break;
+            case PROPERTYHANDLE_SHOWICONSINMENUES       :   {
+                                                                DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_BOOLEAN), "SvtMenuOptions_Impl::SvtMenuOptions_Impl()\nWho has changed the value type of \"Office.Common\\View\\Menu\\ShowIconsInMenues\"?" );
+                                                                seqValues[nProperty] >>= bMenuIcons;
+                                                            }
+                                                            break;
+            case PROPERTYHANDLE_SYSTEMICONSINMENUES     :   {
+                                                                DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_BOOLEAN), "SvtMenuOptions_Impl::SvtMenuOptions_Impl()\nWho has changed the value type of \"Office.Common\\View\\Menu\\IsSystemIconsInMenus\"?" );
+                                                                seqValues[nProperty] >>= bSystemMenuIcons;
+                                                            }
+                                                            break;
+            case PROPERTYHANDLE_SHORTCUTSINCONTEXMENU   :   {
+                                                                DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_SHORT), "SvtMenuOptions_Impl::SvtMenuOptions_Impl()\nWho has changed the value type of \"Office.Common\\View\\Menu\\ShortcutsInContextMenus\"?" );
+                                                                sal_Int16 nContextMenuShortcuts;
+                                                                if ( seqValues[nProperty] >>= nContextMenuShortcuts )
+                                                                    m_eContextMenuShortcuts = static_cast<TriState>(nContextMenuShortcuts);
+                                                            }
+                                                            break;
+        }
+    }
+
+    m_eMenuIcons = bSystemMenuIcons ? TRISTATE_INDET : static_cast<TriState>(bMenuIcons);
+
+    EnableNotification( seqNames );
+}
+
+//  destructor
+
+SvtMenuOptions_Impl::~SvtMenuOptions_Impl()
+{
+    assert(!IsModified()); // should have been committed
+}
+
+//  public method
+
+void SvtMenuOptions_Impl::Notify( const Sequence< OUString >& seqPropertyNames )
+{
+    // Use given list of updated properties to get his values from configuration directly!
+    Sequence< Any > seqValues = GetProperties( seqPropertyNames );
+    // Safe impossible cases.
+    // We need values from ALL notified configuration keys.
+    DBG_ASSERT( !(seqPropertyNames.getLength()!=seqValues.getLength()), "SvtMenuOptions_Impl::Notify()\nI miss some values of configuration keys!\n" );
+
+    bool bMenuSettingsChanged = false;
+    bool bMenuIcons = true;
+    bool bSystemMenuIcons = true;
+    if (m_eMenuIcons == TRISTATE_INDET)
+        bMenuIcons = Application::GetSettings().GetStyleSettings().GetUseImagesInMenus();
+    else
+    {
+        bSystemMenuIcons = false;
+        bMenuIcons = m_eMenuIcons != TRISTATE_FALSE;
+    }
+
+    // Step over list of property names and get right value from coreesponding value list to set it on internal members!
+    sal_Int32 nCount = seqPropertyNames.getLength();
+    for( sal_Int32 nProperty=0; nProperty<nCount; ++nProperty )
+    {
+        if( seqPropertyNames[nProperty] == PROPERTYNAME_DONTHIDEDISABLEDENTRIES )
+        {
+            DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_BOOLEAN), "SvtMenuOptions_Impl::Notify()\nWho has changed the value type of \"Office.Common\\View\\Menu\\DontHideDisabledEntry\"?" );
+            seqValues[nProperty] >>= m_bDontHideDisabledEntries;
+        }
+        else if( seqPropertyNames[nProperty] == PROPERTYNAME_FOLLOWMOUSE )
+        {
+            DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_BOOLEAN), "SvtMenuOptions_Impl::Notify()\nWho has changed the value type of \"Office.Common\\View\\Menu\\FollowMouse\"?" );
+            seqValues[nProperty] >>= m_bFollowMouse;
+        }
+        else if( seqPropertyNames[nProperty] == PROPERTYNAME_SHOWICONSINMENUES )
+        {
+            DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_BOOLEAN), "SvtMenuOptions_Impl::SvtMenuOptions_Impl()\nWho has changed the value type of \"Office.Common\\View\\Menu\\ShowIconsInMenues\"?" );
+            bMenuSettingsChanged |= seqValues[nProperty] >>= bMenuIcons;
+        }
+        else if( seqPropertyNames[nProperty] == PROPERTYNAME_SYSTEMICONSINMENUES )
+        {
+            DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_BOOLEAN), "SvtMenuOptions_Impl::SvtMenuOptions_Impl()\nWho has changed the value type of \"Office.Common\\View\\Menu\\IsSystemIconsInMenus\"?" );
+            bMenuSettingsChanged |= seqValues[nProperty] >>= bSystemMenuIcons;
+        }
+        else if( seqPropertyNames[nProperty] == PROPERTYNAME_SHORTCUTSINCONTEXMENU )
+        {
+            DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_SHORT), "SvtMenuOptions_Impl::SvtMenuOptions_Impl()\nWho has changed the value type of \"Office.Common\\View\\Menu\\ShortcutsInContextMenus\"?" );
+            sal_Int16 nContextMenuShortcuts;
+            if ( seqValues[nProperty] >>= nContextMenuShortcuts )
+                m_eContextMenuShortcuts = static_cast<TriState>(nContextMenuShortcuts);
+        }
+        else assert( false && "SvtMenuOptions_Impl::Notify()\nUnknown property detected ... I can't handle these!" );
+    }
+
+    if ( bMenuSettingsChanged )
+        m_eMenuIcons = bSystemMenuIcons ? TRISTATE_INDET : static_cast<TriState>(bMenuIcons);
+}
+
+//  public method
+
+void SvtMenuOptions_Impl::ImplCommit()
+{
+    // Get names of supported properties, create a list for values and copy current values to it.
+    Sequence< OUString >    seqNames    = impl_GetPropertyNames();
+    sal_Int32               nCount      = seqNames.getLength();
+    Sequence< Any >         seqValues   ( nCount );
+    for( sal_Int32 nProperty=0; nProperty<nCount; ++nProperty )
+    {
+        switch( nProperty )
+        {
+            case PROPERTYHANDLE_DONTHIDEDISABLEDENTRIES :   {
+                                                                seqValues[nProperty] <<= m_bDontHideDisabledEntries;
+                                                            }
+                                                            break;
+
+            case PROPERTYHANDLE_FOLLOWMOUSE             :   {
+                                                                seqValues[nProperty] <<= m_bFollowMouse;
+                                                            }
+                                                            break;
+            //Output cache of current setting as possibly modified by System Theme for older version
+            case PROPERTYHANDLE_SHOWICONSINMENUES       :   {
+                                                                bool bValue = Application::GetSettings().GetStyleSettings().GetUseImagesInMenus();
+                                                                seqValues[nProperty] <<= bValue;
+                                                            }
+                                                            break;
+            case PROPERTYHANDLE_SYSTEMICONSINMENUES     :   {
+                                                                bool bValue = m_eMenuIcons == TRISTATE_INDET;
+                                                                seqValues[nProperty] <<= bValue;
+                                                            }
+                                                            break;
+            case PROPERTYHANDLE_SHORTCUTSINCONTEXMENU   :   {
+                                                                seqValues[nProperty] <<= static_cast<sal_Int16>(m_eContextMenuShortcuts);
+                                                            }
+                                                            break;
+        }
+    }
+    // Set properties in configuration.
+    PutProperties( seqNames, seqValues );
+}
+
+//  private method
+
+Sequence< OUString > const & SvtMenuOptions_Impl::impl_GetPropertyNames()
+{
+    static const Sequence<OUString> seqPropertyNames {
+        OUString(PROPERTYNAME_DONTHIDEDISABLEDENTRIES)    ,
+        OUString(PROPERTYNAME_FOLLOWMOUSE)                ,
+        OUString(PROPERTYNAME_SHOWICONSINMENUES)          ,
+        OUString(PROPERTYNAME_SYSTEMICONSINMENUES)        ,
+        OUString(PROPERTYNAME_SHORTCUTSINCONTEXMENU)
+    };
+    return seqPropertyNames;
+}
+
+namespace {
+
+std::weak_ptr<SvtMenuOptions_Impl> g_pMenuOptions;
+
+}
+
+SvtMenuOptions::SvtMenuOptions()
+{
+    // Global access, must be guarded (multithreading!).
+    MutexGuard aGuard( GetOwnStaticMutex() );
+
+    m_pImpl = g_pMenuOptions.lock();
+    if( !m_pImpl )
+    {
+        m_pImpl = std::make_shared<SvtMenuOptions_Impl>();
+        g_pMenuOptions = m_pImpl;
+        svtools::ItemHolder2::holdConfigItem(EItem::MenuOptions);
+    }
+}
+
+SvtMenuOptions::~SvtMenuOptions()
+{
+    // Global access, must be guarded (multithreading!)
+    MutexGuard aGuard( GetOwnStaticMutex() );
+
+    m_pImpl.reset();
+}
+
+//  public method
+
+bool SvtMenuOptions::IsEntryHidingEnabled() const
+{
+    MutexGuard aGuard( GetOwnStaticMutex() );
+    return m_pImpl->IsEntryHidingEnabled();
+}
+
+//  public method
+
+TriState SvtMenuOptions::GetMenuIconsState() const
+{
+    MutexGuard aGuard( GetOwnStaticMutex() );
+    return m_pImpl->GetMenuIconsState();
+}
+
+//  public method
+
+void SvtMenuOptions::SetMenuIconsState(TriState eState)
+{
+    MutexGuard aGuard( GetOwnStaticMutex() );
+    m_pImpl->SetMenuIconsState(eState);
+}
+
+TriState SvtMenuOptions::GetContextMenuShortcuts() const
+{
+    MutexGuard aGuard( GetOwnStaticMutex() );
+    return m_pImpl->GetContextMenuShortcuts();
+}
+
+void SvtMenuOptions::SetContextMenuShortcuts(TriState eState)
+{
+    MutexGuard aGuard( GetOwnStaticMutex() );
+    m_pImpl->SetContextMenuShortcuts(eState);
+}
+
+//  private method
+
+Mutex& SvtMenuOptions::GetOwnStaticMutex()
+{
+    static Mutex ourMutex;
+
+    return ourMutex;
+}
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */