svtools/source/config/miscopt.cxx

   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
  20 #include <svtools/miscopt.hxx>
  21 #include <unotools/configitem.hxx>
  22 #include <tools/debug.hxx>
  23 #include <com/sun/star/uno/Any.hxx>
  24 #include <com/sun/star/uno/Sequence.hxx>
  25 #include <comphelper/sequence.hxx>
  26 #include <tools/link.hxx>
  27 #include <osl/diagnose.h>
  28
  29 #include <rtl/instance.hxx>
  30 #include "itemholder2.hxx"
  31
  32 #include <svtools/imgdef.hxx>
  33 #include <vcl/svapp.hxx>
  34 #include <vcl/settings.hxx>
  35 #include <vcl/toolbox.hxx>
  36
  37 #include <vector>
  38
  39 using namespace ::utl                   ;
  40 using namespace ::osl                   ;
  41 using namespace ::com::sun::star::uno   ;
  42 using namespace ::com::sun::star;
  43
  44 #define ROOTNODE_MISC                       "Office.Common/Misc"
  45
  46 // PROPERTYHANDLE defines must be sequential from zero for Commit/Load
  47 #define PROPERTYNAME_SYMBOLSET              "SymbolSet"
  48 #define PROPERTYHANDLE_SYMBOLSET                0
  49 #define PROPERTYNAME_ICONTHEME              "SymbolStyle"
  50 #define PROPERTYHANDLE_SYMBOLSTYLE              1
  51 #define PROPERTYNAME_DISABLEUICUSTOMIZATION "DisableUICustomization"
  52 #define PROPERTYHANDLE_DISABLEUICUSTOMIZATION   2
  53 #define PROPERTYNAME_SIDEBARICONSIZE        "SidebarIconSize"
  54 #define PROPERTYHANDLE_SIDEBARICONSIZE          3
  55 #define PROPERTYNAME_NOTEBOOKBARICONSIZE    "NotebookbarIconSize"
  56 #define PROPERTYHANDLE_NOTEBOOKBARICONSIZE      4
  57
  58 class SvtMiscOptions_Impl : public ConfigItem
  59 {
  60 private:
  61     ::std::vector<Link<LinkParamNone*,void>> aList;
  62     sal_Int16   m_nSymbolsSize;
  63     bool        m_bIsSymbolsSizeRO;
  64     ToolBoxButtonSize m_nSidebarIconSize;
  65     bool        m_bIsSidebarIconSizeRO;
  66     ToolBoxButtonSize m_nNotebookbarIconSize;
  67     bool        m_bIsNotebookbarIconSizeRO;
  68     bool        m_bIsSymbolsStyleRO;
  69     bool        m_bDisableUICustomization;
  70     bool        m_bIconThemeWasSetAutomatically;
  71
  72         virtual void ImplCommit() override;
  73
  74 public:
  75
  76          SvtMiscOptions_Impl();
  77         virtual ~SvtMiscOptions_Impl() override;
  78
  79         /*-****************************************************************************************************
  80             @short      called for notify of configmanager
  81             @descr      This method is called from the ConfigManager before the application ends or from the
  82                         PropertyChangeListener if the sub tree broadcasts changes. You must update your
  83                         internal values.
  84
  85             @seealso    baseclass ConfigItem
  86
  87             @param      "seqPropertyNames" is the list of properties which should be updated.
  88         *//*-*****************************************************************************************************/
  89
  90         virtual void Notify( const Sequence< OUString >& seqPropertyNames ) override;
  91
  92         /** loads required data from the configuration. It's called in the constructor to
  93          read all entries and form ::Notify to re-read changed settings
  94
  95          */
  96         void Load( const Sequence< OUString >& rPropertyNames );
  97
  98         //  public interface
  99
 100         bool DisableUICustomization() const
 101         { return m_bDisableUICustomization; }
 102
 103         sal_Int16 GetSymbolsSize() const
 104         { return m_nSymbolsSize; }
 105
 106         ToolBoxButtonSize GetSidebarIconSize() const
 107         { return m_nSidebarIconSize; }
 108
 109         ToolBoxButtonSize GetNotebookbarIconSize() const
 110         { return m_nNotebookbarIconSize; }
 111
 112         void SetSymbolsSize( sal_Int16 nSet );
 113
 114         void SetSidebarIconSize( ToolBoxButtonSize nSet );
 115
 116         void SetNotebookbarIconSize( ToolBoxButtonSize nSet );
 117
 118         static OUString GetIconTheme();
 119
 120         enum class SetModifiedFlag { SET, DONT_SET };
 121
 122         /** Set the icon theme
 123          *
 124          * @param theme
 125          * The name of the icon theme to use.
 126          *
 127          * @param setModified
 128          * Whether to call SetModified() and CallListeners().
 129          *
 130          * @internal
 131          * The @p setModified flag was introduced because the unittests fail if we call SetModified()
 132          * during initialization in the constructor.
 133          */
 134         void
 135         SetIconTheme(const OUString &theme, SetModifiedFlag setModified );
 136
 137         bool IconThemeWasSetAutomatically()
 138         {return m_bIconThemeWasSetAutomatically;}
 139
 140         void AddListenerLink( const Link<LinkParamNone*,void>& rLink );
 141         void RemoveListenerLink( const Link<LinkParamNone*,void>& rLink );
 142         void CallListeners();
 143
 144
 145     //  private methods
 146
 147
 148 private:
 149
 150         /*-****************************************************************************************************
 151             @short      return list of key names of our configuration management which represent our module tree
 152             @descr      These methods return a static const list of key names. We need it to get needed values from our
 153                         configuration management.
 154             @return     A list of needed configuration keys is returned.
 155         *//*-*****************************************************************************************************/
 156
 157         static Sequence< OUString > GetPropertyNames();
 158 };
 159
 160
 161 //  constructor
 162
 163 SvtMiscOptions_Impl::SvtMiscOptions_Impl()
 164     // Init baseclasses first
 165     : ConfigItem( ROOTNODE_MISC )
 166
 167     , m_nSymbolsSize( 0 )
 168     , m_bIsSymbolsSizeRO( false )
 169     , m_nSidebarIconSize( ToolBoxButtonSize::DontCare )
 170     , m_bIsSidebarIconSizeRO( false )
 171     , m_nNotebookbarIconSize( ToolBoxButtonSize::DontCare )
 172     , m_bIsNotebookbarIconSizeRO( false )
 173     , m_bIsSymbolsStyleRO( false )
 174     , m_bIconThemeWasSetAutomatically( false )
 175 {
 176     // Use our static list of configuration keys to get his values.
 177     Sequence< OUString >    seqNames    = GetPropertyNames  (           );
 178     Load( seqNames );
 179     Sequence< Any >         seqValues   = GetProperties     ( seqNames  );
 180     Sequence< sal_Bool >    seqRO       = GetReadOnlyStates ( seqNames  );
 181
 182     // Safe impossible cases.
 183     // We need values from ALL configuration keys.
 184     // Follow assignment use order of values in relation to our list of key names!
 185     DBG_ASSERT( !(seqNames.getLength()!=seqValues.getLength()), "SvtMiscOptions_Impl::SvtMiscOptions_Impl()\nI miss some values of configuration keys!\n" );
 186
 187     // Copy values from list in right order to our internal member.
 188     sal_Int32 nPropertyCount = seqValues.getLength();
 189     for( sal_Int32 nProperty=0; nProperty<nPropertyCount; ++nProperty )
 190     {
 191         if (!seqValues[nProperty].hasValue())
 192             continue;
 193         switch( nProperty )
 194         {
 195             case PROPERTYHANDLE_SYMBOLSET :
 196             {
 197                 if( !(seqValues[nProperty] >>= m_nSymbolsSize) )
 198                 {
 199                     OSL_FAIL("Wrong type of \"Misc\\SymbolSet\"!" );
 200                 }
 201                 m_bIsSymbolsSizeRO = seqRO[nProperty];
 202                 break;
 203             }
 204
 205             case PROPERTYHANDLE_SIDEBARICONSIZE :
 206             {
 207                 sal_uInt16 nTmp;
 208                 if( !(seqValues[nProperty] >>= nTmp) )
 209                 {
 210                     OSL_FAIL("Wrong type of \"Misc\\SidebarIconSize\"!" );
 211                 } else
 212                     m_nSidebarIconSize = static_cast<ToolBoxButtonSize>(nTmp);
 213                 m_bIsSidebarIconSizeRO = seqRO[nProperty];
 214                 break;
 215             }
 216
 217             case PROPERTYHANDLE_NOTEBOOKBARICONSIZE :
 218             {
 219                 sal_uInt16 nTmp;
 220                 if( !(seqValues[nProperty] >>= nTmp) )
 221                 {
 222                     OSL_FAIL("Wrong type of \"Misc\\NotebookbarIconSize\"!" );
 223                 } else
 224                     m_nNotebookbarIconSize = static_cast<ToolBoxButtonSize>(nTmp);
 225                 m_bIsNotebookbarIconSizeRO = seqRO[nProperty];
 226                 break;
 227             }
 228
 229             case PROPERTYHANDLE_SYMBOLSTYLE :
 230             {
 231                 OUString aIconTheme;
 232                 if (seqValues[nProperty] >>= aIconTheme)
 233                     SetIconTheme(aIconTheme, SetModifiedFlag::DONT_SET);
 234                 else
 235                     OSL_FAIL("Wrong type of \"Misc\\SymbolStyle\"!" );
 236
 237                 m_bIsSymbolsStyleRO = seqRO[nProperty];
 238                 break;
 239             }
 240
 241             case PROPERTYHANDLE_DISABLEUICUSTOMIZATION :
 242             {
 243                 if( !(seqValues[nProperty] >>= m_bDisableUICustomization) )
 244                     OSL_FAIL("Wrong type of \"Misc\\DisableUICustomization\"!" );
 245                 break;
 246             }
 247         }
 248     }
 249
 250     // Enable notification mechanism of our baseclass.
 251     // We need it to get information about changes outside these class on our used configuration keys!
 252     EnableNotification( seqNames );
 253 }
 254
 255
 256 //  destructor
 257
 258 SvtMiscOptions_Impl::~SvtMiscOptions_Impl()
 259 {
 260     assert(!IsModified()); // should have been committed
 261 }
 262
 263 void SvtMiscOptions_Impl::Load( const Sequence< OUString >& rPropertyNames )
 264 {
 265     const uno::Sequence< OUString> aInternalPropertyNames( GetPropertyNames());
 266     Sequence< Any > seqValues = GetProperties( rPropertyNames  );
 267
 268     // Safe impossible cases.
 269     // We need values from ALL configuration keys.
 270     // Follow assignment use order of values in relation to our list of key names!
 271     DBG_ASSERT( !(rPropertyNames.getLength()!=seqValues.getLength()), "SvtSecurityOptions_Impl::SvtSecurityOptions_Impl()\nI miss some values of configuration keys!\n" );
 272
 273     // Copy values from list in right order to our internal member.
 274     sal_Int32 nPropertyCount = seqValues.getLength();
 275     for( sal_Int32 nProperty=0; nProperty<nPropertyCount; ++nProperty )
 276     {
 277         if (!seqValues[nProperty].hasValue())
 278             continue;
 279         switch( comphelper::findValue(aInternalPropertyNames, rPropertyNames[nProperty]) )
 280         {
 281             case PROPERTYHANDLE_SYMBOLSET           :   {
 282                                                             if( !(seqValues[nProperty] >>= m_nSymbolsSize) )
 283                                                             {
 284                                                                 OSL_FAIL("Wrong type of \"Misc\\SymbolSet\"!" );
 285                                                             }
 286                                                         }
 287                                                     break;
 288             case PROPERTYHANDLE_SIDEBARICONSIZE     :   {
 289                                                             sal_uInt16 nTmp;
 290                                                             if( !(seqValues[nProperty] >>= nTmp) )
 291                                                             {
 292                                                                 OSL_FAIL("Wrong type of \"Misc\\SidebarIconSize\"!" );
 293                                                             } else
 294                                                                 m_nSidebarIconSize = static_cast<ToolBoxButtonSize>(nTmp);
 295                                                         }
 296                                                     break;
 297             case PROPERTYHANDLE_NOTEBOOKBARICONSIZE     :   {
 298                                                             sal_uInt16 nTmp;
 299                                                             if( !(seqValues[nProperty] >>= nTmp ) )
 300                                                             {
 301                                                                 OSL_FAIL("Wrong type of \"Misc\\NotebookbarIconSize\"!" );
 302                                                             } else
 303                                                                 m_nNotebookbarIconSize = static_cast<ToolBoxButtonSize>(nTmp);
 304                                                         }
 305                                                     break;
 306             case PROPERTYHANDLE_SYMBOLSTYLE         :   {
 307                                                             OUString aIconTheme;
 308                                                             if (seqValues[nProperty] >>= aIconTheme)
 309                                                                 SetIconTheme(aIconTheme, SetModifiedFlag::DONT_SET);
 310                                                             else
 311                                                                 OSL_FAIL("Wrong type of \"Misc\\SymbolStyle\"!" );
 312                                                         }
 313                                                     break;
 314             case PROPERTYHANDLE_DISABLEUICUSTOMIZATION      :   {
 315                                                             if( !(seqValues[nProperty] >>= m_bDisableUICustomization) )
 316                                                                 OSL_FAIL("Wrong type of \"Misc\\DisableUICustomization\"!" );
 317                                                         }
 318                                                     break;
 319         }
 320     }
 321 }
 322
 323 void SvtMiscOptions_Impl::AddListenerLink( const Link<LinkParamNone*,void>& rLink )
 324 {
 325     aList.push_back( rLink );
 326 }
 327
 328 void SvtMiscOptions_Impl::RemoveListenerLink( const Link<LinkParamNone*,void>& rLink )
 329 {
 330     aList.erase(std::remove(aList.begin(), aList.end(), rLink), aList.end());
 331 }
 332
 333 void SvtMiscOptions_Impl::CallListeners()
 334 {
 335     for (auto const& elem : aList)
 336         elem.Call( nullptr );
 337 }
 338
 339 void SvtMiscOptions_Impl::SetSymbolsSize( sal_Int16 nSet )
 340 {
 341     m_nSymbolsSize = nSet;
 342     SetModified();
 343     CallListeners();
 344 }
 345
 346 void SvtMiscOptions_Impl::SetSidebarIconSize( ToolBoxButtonSize nSet )
 347 {
 348     m_nSidebarIconSize = nSet;
 349     SetModified();
 350     CallListeners();
 351 }
 352
 353 void SvtMiscOptions_Impl::SetNotebookbarIconSize( ToolBoxButtonSize nSet )
 354 {
 355     m_nNotebookbarIconSize = nSet;
 356     SetModified();
 357     CallListeners();
 358 }
 359
 360 OUString SvtMiscOptions_Impl::GetIconTheme()
 361 {
 362     return Application::GetSettings().GetStyleSettings().DetermineIconTheme();
 363 }
 364
 365 void
 366 SvtMiscOptions_Impl::SetIconTheme(const OUString &rName, SetModifiedFlag setModified)
 367 {
 368     OUString aTheme(rName);
 369     if (aTheme.isEmpty() || aTheme == "auto")
 370     {
 371         aTheme = Application::GetSettings().GetStyleSettings().GetAutomaticallyChosenIconTheme();
 372         m_bIconThemeWasSetAutomatically = true;
 373     }
 374     else
 375         m_bIconThemeWasSetAutomatically = false;
 376
 377     AllSettings aAllSettings = Application::GetSettings();
 378     StyleSettings aStyleSettings = aAllSettings.GetStyleSettings();
 379     aStyleSettings.SetIconTheme(aTheme);
 380
 381     aAllSettings.SetStyleSettings(aStyleSettings);
 382     Application::MergeSystemSettings( aAllSettings );
 383     Application::SetSettings(aAllSettings);
 384
 385     if (setModified == SetModifiedFlag::SET) {
 386         SetModified();
 387     }
 388     CallListeners();
 389 }
 390
 391
 392 //  public method
 393
 394 void SvtMiscOptions_Impl::Notify( const Sequence< OUString >& rPropertyNames )
 395 {
 396     Load( rPropertyNames );
 397     CallListeners();
 398 }
 399
 400
 401 //  public method
 402
 403 void SvtMiscOptions_Impl::ImplCommit()
 404 {
 405     // Get names of supported properties, create a list for values and copy current values to it.
 406     Sequence< OUString >    seqNames    = GetPropertyNames  ();
 407     sal_Int32               nCount      = seqNames.getLength();
 408     Sequence< Any >         seqValues   ( nCount );
 409     for( sal_Int32 nProperty=0; nProperty<nCount; ++nProperty )
 410     {
 411         switch( nProperty )
 412         {
 413             case PROPERTYHANDLE_SYMBOLSET :
 414             {
 415                 if ( !m_bIsSymbolsSizeRO )
 416                    seqValues[nProperty] <<= m_nSymbolsSize;
 417                 break;
 418             }
 419
 420             case PROPERTYHANDLE_SIDEBARICONSIZE :
 421             {
 422                 if ( !m_bIsSidebarIconSizeRO )
 423                    seqValues[nProperty] <<= static_cast<sal_uInt16>(m_nSidebarIconSize);
 424                 break;
 425             }
 426
 427             case PROPERTYHANDLE_NOTEBOOKBARICONSIZE :
 428             {
 429                 if ( !m_bIsNotebookbarIconSizeRO )
 430                    seqValues[nProperty] <<= static_cast<sal_uInt16>(m_nNotebookbarIconSize);
 431                 break;
 432             }
 433
 434             case PROPERTYHANDLE_SYMBOLSTYLE :
 435             {
 436                 if ( !m_bIsSymbolsStyleRO ) {
 437                     OUString value;
 438                     if (m_bIconThemeWasSetAutomatically) {
 439                         value = "auto";
 440                     }
 441                     else {
 442                         value = GetIconTheme();
 443                     }
 444                     seqValues[nProperty] <<= value;
 445                 }
 446                 break;
 447             }
 448
 449             case PROPERTYHANDLE_DISABLEUICUSTOMIZATION :
 450             {
 451                 seqValues[nProperty] <<= m_bDisableUICustomization;
 452                 break;
 453             }
 454         }
 455     }
 456     // Set properties in configuration.
 457     PutProperties( seqNames, seqValues );
 458 }
 459
 460
 461 //  private method
 462
 463 Sequence< OUString > SvtMiscOptions_Impl::GetPropertyNames()
 464 {
 465     return Sequence<OUString>
 466     {
 467         PROPERTYNAME_SYMBOLSET,
 468         PROPERTYNAME_ICONTHEME,
 469         PROPERTYNAME_DISABLEUICUSTOMIZATION,
 470         PROPERTYNAME_SIDEBARICONSIZE,
 471         PROPERTYNAME_NOTEBOOKBARICONSIZE
 472     };
 473 }
 474
 475 namespace {
 476
 477 std::weak_ptr<SvtMiscOptions_Impl> g_pMiscOptions;
 478
 479 }
 480
 481 SvtMiscOptions::SvtMiscOptions()
 482 {
 483     // Global access, must be guarded (multithreading!).
 484     MutexGuard aGuard( GetInitMutex() );
 485
 486     m_pImpl = g_pMiscOptions.lock();
 487     if( !m_pImpl )
 488     {
 489         m_pImpl = std::make_shared<SvtMiscOptions_Impl>();
 490         g_pMiscOptions = m_pImpl;
 491         svtools::ItemHolder2::holdConfigItem(EItem::MiscOptions);
 492     }
 493 }
 494
 495 SvtMiscOptions::~SvtMiscOptions()
 496 {
 497     // Global access, must be guarded (multithreading!)
 498     MutexGuard aGuard( GetInitMutex() );
 499
 500     m_pImpl.reset();
 501 }
 502
 503
 504 sal_Int16 SvtMiscOptions::GetSymbolsSize() const
 505 {
 506     return m_pImpl->GetSymbolsSize();
 507 }
 508
 509 void SvtMiscOptions::SetSymbolsSize( sal_Int16 nSet )
 510 {
 511     m_pImpl->SetSymbolsSize( nSet );
 512 }
 513
 514 ToolBoxButtonSize SvtMiscOptions::GetSidebarIconSize() const
 515 {
 516     return m_pImpl->GetSidebarIconSize();
 517 }
 518
 519 ToolBoxButtonSize SvtMiscOptions::GetNotebookbarIconSize() const
 520 {
 521     return m_pImpl->GetNotebookbarIconSize();
 522 }
 523
 524 void SvtMiscOptions::SetSidebarIconSize( ToolBoxButtonSize nSet )
 525 {
 526     m_pImpl->SetSidebarIconSize( nSet );
 527 }
 528
 529 void SvtMiscOptions::SetNotebookbarIconSize( ToolBoxButtonSize nSet )
 530 {
 531     m_pImpl->SetNotebookbarIconSize( nSet );
 532 }
 533
 534 sal_Int16 SvtMiscOptions::GetCurrentSymbolsSize() const
 535 {
 536     sal_Int16 eOptSymbolsSize = m_pImpl->GetSymbolsSize();
 537
 538     if ( eOptSymbolsSize == SFX_SYMBOLS_SIZE_AUTO )
 539     {
 540         // Use system settings, we have to retrieve the toolbar icon size from the
 541         // Application class
 542         ToolbarIconSize nStyleIconSize = Application::GetSettings().GetStyleSettings().GetToolbarIconSize();
 543         if (nStyleIconSize == ToolbarIconSize::Size32)
 544             eOptSymbolsSize = SFX_SYMBOLS_SIZE_32;
 545         else if (nStyleIconSize == ToolbarIconSize::Large)
 546             eOptSymbolsSize = SFX_SYMBOLS_SIZE_LARGE;
 547         else
 548             eOptSymbolsSize = SFX_SYMBOLS_SIZE_SMALL;
 549     }
 550
 551     return eOptSymbolsSize;
 552 }
 553
 554 bool SvtMiscOptions::AreCurrentSymbolsLarge() const
 555 {
 556     return ( GetCurrentSymbolsSize() == SFX_SYMBOLS_SIZE_LARGE || GetCurrentSymbolsSize() == SFX_SYMBOLS_SIZE_32);
 557 }
 558
 559 OUString SvtMiscOptions::GetIconTheme() const
 560 {
 561     return SvtMiscOptions_Impl::GetIconTheme();
 562 }
 563
 564 void SvtMiscOptions::SetIconTheme(const OUString& iconTheme)
 565 {
 566     m_pImpl->SetIconTheme(iconTheme, SvtMiscOptions_Impl::SetModifiedFlag::SET);
 567 }
 568
 569 bool SvtMiscOptions::DisableUICustomization() const
 570 {
 571     return m_pImpl->DisableUICustomization();
 572 }
 573
 574 namespace
 575 {
 576     class theSvtMiscOptionsMutex :
 577         public rtl::Static< osl::Mutex, theSvtMiscOptionsMutex > {};
 578 }
 579
 580 Mutex & SvtMiscOptions::GetInitMutex()
 581 {
 582     return theSvtMiscOptionsMutex::get();
 583 }
 584
 585 void SvtMiscOptions::AddListenerLink( const Link<LinkParamNone*,void>& rLink )
 586 {
 587     m_pImpl->AddListenerLink( rLink );
 588 }
 589
 590 void SvtMiscOptions::RemoveListenerLink( const Link<LinkParamNone*,void>& rLink )
 591 {
 592     m_pImpl->RemoveListenerLink( rLink );
 593 }
 594
 595 bool
 596 SvtMiscOptions::IconThemeWasSetAutomatically()
 597 {
 598     return m_pImpl->IconThemeWasSetAutomatically();
 599 }
 600
 601 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */