include/svtools/toolpanelopt.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
  20 #ifndef INCLUDED_SVTOOLS_TOOLPANELOPT_HXX
  21 #define INCLUDED_SVTOOLS_TOOLPANELOPT_HXX
  22
  23 #include <svtools/svtdllapi.h>
  24 #include <sal/types.h>
  25 #include <osl/mutex.hxx>
  26 #include <com/sun/star/uno/Sequence.h>
  27 #include <rtl/ustring.hxx>
  28 #include <unotools/options.hxx>
  29
  30 /** forward declaration to our private date container implementation
  31
  32     We use these class as internal member to support small memory requirements.
  33     You can create the container if it is necessary. The class which use these mechanism
  34     is faster and smaller then a complete implementation!
  35 */
  36 class SvtToolPanelOptions_Impl;
  37
  38 /** collect information about sidebar group
  39
  40     \attention This class is partially threadsafe.
  41 */
  42 class SVT_DLLPUBLIC SvtToolPanelOptions: public utl::detail::Options
  43 {
  44     public:
  45         /** standard constructor and destructor
  46
  47             This will initialize an instance with default values.
  48             We implement these class with a refcount mechanism! Every instance of this class increase it
  49             at create and decrease it at delete time - but all instances use the same data container!
  50             He is implemented as a static member ...
  51
  52             \sa    member m_nRefCount
  53             \sa    member m_pDataContainer
  54         */
  55         SvtToolPanelOptions();
  56         virtual ~SvtToolPanelOptions();
  57
  58         bool GetVisibleImpressView() const;
  59         void SetVisibleImpressView( bool bVisible );
  60         bool GetVisibleOutlineView() const;
  61         void SetVisibleOutlineView( bool bVisible );
  62         bool GetVisibleNotesView() const;
  63         void SetVisibleNotesView( bool bVisible );
  64         bool GetVisibleHandoutView() const;
  65         void SetVisibleHandoutView( bool bVisible );
  66         bool GetVisibleSlideSorterView() const;
  67         void SetVisibleSlideSorterView( bool bVisible );
  68         bool GetVisibleDrawView() const;
  69         void SetVisibleDrawView( bool bVisible );
  70
  71
  72     private:
  73         /** return a reference to a static mutex
  74
  75             These class is partially threadsafe (for de-/initialization only).
  76             All access methods are'nt safe!
  77             We create a static mutex only for one ime and use at different times.
  78
  79             \return     A reference to a static mutex member.*/
  80         SVT_DLLPRIVATE static ::osl::Mutex& GetInitMutex();
  81
  82     private:
  83
  84         /**
  85             \attention
  86             Don't initialize these static members in these headers!
  87             \li Double defined symbols will be detected ...
  88             \li and unresolved externals exist at linking time.
  89             Do it in your source only.
  90         */
  91         static SvtToolPanelOptions_Impl* m_pDataContainer;
  92         static sal_Int32                 m_nRefCount;
  93
  94 };
  95
  96 #endif
  97
  98 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */