include/unotools/extendedsecurityoptions.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_UNOTOOLS_EXTENDEDSECURITYOPTIONS_HXX
  20 #define INCLUDED_UNOTOOLS_EXTENDEDSECURITYOPTIONS_HXX
  21
  22 #include <unotools/unotoolsdllapi.h>
  23 #include <sal/types.h>
  24 #include <unotools/options.hxx>
  25 #include <memory>
  26
  27 namespace osl { class Mutex; }
  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 necessary. The class which use these mechanism
  33                     is faster and smaller then a complete implementation!
  34 *//*-*************************************************************************************************************/
  35
  36 class SvtExtendedSecurityOptions_Impl;
  37
  38 /*-************************************************************************************************************
  39     @short          collect information about security features
  40     @ATTENTION      This class is partially threadsafe.
  41
  42     @devstatus      ready to use
  43 *//*-*************************************************************************************************************/
  44
  45 class SAL_WARN_UNUSED UNOTOOLS_DLLPUBLIC SvtExtendedSecurityOptions final : public utl::detail::Options
  46 {
  47     public:
  48         // Must be zero based!
  49         enum OpenHyperlinkMode
  50         {
  51             OPEN_NEVER                  = 0,
  52             OPEN_WITHSECURITYCHECK,
  53         };
  54
  55          SvtExtendedSecurityOptions();
  56         virtual ~SvtExtendedSecurityOptions() override;
  57
  58         OpenHyperlinkMode                               GetOpenHyperlinkMode() const;
  59
  60     private:
  61
  62         /*-****************************************************************************************************
  63             @short      return a reference to a static mutex
  64             @descr      These class is partially threadsafe (for de-/initialization only).
  65                         All access methods aren't safe!
  66                         We create a static mutex only for one ime and use at different times.
  67             @return     A reference to a static mutex member.
  68         *//*-*****************************************************************************************************/
  69
  70         UNOTOOLS_DLLPRIVATE static ::osl::Mutex& GetInitMutex();
  71
  72     //  private member
  73
  74     private:
  75         std::shared_ptr<SvtExtendedSecurityOptions_Impl> m_pImpl;
  76
  77 };      // class SvtExtendedSecurityOptions
  78
  79 #endif // INCLUDED_UNOTOOLS_EXTENDEDSECURITYOPTIONS_HXX
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */