sw/inc/expfld.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_SW_INC_EXPFLD_HXX
  20 #define INCLUDED_SW_INC_EXPFLD_HXX
  21
  22 #include "swdllapi.h"
  23 #include "fldbas.hxx"
  24 #include "cellfml.hxx"
  25 #include <set>
  26 #include <memory>
  27 #include <vector>
  28 #include <tools/solar.h>
  29 #include <o3tl/sorted_vector.hxx>
  30
  31 class SfxPoolItem;
  32 class SwTextNode;
  33 class SwFrame;
  34 class SwRootFrame;
  35 struct SwPosition;
  36 class SwTextField;
  37 class SwDoc;
  38 class SwFormatField;
  39 class SetGetExpFields;
  40 class SwEditShell;
  41
  42 /// Forward declaration: get "BodyTextNode" for exp.fld in Fly's headers/footers/footnotes.
  43 const SwTextNode* GetBodyTextNode( const SwDoc& pDoc, SwPosition& rPos,
  44                                  const SwFrame& rFrame );
  45
  46 OUString ReplacePoint(const OUString& sTmpName, bool bWithCommandType = false);
  47
  48 struct SeqFieldLstElem
  49 {
  50     OUString sDlgEntry;
  51     sal_uInt16 nSeqNo;
  52
  53     SeqFieldLstElem( const OUString& rStr, sal_uInt16 nNo )
  54         : sDlgEntry( rStr ), nSeqNo( nNo )
  55     {}
  56 };
  57
  58 class SW_DLLPUBLIC SwSeqFieldList
  59 {
  60     std::vector<SeqFieldLstElem> maData;
  61 public:
  62     bool InsertSort(SeqFieldLstElem aNew);
  63     bool SeekEntry(const SeqFieldLstElem& rNew, size_t* pPos) const;
  64
  65     size_t Count() { return maData.size(); }
  66     SeqFieldLstElem& operator[](size_t nIndex) { return maData[nIndex]; }
  67     const SeqFieldLstElem& operator[](size_t nIndex) const { return maData[nIndex]; }
  68     void Clear() { maData.clear(); }
  69 };
  70
  71 class SAL_DLLPUBLIC_RTTI SwGetExpFieldType final : public SwValueFieldType
  72 {
  73 public:
  74     SwGetExpFieldType(SwDoc* pDoc);
  75     virtual std::unique_ptr<SwFieldType> Copy() const override;
  76
  77     /** Overlay, because get-field cannot be changed and therefore
  78      does not need to be updated. Update at changing of set-values! */
  79 private:
  80     virtual void Modify( const SfxPoolItem* pOld, const SfxPoolItem *pNew ) override;
  81 };
  82
  83 class SW_DLLPUBLIC SwGetExpField final : public SwFormulaField
  84 {
  85     double          m_fValueRLHidden; ///< SwValueField; hidden redlines
  86     OUString        m_sExpand;
  87     OUString        m_sExpandRLHidden; ///< hidden redlines
  88     bool            m_bIsInBodyText;
  89     sal_uInt16          m_nSubType;
  90
  91     bool            m_bLateInitialization; // #i82544#
  92
  93     virtual OUString    ExpandImpl(SwRootFrame const* pLayout) const override;
  94     virtual std::unique_ptr<SwField> Copy() const override;
  95     using SwFormulaField::GetValue; // hide it, don't use
  96     virtual void        SetValue(const double& rVal) override; // hide it
  97
  98 public:
  99     SwGetExpField( SwGetExpFieldType*, const OUString& rFormel,
 100                    sal_uInt16 nSubType, sal_uLong nFormat);
 101
 102     double      GetValue(SwRootFrame const* pLayout) const;
 103     void        SetValue(const double& rVal, SwRootFrame const* pLayout);
 104
 105     virtual void                SetLanguage(LanguageType nLng) override;
 106
 107     void                 ChgExpStr(const OUString& rExpand, SwRootFrame const* pLayout);
 108
 109     /// Called by formatting.
 110     inline bool                 IsInBodyText() const;
 111
 112     /// Set by UpdateExpFields where node position is known.
 113     inline void                 ChgBodyTextFlag( bool bIsInBody );
 114
 115     /** For fields in header/footer/footnotes/flys:
 116      Only called by formatting!! */
 117     void                        ChangeExpansion( const SwFrame&, const SwTextField& );
 118
 119     virtual OUString    GetFieldName() const override;
 120
 121     /// Change formula.
 122     virtual OUString GetPar2() const override;
 123     virtual void        SetPar2(const OUString& rStr) override;
 124
 125     virtual sal_uInt16  GetSubType() const override;
 126     virtual void        SetSubType(sal_uInt16 nType) override;
 127     virtual bool        QueryValue( css::uno::Any& rVal, sal_uInt16 nWhich ) const override;
 128     virtual bool        PutValue( const css::uno::Any& rVal, sal_uInt16 nWhich ) override;
 129
 130     static sal_Int32    GetReferenceTextPos( const SwFormatField& rFormat, SwDoc& rDoc, sal_Int32 nHint = 0);
 131     // #i82544#
 132     void                SetLateInitialization() { m_bLateInitialization = true;}
 133 };
 134
 135  /// Called by formatting.
 136 inline bool SwGetExpField::IsInBodyText() const
 137     { return m_bIsInBodyText; }
 138
 139  /// Set by UpdateExpFields where node position is known.
 140 inline void SwGetExpField::ChgBodyTextFlag( bool bIsInBody )
 141     { m_bIsInBodyText = bIsInBody; }
 142
 143 class SwSetExpField;
 144
 145 class SW_DLLPUBLIC SwSetExpFieldType final : public SwValueFieldType
 146 {
 147     OUString       m_sName;
 148     OUString      m_sDelim;
 149     sal_uInt16      m_nType;
 150     sal_uInt8       m_nLevel;
 151     bool        m_bDeleted;
 152
 153     virtual void Modify( const SfxPoolItem* pOld, const SfxPoolItem *pNew ) override;
 154
 155 public:
 156     SwSetExpFieldType( SwDoc* pDoc, const OUString& rName,
 157                         sal_uInt16 nType = nsSwGetSetExpType::GSE_EXPR );
 158     virtual std::unique_ptr<SwFieldType> Copy() const override;
 159     virtual OUString        GetName() const override;
 160
 161     inline void             SetType(sal_uInt16 nTyp);
 162     inline sal_uInt16       GetType() const;
 163
 164     void                    SetSeqFormat(sal_uLong nFormat);
 165     sal_uLong               GetSeqFormat() const;
 166
 167     bool                IsDeleted() const       { return m_bDeleted; }
 168     void                    SetDeleted( bool b )    { m_bDeleted = b; }
 169
 170     /// Overlay, because set-field takes care for its being updated by itself.
 171     inline const OUString&  GetSetRefName() const;
 172
 173     void   SetSeqRefNo( SwSetExpField& rField );
 174
 175     size_t GetSeqFieldList(SwSeqFieldList& rList, SwRootFrame const* pLayout);
 176
 177     /// Number sequence fields chapterwise if required.
 178     const OUString& GetDelimiter() const      { return m_sDelim; }
 179     void SetDelimiter( const OUString& s )    { m_sDelim = s; }
 180     sal_uInt8 GetOutlineLvl() const             { return m_nLevel; }
 181     void SetOutlineLvl( sal_uInt8 n )           { m_nLevel = n; }
 182     void SetChapter(SwSetExpField& rField, const SwNode& rNd, SwRootFrame const* pLayout);
 183
 184     virtual void        QueryValue( css::uno::Any& rVal, sal_uInt16 nWhich ) const override;
 185     virtual void        PutValue( const css::uno::Any& rVal, sal_uInt16 nWhich ) override;
 186 };
 187
 188 inline void SwSetExpFieldType::SetType( sal_uInt16 nTyp )
 189 {
 190         m_nType = nTyp;
 191         EnableFormat( !(m_nType & (nsSwGetSetExpType::GSE_SEQ|nsSwGetSetExpType::GSE_STRING)));
 192 }
 193
 194 inline sal_uInt16 SwSetExpFieldType::GetType() const
 195     { return m_nType;   }
 196
 197 inline const OUString& SwSetExpFieldType::GetSetRefName() const
 198     { return m_sName; }
 199
 200 class SW_DLLPUBLIC SwSetExpField : public SwFormulaField
 201 {
 202     double          m_fValueRLHidden; ///< SwValueField; hidden redlines
 203     OUString        msExpand;
 204     OUString        msExpandRLHidden; ///< hidden redlines
 205     OUString        maPText;
 206     bool            mbInput;
 207     sal_uInt16          mnSeqNo;
 208     sal_uInt16          mnSubType;
 209     SwFormatField * mpFormatField; /// pool item to which the SwSetExpField belongs
 210
 211     virtual OUString    ExpandImpl(SwRootFrame const* pLayout) const override;
 212     virtual std::unique_ptr<SwField> Copy() const override;
 213     using SwFormulaField::GetValue; // hide it, don't use
 214     virtual void        SetValue(const double& rVal) override; // hide it
 215
 216 public:
 217     SwSetExpField(SwSetExpFieldType*, const OUString& rFormel, sal_uLong nFormat = 0);
 218
 219     void SetFormatField(SwFormatField & rFormatField);
 220     SwFormatField* GetFormatField() { return mpFormatField;}
 221
 222     double      GetValue(SwRootFrame const* pLayout) const;
 223     void        SetValue(const double& rVal, SwRootFrame const* pLayout);
 224
 225     const OUString&      GetExpStr(SwRootFrame const* pLayout) const;
 226
 227     void                 ChgExpStr(const OUString& rExpand, SwRootFrame const* pLayout);
 228
 229     inline void                 SetPromptText(const OUString& rStr);
 230     inline const OUString&      GetPromptText() const;
 231
 232     inline void                 SetInputFlag(bool bInp);
 233     inline bool                 GetInputFlag() const;
 234
 235     virtual OUString            GetFieldName() const override;
 236
 237     virtual sal_uInt16              GetSubType() const override;
 238     virtual void                SetSubType(sal_uInt16 nType) override;
 239
 240     inline bool                 IsSequenceField() const;
 241
 242     /// Logical number, sequence fields.
 243     void                 SetSeqNumber( sal_uInt16 n )    { mnSeqNo = n; }
 244     sal_uInt16           GetSeqNumber() const        { return mnSeqNo; }
 245
 246     /// Query name only.
 247     virtual OUString       GetPar1()   const override;
 248
 249     /// Query formula.
 250     virtual OUString       GetPar2()   const override;
 251     virtual void                SetPar2(const OUString& rStr) override;
 252     virtual bool        QueryValue( css::uno::Any& rVal, sal_uInt16 nWhich ) const override;
 253     virtual bool        PutValue( const css::uno::Any& rVal, sal_uInt16 nWhich ) override;
 254 };
 255
 256 inline void  SwSetExpField::SetPromptText(const OUString& rStr)
 257     { maPText = rStr;        }
 258
 259 inline const OUString& SwSetExpField::GetPromptText() const
 260     { return maPText;        }
 261
 262 inline void SwSetExpField::SetInputFlag(bool bInp)
 263     { mbInput = bInp; }
 264
 265 inline bool SwSetExpField::GetInputFlag() const
 266     { return mbInput; }
 267
 268 inline bool SwSetExpField::IsSequenceField() const
 269     { return 0 != (nsSwGetSetExpType::GSE_SEQ & static_cast<SwSetExpFieldType*>(GetTyp())->GetType()); }
 270
 271 class SAL_DLLPUBLIC_RTTI SwInputFieldType final : public SwFieldType
 272 {
 273     SwDoc* mpDoc;
 274 public:
 275     SwInputFieldType( SwDoc* pDoc );
 276
 277     virtual std::unique_ptr<SwFieldType> Copy() const override;
 278
 279     SwDoc* GetDoc() const { return mpDoc; }
 280 };
 281
 282 class SW_DLLPUBLIC SwInputField final : public SwField
 283 {
 284     mutable OUString maContent;
 285     OUString maPText;
 286     OUString maHelp;
 287     OUString maToolTip;
 288     sal_uInt16 mnSubType;
 289     bool mbIsFormField;
 290
 291     SwFormatField* mpFormatField; // attribute to which the <SwInputField> belongs to
 292
 293     virtual OUString    ExpandImpl(SwRootFrame const* pLayout) const override;
 294     virtual std::unique_ptr<SwField> Copy() const override;
 295
 296     // Accessing Input Field's content
 297     const OUString& getContent() const { return maContent;}
 298
 299 public:
 300     /// Direct input via dialog; delete old value.
 301     SwInputField(
 302         SwInputFieldType* pFieldType,
 303         const OUString& rContent,
 304         const OUString& rPrompt,
 305         sal_uInt16 nSubType,
 306         sal_uLong nFormat = 0,
 307         bool bIsFormField = true );
 308     virtual ~SwInputField() override;
 309
 310     void SetFormatField( SwFormatField& rFormatField );
 311     SwFormatField* GetFormatField() { return mpFormatField;}
 312
 313     // Providing new Input Field's content:
 314     // Fill Input Field's content depending on <nSupType>.
 315     void applyFieldContent( const OUString& rNewFieldContent );
 316
 317     bool isFormField() const;
 318
 319     virtual OUString        GetFieldName() const override;
 320
 321     /// Content
 322     virtual OUString        GetPar1() const override;
 323     virtual void            SetPar1(const OUString& rStr) override;
 324
 325     /// aPromptText
 326     virtual OUString        GetPar2() const override;
 327     virtual void            SetPar2(const OUString& rStr) override;
 328
 329     const OUString&         GetHelp() const;
 330     void                    SetHelp(const OUString & rStr);
 331
 332     const OUString&         GetToolTip() const;
 333     void                    SetToolTip(const OUString & rStr);
 334
 335     virtual sal_uInt16      GetSubType() const override;
 336     virtual void            SetSubType(sal_uInt16 nSub) override;
 337     virtual bool        QueryValue( css::uno::Any& rVal, sal_uInt16 nWhich ) const override;
 338     virtual bool        PutValue( const css::uno::Any& rVal, sal_uInt16 nWhich ) override;
 339 };
 340
 341 // Sorted list of input fields and DropDown fields
 342 class SwInputFieldList
 343 {
 344 public:
 345     SwInputFieldList( SwEditShell* pShell, bool bBuildTmpLst = false );
 346     ~SwInputFieldList();
 347
 348     size_t      Count() const;
 349     SwField*    GetField(size_t nId);
 350
 351     void        GotoFieldPos(size_t nId);
 352     void        PushCursor();
 353     void        PopCursor();
 354
 355     /** Put all that are new into SortList for updating. @return true if not empty.
 356      (For Glossary: only update its input-fields).
 357      Compare TmpLst with current fields. */
 358     bool        BuildSortLst();
 359
 360 private:
 361     SwEditShell*                      mpSh;
 362     std::unique_ptr<SetGetExpFields>  mpSrtLst;
 363     o3tl::sorted_vector<const SwTextField*> maTmpLst;
 364 };
 365
 366  /// Implementation in tblcalc.cxx.
 367 class SwTableFieldType final : public SwValueFieldType
 368 {
 369 public:
 370     SwTableFieldType(SwDoc* pDocPtr);
 371     virtual std::unique_ptr<SwFieldType> Copy() const override;
 372 };
 373
 374 class SwTableField final : public SwValueField, public SwTableFormula
 375 {
 376     OUString      m_sExpand;
 377     sal_uInt16      m_nSubType;
 378
 379     virtual OUString    ExpandImpl(SwRootFrame const* pLayout) const override;
 380     virtual std::unique_ptr<SwField> Copy() const override;
 381
 382     /// Search TextNode containing the field.
 383     virtual const SwNode* GetNodeOfFormula() const override;
 384
 385     OUString GetCommand();
 386
 387 public:
 388     SwTableField( SwTableFieldType*, const OUString& rFormel,
 389                 sal_uInt16 nSubType, sal_uLong nFormat);
 390
 391     virtual void        SetValue( const double& rVal ) override;
 392     virtual sal_uInt16  GetSubType() const override;
 393     virtual void        SetSubType(sal_uInt16 nType) override;
 394
 395     void                ChgExpStr(const OUString& rStr) { m_sExpand = rStr; }
 396
 397     void                CalcField( SwTableCalcPara& rCalcPara );
 398
 399     virtual OUString    GetFieldName() const override;
 400
 401     /// The formula.
 402     virtual OUString GetPar2()   const override;
 403     virtual void        SetPar2(const OUString& rStr) override;
 404     virtual bool        QueryValue( css::uno::Any& rVal, sal_uInt16 nWhich ) const override;
 405     virtual bool        PutValue( const css::uno::Any& rVal, sal_uInt16 nWhich ) override;
 406 };
 407
 408 #endif // INCLUDED_SW_INC_EXPFLD_HXX
 409
 410 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */