summaryrefslogtreecommitdiff
path: root/sc/inc/patattr.hxx
blob: 5db0e8f9c82c8cce77618fc11c04c8b5909146d4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#pragma once

#include <optional>

#include <svl/itemset.hxx>
#include <svl/languageoptions.hxx>
#include <tools/degree.hxx>
#include <editeng/svxenum.hxx>
#include "scdllapi.h"
#include "fonthelper.hxx"
#include "scitems.hxx"
#include "attrib.hxx"
#include <set>

namespace vcl { class Font; }
namespace model { class ComplexColor; }
struct ScInterpreterContext;
class OutputDevice;
class Fraction;
class ScStyleSheet;
class SvNumberFormatter;
class ScDocument;
enum class ScRotateDir : sal_uInt8;

///  how to treat COL_AUTO in GetFont:

enum class ScAutoFontColorMode
{
    Raw,         ///< COL_AUTO is returned
    Print,       ///< black or white, depending on background
    Display,     ///< from style settings, or black/white if needed
    IgnoreFont,  ///< like DISPLAY, but ignore stored font color (assume COL_AUTO)
    IgnoreBack,  ///< like DISPLAY, but ignore stored background color (use configured color)
    IgnoreAll    ///< like DISPLAY, but ignore stored font and background colors
};

class ScPatternAttr;

class SC_DLLPUBLIC CellAttributeHelper final
{
    friend class CellAttributeHolder;

    // Data structure chosen so that
    // (a) we can find by name
    // (b) we can erase quickly, by using name and pointer.
    // so we sort the set first by name, and then by pointer.
    struct RegisteredAttrSetLess
    {
        bool operator()(const ScPatternAttr* lhs, const ScPatternAttr* rhs) const;
        // so we can search in std::set without a ScPatternAttr
        using is_transparent = void;
        bool operator()(const ScPatternAttr* lhs, const OUString* rhs) const;
        bool operator()(const OUString* lhs, const ScPatternAttr* rhs) const;
    };
    typedef std::set<const ScPatternAttr*, RegisteredAttrSetLess> RegisteredAttrSet;

    SfxItemPool&                                        mrSfxItemPool;
    mutable ScPatternAttr*                              mpDefaultCellAttribute;
    mutable RegisteredAttrSet                           maRegisteredCellAttributes;
    mutable const ScPatternAttr*                        mpLastHit;
    mutable sal_uInt64                                  mnCurrentMaxKey;

    // only to be used from CellAttributeHolder, so private
    const ScPatternAttr* registerAndCheck(const ScPatternAttr& rCandidate, bool bPassingOwnership) const;
    void doUnregister(const ScPatternAttr& rCandidate);

public:
    explicit CellAttributeHelper(SfxItemPool& rSfxItemPool);
    ~CellAttributeHelper();

    const ScPatternAttr& getDefaultCellAttribute() const;
    SfxItemPool& GetPool() const { return mrSfxItemPool; }

    void CellStyleDeleted(const ScStyleSheet& rStyle);
    void CellStyleCreated(ScDocument& rDoc, const OUString& rName);
    void UpdateAllStyleSheets(ScDocument& rDoc);
    void AllStylesToNames();
    void ReIndexRegistered();
};

class SC_DLLPUBLIC CellAttributeHolder final
{
    const ScPatternAttr*    mpScPatternAttr;

public:
    CellAttributeHolder(const ScPatternAttr* pScPatternAttr = nullptr, bool bPassingOwnership = false);
    CellAttributeHolder(const CellAttributeHolder& rHolder);
    CellAttributeHolder(CellAttributeHolder&& rHolder) noexcept;
    ~CellAttributeHolder();

    CellAttributeHolder& operator=(const CellAttributeHolder& rHolder);
    CellAttributeHolder& operator=(CellAttributeHolder&& rHolder);
    bool operator==(const CellAttributeHolder& rHolder) const;

    const ScPatternAttr* getScPatternAttr() const { return mpScPatternAttr; }
    void setScPatternAttr(const ScPatternAttr* pNew, bool bPassingOwnership = false);

    bool operator!() const { return nullptr == mpScPatternAttr; }
    explicit operator bool() const { return nullptr != mpScPatternAttr; }

    // version that allows nullptrs
    static bool areSame(const CellAttributeHolder* p1, const CellAttributeHolder* p2);
};

class SAL_DLLPUBLIC_RTTI ScPatternAttr final
{
    friend class CellAttributeHelper;

    SfxItemSet                  maLocalSfxItemSet;
    std::optional<OUString>     moName;
    mutable std::optional<bool> mxVisible;
    mutable std::optional<sal_uInt32> mxNumberFormatKey;
    mutable std::optional<LanguageType> mxLanguageType;
    ScStyleSheet*               pStyle;
    CellAttributeHelper*        pCellAttributeHelper;
    sal_uInt64                  mnPAKey;
    mutable size_t              mnRefCount;
#ifdef DBG_UTIL
    sal_uInt32                  m_nSerialNumber;
    bool                        m_bDeleted;
#endif

public:
    SC_DLLPUBLIC ScPatternAttr(CellAttributeHelper& rHelper, const SfxItemSet* pItemSet = nullptr, const OUString* pStyleName = nullptr);
    SC_DLLPUBLIC ScPatternAttr(const ScPatternAttr& rPatternAttr);
    SC_DLLPUBLIC ~ScPatternAttr();

    bool operator==(const ScPatternAttr& rCmp) const;

    // version that allows nullptrs
    SC_DLLPUBLIC static bool areSame(const ScPatternAttr* pItem1, const ScPatternAttr* pItem2);
    bool isRegistered() const { return 0 != mnRefCount; }
    bool isDefault() const { return this == &pCellAttributeHelper->getDefaultCellAttribute(); }
    CellAttributeHelper& getCellAttributeHelper() const { return *pCellAttributeHelper; }

    const SfxItemSet& GetItemSet() const { return maLocalSfxItemSet; }
    SfxItemSet& GetItemSet() { return maLocalSfxItemSet; }

    const SfxPoolItem& GetItem(sal_uInt16 nWhichP) const { return maLocalSfxItemSet.GetByOffset(nWhichP, nWhichP - ATTR_PATTERN_START); }
    template<class T> const T& GetItem( TypedWhichId<T> nWhich ) const
        { return static_cast<const T&>(GetItem(sal_uInt16(nWhich))); }
    static const SfxPoolItem& GetItem(sal_uInt16 nWhich, const SfxItemSet& rItemSet, const SfxItemSet* pCondSet);
    template<class T> static const T& GetItem(TypedWhichId<T> nWhich, const SfxItemSet& rItemSet, const SfxItemSet* pCondSet)
        { return static_cast<const T&>(GetItem(sal_uInt16(nWhich), rItemSet, pCondSet)); }
    SC_DLLPUBLIC const SfxPoolItem& GetItem( sal_uInt16 nWhich, const SfxItemSet* pCondSet ) const;
    template<class T> const T& GetItem(TypedWhichId<T> nWhich, const SfxItemSet* pCondSet) const
        { return static_cast<const T&>(GetItem(sal_uInt16(nWhich), pCondSet)); }

    /// @param pWhich are no ranges, but single IDs, 0-terminated
    bool HasItemsSet( const sal_uInt16* pWhich ) const;
    void ClearItems( const sal_uInt16* pWhich );
    void DeleteUnchanged( const ScPatternAttr* pOldAttrs );

    static SvxCellOrientation GetCellOrientation( const SfxItemSet& rItemSet, const SfxItemSet* pCondSet );
    SvxCellOrientation GetCellOrientation( const SfxItemSet* pCondSet = nullptr ) const;

    /** Static helper function to fill a font object from the passed item set. */
    SC_DLLPUBLIC static void fillFontOnly(vcl::Font& rFont, const SfxItemSet& rItemSet,
                                        const OutputDevice* pOutDev = nullptr,
                                        const Fraction* pScale = nullptr,
                                        const SfxItemSet* pCondSet = nullptr,
                                        SvtScriptType nScript = SvtScriptType::NONE);

    static void fillFont( vcl::Font& rFont, const SfxItemSet& rItemSet,
                                        ScAutoFontColorMode eAutoMode,
                                        const OutputDevice* pOutDev = nullptr,
                                        const Fraction* pScale = nullptr,
                                        const SfxItemSet* pCondSet = nullptr,
                                        SvtScriptType nScript = SvtScriptType::NONE, const Color* pBackConfigColor = nullptr,
                                        const Color* pTextConfigColor = nullptr);

    SC_DLLPUBLIC static void fillColor(model::ComplexColor& rComplexColor,
                            const SfxItemSet& rItemSet,
                            ScAutoFontColorMode eAutoMode,
                            const SfxItemSet* pCondSet = nullptr,
                            const Color* pBackConfigColor = nullptr,
                            const Color* pTextConfigColor = nullptr);


    SC_DLLPUBLIC static ScDxfFont        GetDxfFont(const SfxItemSet& rSet, SvtScriptType nScript);

    void fillColor(model::ComplexColor& rComplexColor,
                    ScAutoFontColorMode eAutoMode,
                    const SfxItemSet* pCondSet = nullptr,
                    const Color* pBackConfigColor = nullptr,
                    const Color* pTextConfigColor = nullptr) const
    {
        fillColor(rComplexColor, maLocalSfxItemSet, eAutoMode, pCondSet, pBackConfigColor, pTextConfigColor);
    }

    void fillFontOnly(vcl::Font& rFont,
                    const OutputDevice* pOutDev = nullptr,
                    const Fraction* pScale = nullptr,
                    const SfxItemSet* pCondSet = nullptr,
                    SvtScriptType nScript = SvtScriptType::NONE) const
    {
        fillFontOnly(rFont, maLocalSfxItemSet, pOutDev, pScale, pCondSet, nScript);
    }

    /** Fills a font object from the own item set. */
    void fillFont(vcl::Font& rFont, ScAutoFontColorMode eAutoMode,
                    const OutputDevice* pOutDev = nullptr,
                    const Fraction* pScale = nullptr,
                    const SfxItemSet* pCondSet = nullptr,
                    SvtScriptType nScript = SvtScriptType::NONE,
                    const Color* pBackConfigColor = nullptr,
                    const Color* pTextConfigColor = nullptr) const
    {
        fillFont(rFont, maLocalSfxItemSet, eAutoMode, pOutDev, pScale, pCondSet, nScript, pBackConfigColor, pTextConfigColor);
    }

    /** Converts all Calc items contained in rSrcSet to edit engine items and puts them into rEditSet. */
    SC_DLLPUBLIC static void             FillToEditItemSet( SfxItemSet& rEditSet, const SfxItemSet& rSrcSet, const SfxItemSet* pCondSet = nullptr );
    /** Converts all Calc items contained in the own item set to edit engine items and puts them into pEditSet. */
    SC_DLLPUBLIC void                    FillEditItemSet( SfxItemSet* pEditSet, const SfxItemSet* pCondSet = nullptr ) const;

    /** Converts all edit engine items contained in rEditSet to Calc items and puts them into rDestSet. */
    SC_DLLPUBLIC static void             GetFromEditItemSet( SfxItemSet& rDestSet, const SfxItemSet& rEditSet );
    /** Converts all edit engine items contained in pEditSet to Calc items and puts them into the own item set. */
    SC_DLLPUBLIC void                    GetFromEditItemSet( const SfxItemSet* pEditSet );

    void                    FillEditParaItems( SfxItemSet* pSet ) const;

    CellAttributeHolder     MigrateToDocument( ScDocument* pDestDoc, ScDocument* pSrcDoc ) const;

    SC_DLLPUBLIC void                    SetStyleSheet(ScStyleSheet* pNewStyle, bool bClearDirectFormat = true);
    const ScStyleSheet*     GetStyleSheet() const  { return pStyle; }
    SC_DLLPUBLIC const OUString*         GetStyleName() const;
    bool                    UpdateStyleSheet(const ScDocument& rDoc);
    void                    StyleToName();

    bool                    IsVisible() const;
    bool                    IsVisibleEqual( const ScPatternAttr& rOther ) const;

                            /** If font is an old symbol font StarBats/StarMath
                                with text encoding RTL_TEXTENC_SYMBOL */
    bool                    IsSymbolFont() const;

    SC_DLLPUBLIC sal_uInt32              GetNumberFormat( SvNumberFormatter* ) const;
    sal_uInt32              GetNumberFormat( const ScInterpreterContext& rContext ) const;
    sal_uInt32              GetNumberFormat( SvNumberFormatter* pFormatter,
                                             const SfxItemSet* pCondSet ) const;
    SC_DLLPUBLIC sal_uInt32              GetNumberFormat( const ScInterpreterContext& rContext,
                                             const SfxItemSet* pCondSet ) const;

    Degree100               GetRotateVal( const SfxItemSet* pCondSet ) const;
    ScRotateDir             GetRotateDir( const SfxItemSet* pCondSet ) const;

    void                    SetPAKey(sal_uInt64 nKey);
    sal_uInt64              GetPAKey() const;

private:
    bool                    CalcVisible() const;
    sal_uInt32              GetNumberFormatKey() const;
    LanguageType            GetLanguageType() const;
    void                    InvalidateCaches();
};

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */