/************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite * * 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 * * for a copy of the LGPLv3 License. * ************************************************************************/ #ifndef _DOCUFLD_HXX #define _DOCUFLD_HXX #include #include #include #include "fldbas.hxx" #include "numrule.hxx" class _SetGetExpFlds; class SwTxtFld; class SwFrm; class OutlinerParaObject; class SwTextAPIObject; enum SwAuthorFormat { AF_BEGIN, AF_NAME = AF_BEGIN, AF_SHORTCUT, AF_END, AF_FIXED = 0x8000 }; /*-------------------------------------------------------------------- Beschreibung: Untertyp der Dokumentstatistik --------------------------------------------------------------------*/ enum SwDocStatSubType { DS_BEGIN, DS_PAGE = DS_BEGIN, DS_PARA, DS_WORD, DS_CHAR, DS_TBL, DS_GRF, DS_OLE, DS_END }; typedef sal_uInt16 SwDocInfoSubType; namespace nsSwDocInfoSubType { // NB: these must denote consecutive integers! // NB2: these are extended by 4 DI_INFO values for backward compatibility // in filter/html/htmlfld.cxx, so make sure that DI_SUBTYPE_END // really is the end, and is at least 4 less than DI_SUB_*! const SwDocInfoSubType DI_SUBTYPE_BEGIN = 0; const SwDocInfoSubType DI_TITEL = DI_SUBTYPE_BEGIN; const SwDocInfoSubType DI_THEMA = 1; const SwDocInfoSubType DI_KEYS = 2; const SwDocInfoSubType DI_COMMENT = 3; const SwDocInfoSubType DI_CREATE = 4; const SwDocInfoSubType DI_CHANGE = 5; const SwDocInfoSubType DI_PRINT = 6; const SwDocInfoSubType DI_DOCNO = 7; const SwDocInfoSubType DI_EDIT = 8; const SwDocInfoSubType DI_CUSTOM = 9; const SwDocInfoSubType DI_SUBTYPE_END = 10; const SwDocInfoSubType DI_SUB_AUTHOR = 0x0100; const SwDocInfoSubType DI_SUB_TIME = 0x0200; const SwDocInfoSubType DI_SUB_DATE = 0x0300; const SwDocInfoSubType DI_SUB_FIXED = 0x1000; const SwDocInfoSubType DI_SUB_MASK = 0xff00; } enum RegInfoFormat // Nur noch zum laden alter Dokumente!!! { RF_AUTHOR, RF_TIME, RF_DATE, RF_ALL }; enum SwPageNumSubType { PG_RANDOM, PG_NEXT, PG_PREV }; enum SwExtUserSubType { EU_COMPANY /*EU_FIRMA*/, EU_FIRSTNAME /*EU_VORNAME*/, EU_NAME /*EU_NAME*/, EU_SHORTCUT /*EU_ABK*/, EU_STREET /*EU_STRASSE*/, EU_COUNTRY /*EU_LAND*/, EU_ZIP /*EU_PLZ*/, EU_CITY /*EU_ORT*/, EU_TITLE /*EU_TITEL*/, EU_POSITION /*EU_POS*/, EU_PHONE_PRIVATE /*EU_TELPRIV*/, EU_PHONE_COMPANY /*EU_TELFIRMA*/, EU_FAX, EU_EMAIL, EU_STATE, EU_FATHERSNAME, EU_APARTMENT }; enum SwJumpEditFormat { JE_FMT_TEXT, JE_FMT_TABLE, JE_FMT_FRAME, JE_FMT_GRAPHIC, JE_FMT_OLE }; /*-------------------------------------------------------------------- Beschreibung: Seitennummer --------------------------------------------------------------------*/ class SwPageNumberFieldType : public SwFieldType { sal_Int16 nNumberingType; USHORT nNum, nMax; BOOL bVirtuell; public: SwPageNumberFieldType(); String& Expand( sal_uInt32 nFmt, short nOff, const String&, String& rRet ) const; void ChangeExpansion( SwDoc* pDoc, USHORT nNum, USHORT nMax, BOOL bVirtPageNum, const sal_Int16* pNumFmt = 0 ); virtual SwFieldType* Copy() const; }; /*-------------------------------------------------------------------- Beschreibung: Seitennummerierung --------------------------------------------------------------------*/ class SW_DLLPUBLIC SwPageNumberField : public SwField { String sUserStr; USHORT nSubType; short nOffset; public: SwPageNumberField(SwPageNumberFieldType*, USHORT nSub = PG_RANDOM, sal_uInt32 nFmt = 0, short nOff = 0); virtual String Expand() const; virtual SwField* Copy() const; virtual String GetPar2() const; virtual void SetPar2(const String& rStr); virtual USHORT GetSubType() const; // virtual void SetSubType(USHORT nSub); // OM: entfernt, da unbenoetigt und gefaehrlich virtual BOOL QueryValue( com::sun::star::uno::Any& rVal, USHORT nWhich ) const; virtual BOOL PutValue( const com::sun::star::uno::Any& rVal, USHORT nWhich ); const String& GetUserString() const { return sUserStr; } void SetUserString( const String& rS ) { sUserStr = rS; } }; /*-------------------------------------------------------------------- Beschreibung: Autoren --------------------------------------------------------------------*/ class SwAuthorFieldType : public SwFieldType { public: SwAuthorFieldType(); String Expand(ULONG) const; virtual SwFieldType* Copy() const; }; /*-------------------------------------------------------------------- Beschreibung: AutorenFeld --------------------------------------------------------------------*/ class SwAuthorField : public SwField { String aContent; public: SwAuthorField(SwAuthorFieldType*, sal_uInt32 nFmt = 0); virtual String Expand() const; virtual SwField* Copy() const; inline void SetExpansion(const String& rStr) { aContent = rStr; } inline const String& GetContent() const { return aContent; } virtual BOOL QueryValue( com::sun::star::uno::Any& rVal, USHORT nWhich ) const; virtual BOOL PutValue( const com::sun::star::uno::Any& rVal, USHORT nWhich ); }; /*-------------------------------------------------------------------- Beschreibung: Filename --------------------------------------------------------------------*/ class SwFileNameFieldType : public SwFieldType { SwDoc *pDoc; public: SwFileNameFieldType(SwDoc*); String Expand(ULONG) const; virtual SwFieldType* Copy() const; }; /*-------------------------------------------------------------------- Beschreibung: FileName --------------------------------------------------------------------*/ class SW_DLLPUBLIC SwFileNameField : public SwField { String aContent; public: SwFileNameField(SwFileNameFieldType*, sal_uInt32 nFmt = 0); virtual String Expand() const; virtual SwField* Copy() const; inline void SetExpansion(const String& rStr) { aContent = rStr; } inline const String& GetContent() const { return aContent; } virtual BOOL QueryValue( com::sun::star::uno::Any& rVal, USHORT nWhich ) const; virtual BOOL PutValue( const com::sun::star::uno::Any& rVal, USHORT nWhich ); }; /*-------------------------------------------------------------------- Beschreibung: TemplName --------------------------------------------------------------------*/ class SwTemplNameFieldType : public SwFieldType { SwDoc *pDoc; public: SwTemplNameFieldType(SwDoc*); String Expand(ULONG) const; virtual SwFieldType* Copy() const; }; /*-------------------------------------------------------------------- Beschreibung: TemplName --------------------------------------------------------------------*/ class SW_DLLPUBLIC SwTemplNameField : public SwField { public: SwTemplNameField(SwTemplNameFieldType*, sal_uInt32 nFmt = 0); virtual String Expand() const; virtual SwField* Copy() const; virtual BOOL QueryValue( com::sun::star::uno::Any& rVal, USHORT nWhich ) const; virtual BOOL PutValue( const com::sun::star::uno::Any& rVal, USHORT nWhich ); }; /*-------------------------------------------------------------------- Beschreibung: Docstatistik --------------------------------------------------------------------*/ class SwDocStatFieldType : public SwFieldType { SwDoc* pDoc; sal_Int16 nNumberingType;//com::sun::star::style::NumberingType public: SwDocStatFieldType(SwDoc*); String Expand(USHORT nSubType, sal_uInt32 nFmt) const; virtual SwFieldType* Copy() const; inline void SetNumFormat( sal_Int16 eFmt ) { nNumberingType = eFmt; } }; /*-------------------------------------------------------------------- Beschreibung: Dokumentstatistik --------------------------------------------------------------------*/ class SW_DLLPUBLIC SwDocStatField : public SwField { USHORT nSubType; public: SwDocStatField( SwDocStatFieldType*, USHORT nSubType = 0, sal_uInt32 nFmt = 0); void ChangeExpansion( const SwFrm* pFrm ); virtual String Expand() const; virtual SwField* Copy() const; virtual USHORT GetSubType() const; virtual void SetSubType(USHORT nSub); virtual BOOL QueryValue( com::sun::star::uno::Any& rVal, USHORT nWhich ) const; virtual BOOL PutValue( const com::sun::star::uno::Any& rVal, USHORT nWhich ); }; /*-------------------------------------------------------------------- Beschreibung: versteckter Text --------------------------------------------------------------------*/ class SwHiddenTxtFieldType : public SwFieldType { BOOL bHidden; public: SwHiddenTxtFieldType(BOOL bSetHidden = TRUE); virtual SwFieldType* Copy() const; void SetHiddenFlag( BOOL bSetHidden = TRUE ); inline BOOL GetHiddenFlag() const { return bHidden; } }; /*-------------------------------------------------------------------- Beschreibung: Versteckter Text --------------------------------------------------------------------*/ class SwHiddenTxtField : public SwField { String aTRUETxt; // Text wenn Bedingung TRUE String aFALSETxt; // Wenn Bedingung falsch String aContent; // Ausgewerteter DB-Text String aCond; // Bedingung USHORT nSubType; BOOL bCanToggle : 1; // kann das Feld einzeln getoggelt werden? BOOL bIsHidden : 1; // ist es nicht sichtbar? BOOL bValid : 1; // DB-Feld evaluiert? public: SwHiddenTxtField( SwHiddenTxtFieldType*, BOOL bConditional, const String& rCond, const String& rTxt, BOOL bHidden = FALSE, USHORT nSubType = TYP_HIDDENTXTFLD); SwHiddenTxtField( SwHiddenTxtFieldType*, const String& rCond, const String& rTrue, const String& rFalse, USHORT nSubType = TYP_HIDDENTXTFLD); virtual String GetCntnt(BOOL bName = FALSE) const; virtual String Expand() const; virtual SwField* Copy() const; void Evaluate(SwDoc*); inline void SetValue(BOOL bHidden) { bIsHidden = bHidden; } String GetColumnName(const String& rName); String GetDBName(const String& rName, SwDoc *pDoc); // Condition virtual void SetPar1(const String& rStr); virtual const String& GetPar1() const; // True/False - String virtual void SetPar2(const String& rStr); virtual String GetPar2() const; virtual USHORT GetSubType() const; // virtual void SetSubType(USHORT nSub); // OM: entfernt, da unbenoetigt und gefaehrlich virtual BOOL QueryValue( com::sun::star::uno::Any& rVal, USHORT nWhich ) const; virtual BOOL PutValue( const com::sun::star::uno::Any& rVal, USHORT nWhich ); }; /*-------------------------------------------------------------------- Beschreibung: Feld das zu einer Leerzeile (ohne Hoehe) expandiert --------------------------------------------------------------------*/ class SwHiddenParaFieldType : public SwFieldType { public: SwHiddenParaFieldType(); virtual SwFieldType* Copy() const; }; /*-------------------------------------------------------------------- Beschreibung: Versteckter Absatz --------------------------------------------------------------------*/ class SwHiddenParaField : public SwField { String aCond; BOOL bIsHidden:1; public: // Direkte Eingabe alten Wert loeschen SwHiddenParaField(SwHiddenParaFieldType*, const String& rCond); virtual String Expand() const; virtual SwField* Copy() const; void SetHidden(BOOL bHidden) { bIsHidden = bHidden; } BOOL IsHidden() const { return bIsHidden; } // Bedingung erfragen/setzen virtual const String& GetPar1() const; virtual void SetPar1(const String& rStr); virtual BOOL QueryValue( com::sun::star::uno::Any& rVal, USHORT nWhich ) const; virtual BOOL PutValue( const com::sun::star::uno::Any& rVal, USHORT nWhich ); }; /*-------------------------------------------------------------------- Beschreibung: Macro ausfuehren --------------------------------------------------------------------*/ class SwMacroFieldType : public SwFieldType { SwDoc* pDoc; public: SwMacroFieldType(SwDoc*); virtual SwFieldType* Copy() const; }; /*-------------------------------------------------------------------- Beschreibung: Macrofeld --------------------------------------------------------------------*/ class SW_DLLPUBLIC SwMacroField : public SwField { String aMacro; String aText; BOOL bIsScriptURL; public: // Direkte Eingabe alten Wert loeschen SwMacroField( SwMacroFieldType*, const String& rLibAndName, const String& rTxt); inline const String& GetMacro() const { return aMacro; } String GetLibName() const; String GetMacroName() const; SvxMacro GetSvxMacro() const; virtual String GetCntnt(BOOL bName = FALSE) const; virtual String Expand() const; virtual SwField* Copy() const; // Library und FileName virtual const String& GetPar1() const; virtual void SetPar1(const String& rStr); // Macrotext virtual String GetPar2() const; virtual void SetPar2(const String& rStr); virtual BOOL QueryValue( com::sun::star::uno::Any& rVal, USHORT nWhich ) const; virtual BOOL PutValue( const com::sun::star::uno::Any& rVal, USHORT nWhich ); static void CreateMacroString( String& rMacro, const String& rMacroName, const String& rLibraryName ); static BOOL isScriptURL( const String& str ); }; /*-------------------------------------------------------------------- Beschreibung: PostIts --------------------------------------------------------------------*/ class SwPostItFieldType : public SwFieldType { private: SwDoc* mpDoc; public: SwPostItFieldType(SwDoc* pDoc); virtual SwFieldType* Copy() const; SwDoc* GetDoc() {return mpDoc;}; }; /*-------------------------------------------------------------------- Beschreibung: PostIt --------------------------------------------------------------------*/ class SW_DLLPUBLIC SwPostItField : public SwField { String sTxt; // die Anmerkung String sAuthor; // der Author DateTime aDateTime; // Datum und Zeit der Anmerkung OutlinerParaObject* mpText; SwTextAPIObject* m_pTextObject; public: SwPostItField( SwPostItFieldType*, const String& rAuthor, const String& rTxt, const DateTime& rDate); ~SwPostItField(); virtual String Expand() const; virtual SwField* Copy() const; inline const Date GetDate() const { return aDateTime.GetDate(); } inline const Time GetTime() const { return aDateTime.GetTime(); } // Author virtual const String& GetPar1() const; virtual void SetPar1(const String& rStr); // Text virtual String GetPar2() const; virtual void SetPar2(const String& rStr); const String& GetTxt() const { return sTxt; } const OutlinerParaObject* GetTextObject() const; void SetTextObject( OutlinerParaObject* pText ); sal_uInt32 GetNumberOfParagraphs() const; virtual BOOL QueryValue( com::sun::star::uno::Any& rVal, USHORT nWhich ) const; virtual BOOL PutValue( const com::sun::star::uno::Any& rVal, USHORT nWhich ); virtual String GetDescription() const; }; /*-------------------------------------------------------------------- Beschreibung: DokumentInfo --------------------------------------------------------------------*/ class SwDocInfoFieldType : public SwValueFieldType { public: SwDocInfoFieldType(SwDoc* pDc); String Expand(USHORT nSubType, sal_uInt32 nFormat, USHORT nLang, const String& rName) const; virtual SwFieldType* Copy() const; }; class SW_DLLPUBLIC SwDocInfoField : public SwValueField { USHORT nSubType; String aContent; String aName; public: SwDocInfoField(SwDocInfoFieldType*, USHORT nSub, const String& rName, sal_uInt32 nFmt=0); SwDocInfoField(SwDocInfoFieldType*, USHORT nSub, const String& rName, const String& rValue, sal_uInt32 nFmt=0); virtual void SetSubType(USHORT); virtual USHORT GetSubType() const; virtual void SetLanguage(USHORT nLng); virtual String Expand() const; virtual String GetCntnt(BOOL bName = FALSE) const; virtual SwField* Copy() const; String GetName() const { return aName; } void SetName( const String& rName ) { aName = rName; } inline void SetExpansion(const String& rStr) { aContent = rStr; } virtual BOOL QueryValue( com::sun::star::uno::Any& rVal, USHORT nWhich ) const; virtual BOOL PutValue( const com::sun::star::uno::Any& rVal, USHORT nWhich ); }; /*-------------------------------------------------------------------- Beschreibung: erweiterte Benutzereinstellung --------------------------------------------------------------------*/ class SwExtUserFieldType : public SwFieldType { String aData; public: SwExtUserFieldType(); inline void SetData(const String& rStr) { aData = rStr; } String Expand(USHORT nSubType, sal_uInt32 nFormat) const; virtual SwFieldType* Copy() const; }; class SwExtUserField : public SwField { String aContent; USHORT nType; public: SwExtUserField(SwExtUserFieldType*, USHORT nSub, sal_uInt32 nFmt=0); virtual String Expand() const; virtual SwField* Copy() const; virtual USHORT GetSubType() const; virtual void SetSubType(USHORT nSub); inline void SetExpansion(const String& rStr) { aContent = rStr; } virtual BOOL QueryValue( com::sun::star::uno::Any& rVal, USHORT nWhich ) const; virtual BOOL PutValue( const com::sun::star::uno::Any& rVal, USHORT nWhich ); }; /*-------------------------------------------------------------------- Beschreibung: Relatives Seitennummern - Feld --------------------------------------------------------------------*/ class SwRefPageSetFieldType : public SwFieldType { public: SwRefPageSetFieldType(); virtual SwFieldType* Copy() const; // ueberlagert, weil es nichts zum Updaten gibt! virtual void Modify( SfxPoolItem *, SfxPoolItem * ); }; /*-------------------------------------------------------------------- Beschreibung: Relative Seitennummerierung --------------------------------------------------------------------*/ class SwRefPageSetField : public SwField { short nOffset; BOOL bOn; public: SwRefPageSetField( SwRefPageSetFieldType*, short nOff = 0, BOOL bOn = TRUE ); virtual String Expand() const; virtual SwField* Copy() const; virtual String GetPar2() const; virtual void SetPar2(const String& rStr); BOOL IsOn() const { return bOn; } short GetOffset() const { return nOffset; } void SetOffset( short nOff ) { nOffset = nOff; } virtual BOOL QueryValue( com::sun::star::uno::Any& rVal, USHORT nWhich ) const; virtual BOOL PutValue( const com::sun::star::uno::Any& rVal, USHORT nWhich ); }; /*-------------------------------------------------------------------- Beschreibung: relatives Seitennummern - Abfrage Feld --------------------------------------------------------------------*/ class SwRefPageGetFieldType : public SwFieldType { SwDoc* pDoc; sal_Int16 nNumberingType; void UpdateField( SwTxtFld* pTxtFld, _SetGetExpFlds& rSetList ); public: SwRefPageGetFieldType( SwDoc* pDoc ); virtual SwFieldType* Copy() const; // ueberlagert, um alle RefPageGet-Felder zu updaten virtual void Modify( SfxPoolItem *, SfxPoolItem * ); USHORT MakeSetList( _SetGetExpFlds& rTmpLst ); SwDoc* GetDoc() const { return pDoc; } }; /*-------------------------------------------------------------------- Beschreibung: Relative Seitennummerierung Abfragen --------------------------------------------------------------------*/ class SwRefPageGetField : public SwField { String sTxt; public: SwRefPageGetField( SwRefPageGetFieldType*, sal_uInt32 nFmt ); virtual String Expand() const; virtual SwField* Copy() const; void SetText( const String& rTxt ) { sTxt = rTxt; } void ChangeExpansion( const SwFrm* pFrm, const SwTxtFld* pFld ); virtual BOOL QueryValue( com::sun::star::uno::Any& rVal, USHORT nWhich ) const; virtual BOOL PutValue( const com::sun::star::uno::Any& rVal, USHORT nWhich ); }; /*-------------------------------------------------------------------- Beschreibung: Feld zum Anspringen und Editieren --------------------------------------------------------------------*/ class SwJumpEditFieldType : public SwFieldType { SwDoc* pDoc; SwDepend aDep; public: SwJumpEditFieldType( SwDoc* pDoc ); virtual SwFieldType* Copy() const; SwCharFmt* GetCharFmt(); }; class SwJumpEditField : public SwField { String sTxt, sHelp; public: SwJumpEditField( SwJumpEditFieldType*, sal_uInt32 nFormat, const String& sText, const String& sHelp ); virtual String Expand() const; virtual SwField* Copy() const; // Platzhalter-Text virtual const String& GetPar1() const; virtual void SetPar1(const String& rStr); // HinweisText virtual String GetPar2() const; virtual void SetPar2(const String& rStr); SwCharFmt* GetCharFmt() const { return ((SwJumpEditFieldType*)GetTyp())->GetCharFmt(); } virtual BOOL QueryValue( com::sun::star::uno::Any& rVal, USHORT nWhich ) const; virtual BOOL PutValue( const com::sun::star::uno::Any& rVal, USHORT nWhich ); }; /*-------------------------------------------------------------------- Beschreibung: Script Fieldtype --------------------------------------------------------------------*/ class SwScriptFieldType : public SwFieldType { SwDoc* pDoc; public: SwScriptFieldType( SwDoc* pDoc ); virtual SwFieldType* Copy() const; }; /*-------------------------------------------------------------------- Beschreibung: Script Field --------------------------------------------------------------------*/ class SwScriptField : public SwField { String sType; // Type von Code (Java/VBScript/...) String sCode; // der Code als Text // der Code als JavaCode ? BOOL bCodeURL; // Code enthaelt URL eines Scripts public: SwScriptField( SwScriptFieldType*, const String& rType, const String& rCode, BOOL bURL=FALSE ); virtual String GetDescription() const; virtual String Expand() const; virtual SwField* Copy() const; // Type virtual const String& GetPar1() const; virtual void SetPar1(const String& rStr); // Text virtual String GetPar2() const; virtual void SetPar2(const String& rStr); BOOL IsCodeURL() const { return bCodeURL; } void SetCodeURL( BOOL bURL ) { bCodeURL = bURL; } virtual BOOL QueryValue( com::sun::star::uno::Any& rVal, USHORT nWhich ) const; virtual BOOL PutValue( const com::sun::star::uno::Any& rVal, USHORT nWhich ); }; /*-------------------------------------------------------------------- Beschreibung: Combined Character Fieldtype --------------------------------------------------------------------*/ class SwCombinedCharFieldType : public SwFieldType { public: SwCombinedCharFieldType(); virtual SwFieldType* Copy() const; }; /*-------------------------------------------------------------------- Beschreibung: Script Field --------------------------------------------------------------------*/ #define MAX_COMBINED_CHARACTERS 6 class SW_DLLPUBLIC SwCombinedCharField : public SwField { String sCharacters; // combine these characters public: SwCombinedCharField( SwCombinedCharFieldType*, const String& rChars ); virtual String Expand() const; virtual SwField* Copy() const; // Characters virtual const String& GetPar1() const; virtual void SetPar1(const String& rStr); virtual BOOL QueryValue( com::sun::star::uno::Any& rVal, USHORT nWhich ) const; virtual BOOL PutValue( const com::sun::star::uno::Any& rVal, USHORT nWhich ); }; #endif // _DOCUFLD_HXX