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