sw/inc/IDocumentFieldsAccess.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 <sal/config.h>
  23
  24 #include <rtl/ustring.hxx>
  25 #include <sal/types.h>
  26 #include "swtypes.hxx"
  27 #include "nodeoffset.hxx"
  28 #include <unordered_map>
  29
  30 class SwFieldTypes;
  31 class SwFieldType;
  32 class SfxPoolItem;
  33 struct SwPosition;
  34 class SwDocUpdateField;
  35 class SwCalc;
  36 class SwTextField;
  37 class SwField;
  38 class SwMsgPoolItem;
  39 class DateTime;
  40 class SetGetExpField;
  41 class SwNode;
  42 class SwTable;
  43 enum class SwFieldIds : sal_uInt16;
  44 class SwRootFrame;
  45 class IDocumentRedlineAccess;
  46
  47 namespace com::sun::star::uno { class Any; }
  48
  49  /** Document fields related interfaces
  50  */
  51  class IDocumentFieldsAccess
  52  {
  53  public:
  54     virtual const SwFieldTypes *GetFieldTypes() const = 0;
  55
  56     virtual SwFieldType *InsertFieldType(const SwFieldType &) = 0;
  57
  58     virtual SwFieldType *GetSysFieldType( const SwFieldIds eWhich ) const = 0;
  59
  60     virtual SwFieldType* GetFieldType(SwFieldIds nResId, const OUString& rName, bool bDbFieldMatching) const = 0;
  61
  62     virtual void RemoveFieldType(size_t nField) = 0;
  63
  64     virtual void UpdateFields(bool bCloseDB) = 0;
  65
  66     virtual void InsDeletedFieldType(SwFieldType &) = 0;
  67
  68     /**
  69        Puts a value into a field at a certain position.
  70
  71        A missing field at the given position leads to a failure.
  72
  73        @param rPosition        position of the field
  74        @param rVal             the value
  75        @param nMId
  76
  77        @retval true            putting of value was successful
  78        @retval false           else
  79     */
  80     virtual void PutValueToField(const SwPosition & rPos, const css::uno::Any& rVal, sal_uInt16 nWhich) = 0;
  81
  82     // Call update of expression fields. All expressions are re-evaluated.
  83
  84     /** Updates a field.
  85
  86         @param rDstFormatField field to update
  87         @param rSrcField field containing the new values
  88         @param pMsgHint
  89         @param bUpdateTableFields TRUE: update table fields, too.
  90
  91         @retval true             update was successful
  92         @retval false            else
  93     */
  94     virtual bool UpdateField(SwTextField * rDstFormatField, SwField & rSrcField, bool bUpdateTableFields) = 0;
  95
  96     virtual void UpdateRefFields() = 0;
  97
  98     virtual void UpdateTableFields(const SwTable* pTable) = 0;
  99
 100     virtual void UpdateExpFields(SwTextField* pField, bool bUpdateRefFields) = 0;
 101
 102     virtual void UpdateUsrFields() = 0;
 103
 104     virtual void UpdatePageFields(const SwTwips) = 0;
 105
 106     virtual void LockExpFields() = 0;
 107
 108     virtual void UnlockExpFields() = 0;
 109
 110     virtual bool IsExpFieldsLocked() const = 0;
 111
 112     virtual SwDocUpdateField& GetUpdateFields() const = 0;
 113
 114     /*  @@@MAINTAINABILITY-HORROR@@@
 115         SwNode (see parameter pChk) is (?) part of the private
 116         data structure of SwDoc and should not be exposed
 117     */
 118     virtual bool SetFieldsDirty(bool b, const SwNode* pChk, SwNodeOffset nLen) = 0;
 119
 120     virtual void SetFixFields(const DateTime* pNewDateTime) = 0;
 121
 122     // In Calculator set all SetExpression fields that are valid up to the indicated position
 123     // (Node [ + css::ucb::Content]).
 124     // A generated list of all fields may be passed along too
 125     // (if the address != 0 and the pointer == 0 a new list will be returned).
 126     virtual void FieldsToCalc(SwCalc& rCalc, SwNodeOffset nLastNd, sal_Int32 nLastCnt) = 0;
 127
 128     virtual void FieldsToCalc(SwCalc& rCalc, const SetGetExpField& rToThisField, SwRootFrame const* pLayout) = 0;
 129
 130     virtual void FieldsToExpand(std::unordered_map<OUString,OUString> & rTable, const SetGetExpField& rToThisField, SwRootFrame const& rLayout) = 0;
 131
 132     virtual bool IsNewFieldLst() const = 0;
 133
 134     virtual void SetNewFieldLst( bool bFlag) = 0;
 135
 136     virtual void InsDelFieldInFieldLst(bool bIns, const SwTextField& rField) = 0;
 137
 138     virtual sal_Int32 GetRecordsPerDocument() const = 0;
 139
 140 protected:
 141     virtual ~IDocumentFieldsAccess() {};
 142  };
 143
 144 namespace sw {
 145 bool IsFieldDeletedInModel(IDocumentRedlineAccess const& rIDRA,
 146         SwTextField const& rTextField);
 147 }
 148
 149 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */