svtools/source/config/slidesorterbaropt.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/slidesorterbaropt.hxx>
  21 #include <unotools/configitem.hxx>
  22 #include <tools/debug.hxx>
  23 #include <osl/diagnose.h>
  24 #include <com/sun/star/uno/Any.hxx>
  25 #include <com/sun/star/uno/Sequence.hxx>
  26
  27 #include <comphelper/lok.hxx>
  28 #include <comphelper/sequence.hxx>
  29 #include <mutex>
  30
  31 using namespace ::utl;
  32 using namespace ::osl;
  33 using namespace ::com::sun::star::uno;
  34 using namespace ::com::sun::star;
  35
  36 constexpr OUStringLiteral ROOTNODE_SLIDESORTERBAR = u"Office.Impress/MultiPaneGUI/SlideSorterBar/Visible";
  37
  38 constexpr OUStringLiteral PROPERTYNAME_VISIBLE_IMPRESSVIEW = u"ImpressView";
  39 #define PROPERTYHANDLE_VISIBLE_IMPRESSVIEW     0
  40 constexpr OUStringLiteral PROPERTYNAME_VISIBLE_OUTLINEVIEW = u"OutlineView";
  41 #define PROPERTYHANDLE_VISIBLE_OUTLINEVIEW     1
  42 constexpr OUStringLiteral PROPERTYNAME_VISIBLE_NOTESVIEW = u"NotesView";
  43 #define PROPERTYHANDLE_VISIBLE_NOTESVIEW       2
  44 constexpr OUStringLiteral PROPERTYNAME_VISIBLE_HANDOUTVIEW = u"HandoutView";
  45 #define PROPERTYHANDLE_VISIBLE_HANDOUTVIEW     3
  46 constexpr OUStringLiteral PROPERTYNAME_VISIBLE_SLIDESORTERVIEW = u"SlideSorterView";
  47 #define PROPERTYHANDLE_VISIBLE_SLIDESORTERVIEW 4
  48 constexpr OUStringLiteral PROPERTYNAME_VISIBLE_DRAWVIEW = u"DrawView";
  49 #define PROPERTYHANDLE_VISIBLE_DRAWVIEW        5
  50
  51 static std::mutex & GetInitMutex()
  52 {
  53     static std::mutex theSvtSlideSorterBarOptionsMutex;
  54     return theSvtSlideSorterBarOptionsMutex;
  55 }
  56
  57
  58 class SvtSlideSorterBarOptions_Impl : public ConfigItem
  59 {
  60     Sequence< OUString > m_seqPropertyNames;
  61
  62     public:
  63
  64          SvtSlideSorterBarOptions_Impl();
  65         ~SvtSlideSorterBarOptions_Impl() override;
  66
  67         /** called for notify of configmanager
  68
  69             This method is called from the ConfigManager before the application ends or from the
  70             PropertyChangeListener if the sub tree broadcasts changes. You must update your
  71             internal values.
  72
  73             \sa baseclass ConfigItem
  74             \param[in,out] seqPropertyNames is the list of properties which should be updated.
  75         */
  76         virtual void Notify( const Sequence< OUString >& seqPropertyNames ) override;
  77
  78         /**
  79          loads required data from the configuration. It's called in the constructor to
  80          read all entries and form ::Notify to re-read changed setting
  81         */
  82         void Load( const Sequence< OUString >& rPropertyNames );
  83
  84         //  public interface
  85         bool m_bVisibleImpressView;
  86         bool m_bVisibleOutlineView;
  87         bool m_bVisibleNotesView;
  88         bool m_bVisibleHandoutView;
  89         bool m_bVisibleSlideSorterView;
  90         bool m_bVisibleDrawView;
  91
  92     private:
  93         virtual void ImplCommit() final override;
  94
  95         /** return list of key names of our configuration management which represent our module tree
  96
  97             This method returns a static const list of key names. We need it to get needed values from
  98             configuration management.
  99
 100             \return A list of needed configuration keys is returned.
 101         */
 102         static Sequence< OUString > GetPropertyNames();
 103
 104         void SetVisibleViewImpl( bool& bVisibleView, bool bVisible );
 105
 106     public:
 107         void SetVisibleImpressView( bool bVisible)
 108              { SetVisibleViewImpl( m_bVisibleImpressView, bVisible ); }
 109
 110         void SetVisibleOutlineView( bool bVisible)
 111              { SetVisibleViewImpl( m_bVisibleOutlineView, bVisible ); }
 112
 113         void SetVisibleNotesView( bool bVisible)
 114              { SetVisibleViewImpl( m_bVisibleNotesView, bVisible ); }
 115
 116         void SetVisibleHandoutView( bool bVisible)
 117              { SetVisibleViewImpl( m_bVisibleHandoutView, bVisible ); }
 118
 119         void SetVisibleSlideSorterView( bool bVisible)
 120              { SetVisibleViewImpl( m_bVisibleSlideSorterView, bVisible ); }
 121
 122         void SetVisibleDrawView( bool bVisible)
 123              { SetVisibleViewImpl( m_bVisibleDrawView, bVisible ); }
 124
 125 };
 126
 127 SvtSlideSorterBarOptions_Impl::SvtSlideSorterBarOptions_Impl()
 128     // Init baseclasses first
 129     : ConfigItem( ROOTNODE_SLIDESORTERBAR )
 130     , m_seqPropertyNames(GetPropertyNames())
 131     , m_bVisibleImpressView( false )
 132     , m_bVisibleOutlineView( false )
 133     , m_bVisibleNotesView( false )
 134     , m_bVisibleHandoutView( false )
 135     , m_bVisibleSlideSorterView( false )
 136     , m_bVisibleDrawView( false )
 137
 138 {
 139     // Use our static list of configuration keys to get his values.
 140     Sequence< Any > seqValues = GetProperties( m_seqPropertyNames  );
 141
 142     // Safe impossible cases.
 143     // We need values from ALL configuration keys.
 144     // Follow assignment use order of values in relation to our list of key names!
 145     DBG_ASSERT( !(m_seqPropertyNames.getLength()!=seqValues.getLength()),
 146                 "SvtSlideSorterBarOptions_Impl::SvtSlideSorterBarOptions_Impl()\nI miss some values of configuration keys!\n" );
 147
 148     // Copy values from list in right order to our internal member.
 149     for( sal_Int32 nProperty=0; nProperty<seqValues.getLength(); ++nProperty )
 150     {
 151         if (!seqValues[nProperty].hasValue())
 152             continue;
 153         switch( nProperty )
 154         {
 155             case PROPERTYHANDLE_VISIBLE_IMPRESSVIEW :
 156             {
 157                 if( !(seqValues[nProperty] >>= m_bVisibleImpressView) )
 158                     OSL_FAIL("Wrong type of \"SlideSorterBar\\VisibleImpressView\"!" );
 159                 break;
 160             }
 161             case PROPERTYHANDLE_VISIBLE_OUTLINEVIEW :
 162             {
 163                 if( !(seqValues[nProperty] >>= m_bVisibleOutlineView) )
 164                     OSL_FAIL("Wrong type of \"SlideSorterBar\\VisibleOutlineView\"!" );
 165                 break;
 166             }
 167             case PROPERTYHANDLE_VISIBLE_NOTESVIEW :
 168             {
 169                 if( !(seqValues[nProperty] >>= m_bVisibleNotesView) )
 170                     OSL_FAIL("Wrong type of \"SlideSorterBar\\VisibleNotesView\"!" );
 171                 break;
 172             }
 173             case PROPERTYHANDLE_VISIBLE_HANDOUTVIEW :
 174             {
 175                 if( !(seqValues[nProperty] >>= m_bVisibleHandoutView) )
 176                     OSL_FAIL("Wrong type of \"SlideSorterBar\\VisibleHandoutView\"!" );
 177                 break;
 178             }
 179             case PROPERTYHANDLE_VISIBLE_SLIDESORTERVIEW :
 180             {
 181                 if( !(seqValues[nProperty] >>= m_bVisibleSlideSorterView) )
 182                     OSL_FAIL("Wrong type of \"SlideSorterBar\\VisibleSlideSorterView\"!" );
 183                 break;
 184             }
 185             case PROPERTYHANDLE_VISIBLE_DRAWVIEW :
 186             {
 187                 if( !(seqValues[nProperty] >>= m_bVisibleDrawView) )
 188                     OSL_FAIL("Wrong type of \"SlideSorterBar\\VisibleDrawView\"!" );
 189                 break;
 190             }
 191         }
 192     }
 193
 194     // Enable notification mechanism of our baseclass.
 195     // We need it to get information about changes outside these class on our used configuration keys!
 196     EnableNotification( m_seqPropertyNames );
 197 }
 198
 199 SvtSlideSorterBarOptions_Impl::~SvtSlideSorterBarOptions_Impl()
 200 {
 201     if (IsModified())
 202         Commit();
 203 }
 204
 205 void SvtSlideSorterBarOptions_Impl::Load( const Sequence< OUString >& rPropertyNames )
 206 {
 207     const uno::Sequence< OUString> aInternalPropertyNames( GetPropertyNames());
 208     Sequence< Any > seqValues = GetProperties( rPropertyNames  );
 209
 210     // Safe impossible cases.
 211     // We need values from ALL configuration keys.
 212     // Follow assignment use order of values in relation to our list of key names!
 213     DBG_ASSERT( !(rPropertyNames.getLength()!=seqValues.getLength()),
 214                 "SvtSlideSorterBarOptions_Impl::SvtSlideSorterBarOptions_Impl()\nI miss some values of configuration keys!\n" );
 215
 216     // Copy values from list in right order to our internal member.
 217     for( sal_Int32 nProperty=0; nProperty<seqValues.getLength(); ++nProperty )
 218     {
 219         if (!seqValues[nProperty].hasValue())
 220             continue;
 221         switch( comphelper::findValue(aInternalPropertyNames, rPropertyNames[nProperty]) )
 222         {
 223             case PROPERTYHANDLE_VISIBLE_IMPRESSVIEW:
 224             {
 225                 if( !(seqValues[nProperty] >>= m_bVisibleImpressView) )
 226                     OSL_FAIL("Wrong type of \"SlideSorterBar\\VisibleImpressView\"!" );
 227             }
 228             break;
 229             case PROPERTYHANDLE_VISIBLE_OUTLINEVIEW :
 230             {
 231                 if( !(seqValues[nProperty] >>= m_bVisibleOutlineView) )
 232                     OSL_FAIL("Wrong type of \"SlideSorterBar\\VisibleOutlineView\"!" );
 233             }
 234             break;
 235             case PROPERTYHANDLE_VISIBLE_NOTESVIEW :
 236             {
 237                 if( !(seqValues[nProperty] >>= m_bVisibleNotesView) )
 238                     OSL_FAIL("Wrong type of \"SlideSorterBar\\VisibleNotesView\"!" );
 239             }
 240             break;
 241             case PROPERTYHANDLE_VISIBLE_HANDOUTVIEW :
 242             {
 243                 if( !(seqValues[nProperty] >>= m_bVisibleHandoutView) )
 244                     OSL_FAIL("Wrong type of \"SlideSorterBar\\VisibleHandoutView\"!" );
 245             }
 246             break;
 247             case PROPERTYHANDLE_VISIBLE_SLIDESORTERVIEW :
 248             {
 249                 if( !(seqValues[nProperty] >>= m_bVisibleSlideSorterView) )
 250                     OSL_FAIL("Wrong type of \"SlideSorterBar\\VisibleSlideSorterView\"!" );
 251             }
 252             break;
 253
 254             case PROPERTYHANDLE_VISIBLE_DRAWVIEW :
 255             {
 256                 if( !(seqValues[nProperty] >>= m_bVisibleDrawView) )
 257                     OSL_FAIL("Wrong type of \"SlideSorterBar\\VisibleDrawView\"!" );
 258             }
 259             break;
 260        }
 261     }
 262 }
 263
 264 void SvtSlideSorterBarOptions_Impl::Notify( const Sequence< OUString >& rPropertyNames )
 265 {
 266     Load( rPropertyNames );
 267 }
 268
 269 void SvtSlideSorterBarOptions_Impl::ImplCommit()
 270 {
 271     // Get names of supported properties, create a list for values and copy current values to it.
 272     sal_Int32               nCount      = m_seqPropertyNames.getLength();
 273     Sequence< Any >         seqValues   ( nCount );
 274     auto seqValuesRange = asNonConstRange(seqValues);
 275     for( sal_Int32 nProperty=0; nProperty<nCount; ++nProperty )
 276     {
 277         switch( nProperty )
 278         {
 279             case PROPERTYHANDLE_VISIBLE_IMPRESSVIEW:
 280             {
 281                 seqValuesRange[nProperty] <<= m_bVisibleImpressView;
 282                 break;
 283             }
 284             case PROPERTYHANDLE_VISIBLE_OUTLINEVIEW:
 285             {
 286                 seqValuesRange[nProperty] <<= m_bVisibleOutlineView;
 287                 break;
 288             }
 289             case PROPERTYHANDLE_VISIBLE_NOTESVIEW:
 290             {
 291                 seqValuesRange[nProperty] <<= m_bVisibleNotesView;
 292                 break;
 293             }
 294             case PROPERTYHANDLE_VISIBLE_HANDOUTVIEW:
 295             {
 296                 seqValuesRange[nProperty] <<= m_bVisibleHandoutView;
 297                 break;
 298             }
 299             case PROPERTYHANDLE_VISIBLE_SLIDESORTERVIEW:
 300             {
 301                 seqValuesRange[nProperty] <<= m_bVisibleSlideSorterView;
 302                 break;
 303             }
 304             case PROPERTYHANDLE_VISIBLE_DRAWVIEW:
 305             {
 306                 seqValuesRange[nProperty] <<= m_bVisibleDrawView;
 307                 break;
 308             }
 309
 310         }
 311     }
 312     // Set properties in configuration.
 313     PutProperties( m_seqPropertyNames, seqValues );
 314 }
 315
 316 Sequence< OUString > SvtSlideSorterBarOptions_Impl::GetPropertyNames()
 317 {
 318     // Build list of configuration key names.
 319     return
 320     {
 321         PROPERTYNAME_VISIBLE_IMPRESSVIEW,
 322         PROPERTYNAME_VISIBLE_OUTLINEVIEW,
 323         PROPERTYNAME_VISIBLE_NOTESVIEW,
 324         PROPERTYNAME_VISIBLE_HANDOUTVIEW,
 325         PROPERTYNAME_VISIBLE_SLIDESORTERVIEW,
 326         PROPERTYNAME_VISIBLE_DRAWVIEW,
 327     };
 328 }
 329
 330 void SvtSlideSorterBarOptions_Impl::SetVisibleViewImpl( bool& bVisibleView, bool bVisible )
 331 {
 332     if( bVisibleView != bVisible )
 333     {
 334         bVisibleView = bVisible;
 335         SetModified();
 336     }
 337 }
 338
 339 namespace {
 340     std::weak_ptr<SvtSlideSorterBarOptions_Impl> g_pSlideSorterBarOptions;
 341 }
 342
 343 SvtSlideSorterBarOptions::SvtSlideSorterBarOptions()
 344 {
 345     // Global access, must be guarded (multithreading!).
 346     std::unique_lock aGuard( GetInitMutex() );
 347
 348     m_pImpl = g_pSlideSorterBarOptions.lock();
 349     if( !m_pImpl )
 350     {
 351         m_pImpl = std::make_shared<SvtSlideSorterBarOptions_Impl>();
 352         g_pSlideSorterBarOptions = m_pImpl;
 353     }
 354 }
 355
 356 SvtSlideSorterBarOptions::~SvtSlideSorterBarOptions()
 357 {
 358     // Global access, must be guarded (multithreading!)
 359     std::unique_lock aGuard( GetInitMutex() );
 360
 361     m_pImpl.reset();
 362 }
 363
 364 bool SvtSlideSorterBarOptions::GetVisibleImpressView() const
 365 {
 366     static const bool bRunningUnitTest = getenv("LO_TESTNAME");
 367     return m_pImpl->m_bVisibleImpressView && (!bRunningUnitTest || !comphelper::LibreOfficeKit::isActive());
 368 }
 369
 370 void SvtSlideSorterBarOptions::SetVisibleImpressView(bool bVisible)
 371 {
 372     m_pImpl->SetVisibleImpressView( bVisible );
 373 }
 374
 375 bool SvtSlideSorterBarOptions::GetVisibleOutlineView() const
 376 {
 377     return m_pImpl->m_bVisibleOutlineView;
 378 }
 379
 380 void SvtSlideSorterBarOptions::SetVisibleOutlineView(bool bVisible)
 381 {
 382     m_pImpl->SetVisibleOutlineView( bVisible );
 383 }
 384
 385 bool SvtSlideSorterBarOptions::GetVisibleNotesView() const
 386 {
 387     return m_pImpl->m_bVisibleNotesView;
 388 }
 389
 390 void SvtSlideSorterBarOptions::SetVisibleNotesView(bool bVisible)
 391 {
 392     m_pImpl->SetVisibleNotesView( bVisible );
 393 }
 394
 395 bool SvtSlideSorterBarOptions::GetVisibleHandoutView() const
 396 {
 397     return m_pImpl->m_bVisibleHandoutView;
 398 }
 399
 400 void SvtSlideSorterBarOptions::SetVisibleHandoutView(bool bVisible)
 401 {
 402     m_pImpl->SetVisibleHandoutView( bVisible );
 403 }
 404
 405 bool SvtSlideSorterBarOptions::GetVisibleSlideSorterView() const
 406 {
 407     return m_pImpl->m_bVisibleSlideSorterView && !comphelper::LibreOfficeKit::isActive();
 408 }
 409
 410 void SvtSlideSorterBarOptions::SetVisibleSlideSorterView(bool bVisible)
 411 {
 412     m_pImpl->SetVisibleSlideSorterView( bVisible );
 413 }
 414
 415 bool SvtSlideSorterBarOptions::GetVisibleDrawView() const
 416 {
 417     return m_pImpl->m_bVisibleDrawView;
 418 }
 419
 420 void SvtSlideSorterBarOptions::SetVisibleDrawView(bool bVisible)
 421 {
 422     m_pImpl->SetVisibleDrawView( bVisible );
 423 }
 424
 425 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */