diff options
Diffstat (limited to 'sw/inc/IDocumentFieldsAccess.hxx')
-rw-r--r-- | sw/inc/IDocumentFieldsAccess.hxx | 194 |
1 files changed, 194 insertions, 0 deletions
diff --git a/sw/inc/IDocumentFieldsAccess.hxx b/sw/inc/IDocumentFieldsAccess.hxx new file mode 100644 index 000000000000..00ee1283874f --- /dev/null +++ b/sw/inc/IDocumentFieldsAccess.hxx @@ -0,0 +1,194 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2008 by Sun Microsystems, Inc. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * $RCSfile: IDocumentFieldsAccess.hxx,v $ + * $Revision: 1.6 $ + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef IDOCUMENTFIELDSACCESS_HXX_INCLUDED +#define IDOCUMENTFIELDSACCESS_HXX_INCLUDED + +#include <sal/types.h> +#include <tools/solar.h> + +class SwFldTypes; +class SwFieldType; +class SfxPoolItem; +struct SwPosition; +class SwDocUpdtFld; +class SwCalc; +class SwTxtFld; +class SwField; +class SwMsgPoolItem; +class DateTime; +class _SetGetExpFld; +struct SwHash; +class String; +class SwNode; + +namespace com { namespace sun { namespace star { namespace uno { class Any; } } } } + + /** Document fields related interfaces + */ + class IDocumentFieldsAccess + { + public: + /** + */ + virtual const SwFldTypes *GetFldTypes() const = 0; + + /** + */ + virtual SwFieldType *InsertFldType(const SwFieldType &) = 0; + + /** + */ + virtual SwFieldType *GetSysFldType( const sal_uInt16 eWhich ) const = 0; + + /** + */ + virtual SwFieldType* GetFldType(sal_uInt16 nResId, const String& rName, bool bDbFieldMatching) const = 0; + + /** + */ + virtual void RemoveFldType(sal_uInt16 nFld) = 0; + + /** + */ + virtual void UpdateFlds( SfxPoolItem* pNewHt, bool bCloseDB) = 0; + + /** + */ + virtual void InsDeletedFldType(SwFieldType &) = 0; + + // #111840# + /** + Puts a value into a field at a certain position. + + A missing field at the given position leads to a failure. + + @param rPosition position of the field + @param rVal the value + @param nMId + + @retval TRUE putting of value was successful + @retval FALSE else + */ + virtual bool PutValueToField(const SwPosition & rPos, const com::sun::star::uno::Any& rVal, USHORT nWhich) = 0; + + // rufe das Update der Expression Felder auf; alle Ausdruecke werden + // neu berechnet. + // #111840# + + /** Updates a field. + + @param rDstFmtFld field to update + @param rSrcFld field containing the new values + @param pMsgHnt + @param bUpdateTblFlds TRUE: update table fields, too. + + @retval TRUE update was successful + @retval FALSE else + */ + virtual bool UpdateFld(SwTxtFld * rDstFmtFld, SwField & rSrcFld, SwMsgPoolItem * pMsgHnt, bool bUpdateTblFlds) = 0; + + /** + */ + virtual void UpdateRefFlds(SfxPoolItem* pHt) = 0; + + /** + */ + virtual void UpdateTblFlds(SfxPoolItem* pHt) = 0; + + /** + */ + virtual void UpdateExpFlds(SwTxtFld* pFld, bool bUpdateRefFlds) = 0; + + /** + */ + virtual void UpdateUsrFlds() = 0; + + /** + */ + virtual void UpdatePageFlds(SfxPoolItem*) = 0; + + /** + */ + virtual void LockExpFlds() = 0; + + /** + */ + virtual void UnlockExpFlds() = 0; + + /** + */ + virtual bool IsExpFldsLocked() const = 0; + + + virtual SwDocUpdtFld& GetUpdtFlds() const = 0; + + /* @@@MAINTAINABILITY-HORROR@@@ + SwNode (see parameter pChk) is (?) part of the private + data structure of SwDoc and should not be exposed + */ + virtual bool SetFieldsDirty(bool b, const SwNode* pChk, ULONG nLen) = 0; + + /** + */ + virtual void SetFixFields(bool bOnlyTimeDate, const DateTime* pNewDateTime) = 0; + + // Setze im Calculator alle SetExpresion Felder, die bis zur + // angegebenen Position (Node [ + ::com::sun::star::ucb::Content]) gueltig sind. Es kann + // eine erzeugte Liste aller Felder mit uebergegeben werden. + // (ist die Adresse != 0, und der Pointer == 0 wird eine neue + // Liste returnt.) + virtual void FldsToCalc(SwCalc& rCalc, ULONG nLastNd, sal_uInt16 nLastCnt) = 0; + + /** + */ + virtual void FldsToCalc(SwCalc& rCalc, const _SetGetExpFld& rToThisFld) = 0; + + /** + */ + virtual void FldsToExpand(SwHash**& ppTbl, sal_uInt16& rTblSize, const _SetGetExpFld& rToThisFld) = 0; + + /** + */ + virtual bool IsNewFldLst() const = 0; + + /** + */ + virtual void SetNewFldLst( bool bFlag) = 0; + + /** + */ + virtual void InsDelFldInFldLst(bool bIns, const SwTxtFld& rFld) = 0; + +protected: + virtual ~IDocumentFieldsAccess() {}; + }; + + #endif // IDOCUMENTLINKSADMINISTRATION_HXX_INCLUDED |