starmath/inc/cfgitem.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 #pragma once
  21
  22 #include "utility.hxx"
  23
  24 #include <string_view>
  25 #include <rtl/ustring.hxx>
  26 #include <svl/SfxBroadcaster.hxx>
  27 #include <unotools/configitem.hxx>
  28
  29 #include "types.hxx"
  30
  31 namespace com::sun::star::uno
  32 {
  33 template <class E> class Sequence;
  34 }
  35
  36 class SmSym;
  37 class SmSymbolManager;
  38 class SmFormat;
  39 namespace vcl
  40 {
  41 class Font;
  42 }
  43 struct SmCfgOther;
  44 class SfxItemSet;
  45
  46 struct SmFontFormat
  47 {
  48     OUString aName;
  49     sal_Int16 nCharSet;
  50     sal_Int16 nFamily;
  51     sal_Int16 nPitch;
  52     sal_Int16 nWeight;
  53     sal_Int16 nItalic;
  54
  55     SmFontFormat();
  56     explicit SmFontFormat(const vcl::Font& rFont);
  57
  58     vcl::Font GetFont() const;
  59     bool operator==(const SmFontFormat& rFntFmt) const;
  60 };
  61
  62 struct SmFntFmtListEntry
  63 {
  64     OUString aId;
  65     SmFontFormat aFntFmt;
  66
  67     SmFntFmtListEntry(OUString aId, SmFontFormat rFntFmt);
  68 };
  69
  70 class SmFontFormatList
  71 {
  72     std::vector<SmFntFmtListEntry> aEntries;
  73     bool bModified;
  74
  75     SmFontFormatList(const SmFontFormatList&) = delete;
  76     SmFontFormatList& operator=(const SmFontFormatList&) = delete;
  77
  78 public:
  79     SmFontFormatList();
  80
  81     void Clear();
  82     void AddFontFormat(const OUString& rFntFmtId, const SmFontFormat& rFntFmt);
  83     void RemoveFontFormat(std::u16string_view rFntFmtId);
  84
  85     const SmFontFormat* GetFontFormat(std::u16string_view rFntFmtId) const;
  86     const SmFontFormat* GetFontFormat(size_t nPos) const;
  87     OUString GetFontFormatId(const SmFontFormat& rFntFmt) const;
  88     OUString GetFontFormatId(const SmFontFormat& rFntFmt, bool bAdd);
  89     OUString GetFontFormatId(size_t nPos) const;
  90     OUString GetNewFontFormatId() const;
  91     size_t GetCount() const { return aEntries.size(); }
  92
  93     bool IsModified() const { return bModified; }
  94     void SetModified(bool bVal) { bModified = bVal; }
  95 };
  96
  97 class SmMathConfig final : public utl::ConfigItem, public SfxBroadcaster
  98 {
  99     std::unique_ptr<SmFormat> pFormat;
 100     std::unique_ptr<SmCfgOther> pOther;
 101     std::unique_ptr<SmFontFormatList> pFontFormatList;
 102     std::unique_ptr<SmSymbolManager> pSymbolMgr;
 103     css::uno::Sequence<OUString> m_sUserDefinedNames;
 104     bool bIsOtherModified;
 105     bool bIsFormatModified;
 106     SmFontPickList vFontPickList[8];
 107     sal_Int32 m_nCommitLock = 0;
 108
 109     SmMathConfig(const SmMathConfig&) = delete;
 110     SmMathConfig& operator=(const SmMathConfig&) = delete;
 111
 112     void StripFontFormatList(const std::vector<SmSym>& rSymbols);
 113
 114     void Save();
 115
 116     void ReadSymbol(SmSym& rSymbol, const OUString& rSymbolName,
 117                     std::u16string_view rBaseNode) const;
 118     void ReadFontFormat(SmFontFormat& rFontFormat, std::u16string_view rSymbolName,
 119                         std::u16string_view rBaseNode) const;
 120
 121     bool SetOtherIfNotEqual(bool& rbItem, bool bNewVal);
 122
 123     void LoadOther();
 124     void SaveOther();
 125     void LoadFormat();
 126     void SaveFormat();
 127     void LoadFontFormatList();
 128     void SaveFontFormatList();
 129
 130     void SetOtherModified(bool bVal);
 131     bool IsOtherModified() const { return bIsOtherModified; }
 132     void SetFormatModified(bool bVal);
 133     bool IsFormatModified() const { return bIsFormatModified; }
 134
 135     SmFontFormatList& GetFontFormatList();
 136     const SmFontFormatList& GetFontFormatList() const
 137     {
 138         return const_cast<SmMathConfig*>(this)->GetFontFormatList();
 139     }
 140
 141     virtual void ImplCommit() override;
 142     void LockCommit() { ++m_nCommitLock; }
 143     void UnlockCommit();
 144     // Used to avoid tens of atomic commits in e.g. ItemSetToConfig that calls individual setters
 145     friend struct CommitLocker;
 146     struct CommitLocker
 147     {
 148         SmMathConfig& m_rConfig;
 149         CommitLocker(SmMathConfig& rConfig)
 150             : m_rConfig(rConfig)
 151         {
 152             m_rConfig.LockCommit();
 153         }
 154         ~CommitLocker() { m_rConfig.UnlockCommit(); }
 155     };
 156
 157     void Clear();
 158
 159 public:
 160     SmMathConfig();
 161     virtual ~SmMathConfig() override;
 162
 163     // utl::ConfigItem
 164     virtual void Notify(const css::uno::Sequence<OUString>& rPropertyNames) override;
 165
 166     SmSymbolManager& GetSymbolManager();
 167     void GetSymbols(std::vector<SmSym>& rSymbols) const;
 168     void SetSymbols(const std::vector<SmSym>& rNewSymbols);
 169
 170     const SmFormat& GetStandardFormat() const;
 171     void SetStandardFormat(const SmFormat& rFormat, bool bSaveFontFormatList = false);
 172
 173     css::uno::Sequence<OUString> LoadUserDefinedNames();
 174     void GetUserDefinedFormula(std::u16string_view sName, OUString& sFormula);
 175     bool HasUserDefinedFormula(std::u16string_view sName);
 176     void SaveUserDefinedFormula(std::u16string_view sName, const OUString& sElement);
 177     void DeleteUserDefinedFormula(std::u16string_view sName);
 178
 179     bool IsPrintTitle() const;
 180     void SetPrintTitle(bool bVal);
 181     bool IsPrintFormulaText() const;
 182     void SetPrintFormulaText(bool bVal);
 183     bool IsPrintFrame() const;
 184     void SetPrintFrame(bool bVal);
 185     SmPrintSize GetPrintSize() const;
 186     void SetPrintSize(SmPrintSize eSize);
 187     sal_uInt16 GetPrintZoomFactor() const;
 188     void SetPrintZoomFactor(sal_uInt16 nVal);
 189     sal_uInt16 GetSmEditWindowZoomFactor() const;
 190     void SetSmEditWindowZoomFactor(sal_uInt16 nVal);
 191
 192     bool IsSaveOnlyUsedSymbols() const;
 193     void SetSaveOnlyUsedSymbols(bool bVal);
 194     bool IsAutoCloseBrackets() const;
 195     void SetAutoCloseBrackets(bool bVal);
 196     bool IsInlineEditEnable() const;
 197     void SetInlineEditEnable(bool bVal);
 198     bool IsIgnoreSpacesRight() const;
 199     void SetIgnoreSpacesRight(bool bVal);
 200     bool IsAutoRedraw() const;
 201     void SetAutoRedraw(bool bVal);
 202     bool IsShowFormulaCursor() const;
 203     void SetShowFormulaCursor(bool bVal);
 204
 205     sal_Int16 GetDefaultSmSyntaxVersion() const;
 206     void SetDefaultSmSyntaxVersion(sal_Int16 nVal);
 207
 208     SmFontPickList& GetFontPickList(sal_uInt16 nIdent) { return vFontPickList[nIdent]; }
 209
 210     void ItemSetToConfig(const SfxItemSet& rSet);
 211     void ConfigToItemSet(SfxItemSet& rSet) const;
 212 };
 213
 214 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */