include/svtools/miscopt.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 #ifndef INCLUDED_SVTOOLS_MISCOPT_HXX
  20 #define INCLUDED_SVTOOLS_MISCOPT_HXX
  21
  22 #include "svtools/svtdllapi.h"
  23 #include <sal/types.h>
  24 #include <osl/mutex.hxx>
  25 #include <com/sun/star/uno/Sequence.h>
  26 #include <rtl/ustring.hxx>
  27 #include <unotools/options.hxx>
  28
  29 /*-************************************************************************************************************//**
  30     @short          forward declaration to our private date container implementation
  31     @descr          We use these class as internal member to support small memory requirements.
  32                     You can create the container if it is neccessary. The class which use these mechanism
  33                     is faster and smaller then a complete implementation!
  34 *//*-*************************************************************************************************************/
  35
  36 class SvtMiscOptions_Impl;
  37 class Link;
  38
  39 /*-************************************************************************************************************//**
  40     @short          collect information about misc group
  41     @descr          -
  42
  43     @implements     -
  44     @base           -
  45
  46     @ATTENTION      This class is partially threadsafe.
  47
  48     @devstatus      ready to use
  49 *//*-*************************************************************************************************************/
  50
  51 class SVT_DLLPUBLIC SvtMiscOptions: public utl::detail::Options
  52 {
  53     public:
  54         /*-****************************************************************************************************//**
  55             @short      standard constructor and destructor
  56             @descr      This will initialize an instance with default values.
  57                         We implement these class with a refcount mechanism! Every instance of this class increase it
  58                         at create and decrease it at delete time - but all instances use the same data container!
  59                         He is implemented as a static member ...
  60
  61             @seealso    member m_nRefCount
  62             @seealso    member m_pDataContainer
  63
  64             @param      -
  65             @return     -
  66
  67             @onerror    -
  68         *//*-*****************************************************************************************************/
  69
  70          SvtMiscOptions();
  71         virtual ~SvtMiscOptions();
  72
  73         void AddListenerLink( const Link& rLink );
  74         void RemoveListenerLink( const Link& rLink );
  75
  76         sal_Bool    UseSystemFileDialog() const;
  77         void        SetUseSystemFileDialog( sal_Bool bSet );
  78         sal_Bool    IsUseSystemFileDialogReadOnly() const;
  79
  80         sal_Bool    DisableUICustomization() const;
  81
  82         sal_Bool    IsPluginsEnabled() const;
  83
  84         sal_Int16   GetSymbolsSize() const;
  85         void        SetSymbolsSize( sal_Int16 eSet );
  86         sal_Int16   GetCurrentSymbolsSize() const;
  87         bool        AreCurrentSymbolsLarge() const;
  88
  89         sal_Int16   GetSymbolsStyle() const;
  90         void        SetSymbolsStyle( sal_Int16 eSet );
  91         sal_Int16   GetCurrentSymbolsStyle() const;
  92
  93         sal_Int16   GetToolboxStyle() const;
  94         void        SetToolboxStyle( sal_Int16 nStyle );
  95
  96         sal_Bool    IsModifyByPrinting() const;
  97         void        SetModifyByPrinting(sal_Bool bSet );
  98
  99         sal_Bool    UseSystemPrintDialog() const;
 100         void        SetUseSystemPrintDialog( sal_Bool bSet );
 101
 102         sal_Bool    ShowLinkWarningDialog() const;
 103         void        SetShowLinkWarningDialog( sal_Bool bSet );
 104         sal_Bool    IsShowLinkWarningDialogReadOnly() const;
 105
 106         void        SetSaveAlwaysAllowed( sal_Bool bSet );
 107         sal_Bool    IsSaveAlwaysAllowed() const;
 108
 109         void        SetExperimentalMode( sal_Bool bSet );
 110         sal_Bool    IsExperimentalMode() const;
 111
 112         void        SetExperimentalSidebar( sal_Bool bSet );
 113         sal_Bool    IsExperimentalSidebar() const;
 114
 115         void        SetMacroRecorderMode( sal_Bool bSet );
 116         sal_Bool    IsMacroRecorderMode() const;
 117
 118     private:
 119
 120         /*-****************************************************************************************************//**
 121             @short      return a reference to a static mutex
 122             @descr      These class is partially threadsafe (for de-/initialization only).
 123                         All access methods are'nt safe!
 124                         We create a static mutex only for one ime and use at different times.
 125
 126             @seealso    -
 127
 128             @param      -
 129             @return     A reference to a static mutex member.
 130
 131             @onerror    -
 132         *//*-*****************************************************************************************************/
 133
 134         SVT_DLLPRIVATE static ::osl::Mutex& GetInitMutex();
 135
 136     private:
 137
 138         /*Attention
 139
 140             Don't initialize these static member in these header!
 141             a) Double dfined symbols will be detected ...
 142             b) and unresolved externals exist at linking time.
 143             Do it in your source only.
 144          */
 145
 146         static SvtMiscOptions_Impl* m_pDataContainer    ;   /// impl. data container as dynamic pointer for smaller memory requirements!
 147         static sal_Int32                m_nRefCount         ;   /// internal ref count mechanism
 148
 149 };      // class SvtMiscOptions
 150
 151 #endif  // #ifndef INCLUDED_SVTOOLS_MISCOPT_HXX
 152
 153 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */