office-gobmx/sw/inc/reffld.hxx
Oliver Bolte 15cf0106ac INTEGRATION: CWS swcrossref01_DEV300 (1.6.464); FILE MERGED
2008/01/09 10:13:33 od 1.6.464.8: #i85090# class <SwGetRefField>
	 - new method <GetExpandedTxtOfReferencedTxtNode()>
2007/12/03 13:44:08 od 1.6.464.7: #i83479# adjustment due to exported class <SwGetrefField>
2007/12/03 13:18:28 od 1.6.464.6: #i83479# class <SwGetRefField>
	 - export class
	 - introduce destructor
2007/11/22 13:36:19 od 1.6.464.5: #i83479# class <SwGetRefField>
	 - new methods <IsRefToHeadingCrossRefBookmark()>,
	   <IsRefToNumItemCrossRefBookmark()> and <GetReferencedTxtNode()>
2007/10/02 09:34:47 od 1.6.464.4: #i81002# method <SwGetRefField::MakeRefNumStr(..)>
	 - rename parameter to avoid variable hiding
2007/10/01 11:11:58 od 1.6.464.3: RESYNC: (1.6-1.7); FILE MERGED
2007/09/28 10:01:06 od 1.6.464.2: #i81002# method <SwGetRefField::MakeRefNumStr(..)> now constant
2007/09/17 12:05:41 od 1.6.464.1: #i81002# - enumeration <REFERENCEMARK>
	 -- extend by new reference format types NUMBER, NUMBER_NO_CONTEXT,
	   NUMBER_FULL_CONTEXT
	 - class <SwGetRefField>
	 -- new method <MakeRefNumStr(..)> for new reference format types
	 -- add parameter to method <UpdateField(..)>
2008-02-26 09:31:31 +00:00

172 lines
5.3 KiB
C++

/*************************************************************************
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: reffld.hxx,v $
*
* $Revision: 1.8 $
*
* last change: $Author: obo $ $Date: 2008-02-26 10:31:31 $
*
* The Contents of this file are made available subject to
* the terms of GNU Lesser General Public License Version 2.1.
*
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2005 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
************************************************************************/
#ifndef _REFFLD_HXX
#define _REFFLD_HXX
#ifndef _FLDBAS_HXX
#include <fldbas.hxx>
#endif
class SfxPoolItem;
class SwDoc;
class SwTxtNode;
class SwTxtFld;
enum REFERENCESUBTYPE
{
REF_SETREFATTR = 0,
REF_SEQUENCEFLD,
REF_BOOKMARK,
REF_OUTLINE,
REF_FOOTNOTE,
REF_ENDNOTE
};
enum REFERENCEMARK
{
REF_BEGIN,
REF_PAGE = REF_BEGIN,
REF_CHAPTER,
REF_CONTENT,
REF_UPDOWN,
REF_PAGE_PGDESC,
REF_ONLYNUMBER,
REF_ONLYCAPTION,
REF_ONLYSEQNO,
// --> OD 2007-08-24 #i81002#
// new reference format types for referencing bookmarks and set references
REF_NUMBER,
REF_NUMBER_NO_CONTEXT,
REF_NUMBER_FULL_CONTEXT,
// <--
REF_END
};
/*--------------------------------------------------------------------
Beschreibung: Referenz holen
--------------------------------------------------------------------*/
class SwGetRefFieldType : public SwFieldType
{
SwDoc* pDoc;
public:
SwGetRefFieldType(SwDoc* pDoc );
virtual SwFieldType* Copy() const;
SwDoc* GetDoc() const { return pDoc; }
// ueberlagert, um alle Ref-Felder zu updaten
virtual void Modify( SfxPoolItem *, SfxPoolItem * );
void MergeWithOtherDoc( SwDoc& rDestDoc );
static SwTxtNode* FindAnchor( SwDoc* pDoc, const String& rRefMark,
USHORT nSubType, USHORT nSeqNo,
USHORT* pStt, USHORT* pEnd = 0 );
};
/*--------------------------------------------------------------------
Beschreibung: Referenzfeld
--------------------------------------------------------------------*/
class SW_DLLPUBLIC SwGetRefField : public SwField
{
private:
String sSetRefName;
String sTxt;
USHORT nSubType;
USHORT nSeqNo;
// --> OD 2007-08-24 #i81002#
String MakeRefNumStr( const SwTxtNode& rTxtNodeOfField,
const SwTxtNode& rTxtNodeOfReferencedItem,
const sal_uInt32 nRefNumFormat ) const;
// <--
public:
SwGetRefField( SwGetRefFieldType*, const String& rSetRef,
USHORT nSubType, USHORT nSeqNo, ULONG nFmt );
virtual ~SwGetRefField();
virtual String GetCntnt(BOOL bName = FALSE) const;
virtual String Expand() const;
virtual SwField* Copy() const;
const String& GetSetRefName() const { return sSetRefName; }
// --> OD 2007-09-06 #i81002#
// The <SwTxtFld> instance, which represents the text attribute for the
// <SwGetRefField> instance, has to be passed to the method.
// This <SwTxtFld> instance is needed for the reference format type REF_UPDOWN
// and REF_NUMBER.
// Note: This instance may be NULL (field in Undo/Redo). This will cause
// no update for these reference format types.
void UpdateField( const SwTxtFld* pFldTxtAttr );
// <--
void SetExpand( const String& rStr ) { sTxt = rStr; }
// SubType erfragen/setzen
virtual USHORT GetSubType() const;
virtual void SetSubType( USHORT n );
// --> OD 2007-11-09 #i81002#
bool IsRefToHeadingCrossRefBookmark() const;
bool IsRefToNumItemCrossRefBookmark() const;
const SwTxtNode* GetReferencedTxtNode() const;
// <--
// --> OD 2008-01-09 #i85090#
String GetExpandedTxtOfReferencedTxtNode() const;
// <--
// SequenceNo erfragen/setzen (nur fuer REF_SEQUENCEFLD interressant)
USHORT GetSeqNo() const { return nSeqNo; }
void SetSeqNo( USHORT n ) { nSeqNo = n; }
// Name der Referenz
virtual const String& GetPar1() const;
virtual void SetPar1(const String& rStr);
virtual String GetPar2() const;
virtual BOOL QueryValue( com::sun::star::uno::Any& rVal, USHORT nWhichId ) const;
virtual BOOL PutValue( const com::sun::star::uno::Any& rVal, USHORT nWhichId );
void ConvertProgrammaticToUIName();
virtual String GetDescription() const;
};
#endif // _REFFLD_HXX