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