include/unotools/fontoptions.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_FONTOPTIONS_HXX
  20 #define INCLUDED_UNOTOOLS_FONTOPTIONS_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 SvtFontOptions_Impl;
  37
  38 /*-************************************************************************************************************
  39     @short          collect information about font features
  40     @devstatus      ready to use
  41 *//*-*************************************************************************************************************/
  42
  43 class SAL_WARN_UNUSED UNOTOOLS_DLLPUBLIC SvtFontOptions : public utl::detail::Options
  44 {
  45     public:
  46          SvtFontOptions();
  47         virtual ~SvtFontOptions() override;
  48
  49         /*-****************************************************************************************************
  50             @short      interface methods to get and set value of config key "org.openoffice.Office.Common/Font"
  51             @descr      These values defines different states of font handling.
  52
  53                         ..ReplacementTable..()  =>  Determines if the list of font replacements is applied or not.
  54
  55                         ..FontHistory..()       =>  The last 5 fonts will be shown and the last one will be the
  56                                                     first name on the list. These will be displayed in the Font name
  57                                                     combo box on the Object bar.
  58
  59                         ..FontWYSIWYG..()       =>  With this option the names of the selectable fonts
  60                                                     (for example, the fonts in the Font field in the object bar)
  61                                                     will be formatted as the current font.
  62             @onerror    No error should occur!
  63         *//*-*****************************************************************************************************/
  64
  65         bool        IsFontHistoryEnabled        (                   ) const;
  66
  67         bool        IsFontWYSIWYGEnabled        (                   ) const;
  68         void        EnableFontWYSIWYG           ( bool bState   );
  69     private:
  70
  71         /*-****************************************************************************************************
  72             @short      return a reference to a static mutex
  73             @descr      These class use his own static mutex to be threadsafe.
  74                         We create a static mutex only for one ime and use at different times.
  75             @return     A reference to a static mutex member.
  76         *//*-*****************************************************************************************************/
  77
  78         UNOTOOLS_DLLPRIVATE static ::osl::Mutex& impl_GetOwnStaticMutex();
  79     private:
  80         std::shared_ptr<SvtFontOptions_Impl> m_pImpl;
  81
  82 };      // class SvtFontOptions
  83
  84 #endif // INCLUDED_UNOTOOLS_FONTOPTIONS_HXX
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */