/*************************************************************************
 *
 * 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
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

/** @#file
 *
 *  import of all text fields 
 *  (except variable related + database display field: see txtvfldi.hxx)
 */

#ifndef _XMLOFF_TXTFLDI_HXX
#define _XMLOFF_TXTFLDI_HXX

#ifndef _COM_SUN_STAR_UNO_REFERENCE_H_ 
#include <com/sun/star/uno/Reference.h>
#endif

#ifndef _COM_SUN_STAR_TEXT_PAGENUMBERTYPE_HPP_
#include <com/sun/star/text/PageNumberType.hpp>
#endif

#ifndef _COM_SUN_STAR_UTIL_DATETIME_HPP_
#include <com/sun/star/util/DateTime.hpp>
#endif

#ifndef _COM_SUN_STAR_UTIL_DATE_HPP_
#include <com/sun/star/util/Date.hpp>
#endif

#ifndef _XMLOFF_XMLICTXT_HXX 
#include <bf_xmloff/xmlictxt.hxx>
#endif

#ifndef _XMLOFF_TEXTIMP_HXX_
#include <bf_xmloff/txtimp.hxx>
#endif

#ifndef _RTL_USTRBUF_HXX_
#include <rtl/ustrbuf.hxx>
#endif

#ifndef _TOOLS_DEBUG_HXX
#include <tools/debug.hxx>
#endif

namespace com { namespace sun { namespace star { 
	namespace xml { namespace sax { class XAttributeList; } } 
	namespace text { class XTextField; }
	namespace beans { class XPropertySet; struct PropertyValue; }
} } }

namespace rtl 
{
	class OUString;
}
namespace binfilter {

class SvXMLImport;
class XMLTextImportHelper;
class SvXMLTokenMap;

enum XMLTextFieldAttrTokens
{
	XML_TOK_TEXTFIELD_FIXED = 0,
	XML_TOK_TEXTFIELD_DESCRIPTION,
	XML_TOK_TEXTFIELD_PLACEHOLDER_TYPE,
	XML_TOK_TEXTFIELD_TIME_ADJUST,
	XML_TOK_TEXTFIELD_DATE_ADJUST,
	XML_TOK_TEXTFIELD_PAGE_ADJUST,
	XML_TOK_TEXTFIELD_SELECT_PAGE,
	XML_TOK_TEXTFIELD_ACTIVE,

	XML_TOK_TEXTFIELD_NAME,
	XML_TOK_TEXTFIELD_FORMULA,
	XML_TOK_TEXTFIELD_NUM_FORMAT,
	XML_TOK_TEXTFIELD_NUM_LETTER_SYNC,
	XML_TOK_TEXTFIELD_DISPLAY_FORMULA,
	XML_TOK_TEXTFIELD_NUMBERING_LEVEL,
	XML_TOK_TEXTFIELD_NUMBERING_SEPARATOR,
	XML_TOK_TEXTFIELD_DISPLAY,
	XML_TOK_TEXTFIELD_OUTLINE_LEVEL,

	XML_TOK_TEXTFIELD_VALUE_TYPE,
	XML_TOK_TEXTFIELD_VALUE,
	XML_TOK_TEXTFIELD_STRING_VALUE,
	XML_TOK_TEXTFIELD_DATE_VALUE,
	XML_TOK_TEXTFIELD_TIME_VALUE,
	XML_TOK_TEXTFIELD_BOOL_VALUE,
	XML_TOK_TEXTFIELD_CURRENCY,
	XML_TOK_TEXTFIELD_DATA_STYLE_NAME,

	XML_TOK_TEXTFIELD_DATABASE_NAME,
	XML_TOK_TEXTFIELD_TABLE_NAME,
	XML_TOK_TEXTFIELD_COLUMN_NAME,
	XML_TOK_TEXTFIELD_ROW_NUMBER,
	XML_TOK_TEXTFIELD_CONDITION,
	XML_TOK_TEXTFIELD_STRING_VALUE_IF_TRUE,
	XML_TOK_TEXTFIELD_STRING_VALUE_IF_FALSE,
	XML_TOK_TEXTFIELD_REVISION,
	XML_TOK_TEXTFIELD_IS_HIDDEN,
	XML_TOK_TEXTFIELD_CURRENT_VALUE,

	XML_TOK_TEXTFIELD_REFERENCE_FORMAT,
	XML_TOK_TEXTFIELD_REF_NAME,
	XML_TOK_TEXTFIELD_CONNECTION_NAME,

	XML_TOK_TEXTFIELD_HREF,
	XML_TOK_TEXTFIELD_TARGET_FRAME,

	XML_TOK_TEXTFIELD_OFFICE_CREATE_DATE,
	XML_TOK_TEXTFIELD_OFFICE_AUTHOR,
	XML_TOK_TEXTFIELD_ANNOTATION,
	XML_TOK_TEXTFIELD_LANGUAGE,

	XML_TOK_TEXTFIELD_MEASURE_KIND,
    XML_TOK_TEXTFIELD_TABLE_TYPE,

	XML_TOK_TEXTFIELD_UNKNOWN
};

/// abstract class for text field import
class XMLTextFieldImportContext : public SvXMLImportContext
{
	const ::rtl::OUString sServicePrefix;
	const ::rtl::OUString sIsFixed;

	// data members
	::rtl::OUStringBuffer sContentBuffer;	/// collect character data
	::rtl::OUString sContent;				/// character data after collection
	::rtl::OUString sServiceName;			/// service name for text field
	XMLTextImportHelper& rTextImportHelper;	/// the import helper

protected:

	// data members for use in subclasses
	sal_Bool bValid;						/// ist dieses Feld gültig?

public:

	TYPEINFO();

	XMLTextFieldImportContext( 
		SvXMLImport& rImport,					/// XML Import
		XMLTextImportHelper& rHlp,				/// Text import helper
		const sal_Char* pService,				/// name of SO API service
		sal_uInt16 nPrfx,						/// namespace prefix
		const ::rtl::OUString& rLocalName);		/// element name w/o prefix

	virtual ~XMLTextFieldImportContext();

	/// process character data: will be collected in member sContentBuffer
	virtual void Characters( const ::rtl::OUString& sContent );

	/// parses attributes and calls ProcessAttribute
	virtual void StartElement(
		const ::com::sun::star::uno::Reference<
		::com::sun::star::xml::sax::XAttributeList> & xAttrList);

	/// create XTextField and insert into document; calls PrepareTextField
	virtual void EndElement();

	/// create the appropriate field context from 
	/// (for use in paragraph import)
	static XMLTextFieldImportContext* CreateTextFieldImportContext(
		SvXMLImport& rImport, 
		XMLTextImportHelper& rHlp,
		sal_uInt16 nPrefix, 
		const ::rtl::OUString& rName,
		sal_uInt16 nToken);

protected:

	/// get helper
	inline XMLTextImportHelper& GetImportHelper() { return rTextImportHelper; }

	inline ::rtl::OUString GetServiceName() { return sServiceName; }
	inline void SetServiceName(::rtl::OUString sStr) { sServiceName = sStr; }

	::rtl::OUString GetContent();

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue ) = 0;

	/// prepare XTextField for insertion into document
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet) = 0;

	/// create field from ServiceName
	sal_Bool CreateField(::com::sun::star::uno::Reference<
						 ::com::sun::star::beans::XPropertySet> & xField,
						 const ::rtl::OUString& sServiceName);

	/// force an update of the field's value
	/// call update on optional XUptadeable interface; (disable Fixed property)
	void ForceUpdate(
		const ::com::sun::star::uno::Reference<
			::com::sun::star::beans::XPropertySet> & rPropertySet);
};

class XMLSenderFieldImportContext : public XMLTextFieldImportContext
{

	sal_Int16 nSubType;			/// API subtype for ExtUser field

	const ::rtl::OUString sEmpty;		/// empty string
	const ::rtl::OUString sPropertyFixed;
	const ::rtl::OUString sPropertyFieldSubType;
	const ::rtl::OUString sPropertyContent;

protected:

	// variables for access in subclass 
	sal_Bool bFixed;
	sal_uInt16 nElementToken;	/// token for this elment field

public:

	TYPEINFO();

	XMLSenderFieldImportContext( 
		SvXMLImport& rImport,					/// XML Import
		XMLTextImportHelper& rHlp,				/// Text import helper
		sal_uInt16 nPrfx,						/// namespace prefix
		const ::rtl::OUString& sLocalName,		/// element name w/o prefix
		sal_uInt16 nToken);						/// element token

protected:

	/// start element
	virtual void StartElement(
		const ::com::sun::star::uno::Reference<
		::com::sun::star::xml::sax::XAttributeList> & xAttrList);

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// prepare XTextField for insertion into document
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);
};

/** inherit sender field because of fixed attribute in ProcessAttributes */
class XMLAuthorFieldImportContext : public XMLSenderFieldImportContext
{

	sal_Bool bAuthorFullName;
	const ::rtl::OUString sServiceAuthor;
	const ::rtl::OUString sPropertyAuthorFullName;
	const ::rtl::OUString sPropertyFixed;
	const ::rtl::OUString sPropertyContent;

public:

	TYPEINFO();

	XMLAuthorFieldImportContext( 
		SvXMLImport& rImport,					/// XML Import
		XMLTextImportHelper& rHlp,				/// Text import helper
		sal_uInt16 nPrfx,						/// namespace prefix
		const ::rtl::OUString& sLocalName,		/// element name w/o prefix
		sal_uInt16 nToken);						/// element token

protected:

	/// start element
	virtual void StartElement(
		const ::com::sun::star::uno::Reference<
		::com::sun::star::xml::sax::XAttributeList> & xAttrList);

	/// prepare XTextField for insertion into document
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);
};

class XMLPlaceholderFieldImportContext : public XMLTextFieldImportContext
{

	const ::rtl::OUString sEmpty;		/// empty string
	const ::rtl::OUString sServiceJumpEdit;
	const ::rtl::OUString sPropertyPlaceholderType;
	const ::rtl::OUString sPropertyPlaceholder;
	const ::rtl::OUString sPropertyHint;

	::rtl::OUString sDescription;

	sal_Int16 nPlaceholderType;

public:

	TYPEINFO();

	XMLPlaceholderFieldImportContext( 
		SvXMLImport& rImport,					/// XML Import
		XMLTextImportHelper& rHlp,				/// Text import helper
		sal_uInt16 nPrfx,						/// namespace prefix
		const ::rtl::OUString& sLocalName);		/// element name w/o prefix

protected:

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// prepare XTextField for insertion into document
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);
};

class XMLTimeFieldImportContext : public XMLTextFieldImportContext
{

protected:
	const ::rtl::OUString sPropertyNumberFormat;
	const ::rtl::OUString sPropertyFixed;
	const ::rtl::OUString sPropertyDateTimeValue;
	const ::rtl::OUString sPropertyDateTime;
	const ::rtl::OUString sPropertyAdjust;
	const ::rtl::OUString sPropertyIsDate;
    const ::rtl::OUString sPropertyIsFixedLanguage;

	double fTimeValue;
	::com::sun::star::util::DateTime aDateTimeValue;
	sal_Int32 nAdjust;
	sal_Int32 nFormatKey;
	sal_Bool bTimeOK;
	sal_Bool bFormatOK;
	sal_Bool bFixed;
	sal_Bool bIsDate;			// is this a date? 
								// (for XMLDateFieldImportContext, really)
    sal_Bool bIsDefaultLanguage;

public:

	TYPEINFO();

	XMLTimeFieldImportContext(
		SvXMLImport& rImport,					/// XML Import
		XMLTextImportHelper& rHlp,				/// Text import helper
		sal_uInt16 nPrfx,						/// namespace prefix
		const ::rtl::OUString& sLocalName);		/// element name w/o prefix

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// prepare XTextField for insertion into document
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);
};

/** import date fields (<text:date>); 
	inherit from TimeField to reuse implementation */
class XMLDateFieldImportContext : public XMLTimeFieldImportContext
{

public:

	TYPEINFO();

	XMLDateFieldImportContext(
		SvXMLImport& rImport,					/// XML Import
		XMLTextImportHelper& rHlp,				/// Text import helper
		sal_uInt16 nPrfx,						/// namespace prefix
		const ::rtl::OUString& sLocalName);		/// element name w/o prefix

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );
};

/** import page continuation fields (<text:page-continuation-string>) */
class XMLPageContinuationImportContext : public XMLTextFieldImportContext
{
	const ::rtl::OUString sPropertySubType;
	const ::rtl::OUString sPropertyUserText;
	const ::rtl::OUString sPropertyNumberingType;

	::rtl::OUString sString;			/// continuation string
	::com::sun::star::text::PageNumberType eSelectPage;	/// previous, current 
														/// or next page
	sal_Bool sStringOK;					/// continuation string encountered?

public:

	TYPEINFO();

	XMLPageContinuationImportContext(
		SvXMLImport& rImport,					/// XML Import
		XMLTextImportHelper& rHlp,				/// Text import helper
		sal_uInt16 nPrfx,						/// namespace prefix
		const ::rtl::OUString& sLocalName);		/// element name w/o prefix

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// prepare XTextField for insertion into document
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);
};

/** import page number fields (<text:page-number>) */
class XMLPageNumberImportContext : public XMLTextFieldImportContext
{
	const ::rtl::OUString sPropertySubType;
	const ::rtl::OUString sPropertyNumberingType;
	const ::rtl::OUString sPropertyOffset;

	::rtl::OUString sNumberFormat;
	::rtl::OUString sNumberSync;
	sal_Int16 nPageAdjust;
	::com::sun::star::text::PageNumberType eSelectPage;	/// previous, current 
														/// or next page
	sal_Bool sNumberFormatOK;

public:

	TYPEINFO();

	XMLPageNumberImportContext(
		SvXMLImport& rImport,					/// XML Import
		XMLTextImportHelper& rHlp,				/// Text import helper
		sal_uInt16 nPrfx,						/// namespace prefix
		const ::rtl::OUString& sLocalName);		/// element name w/o prefix

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// prepare XTextField for insertion into document
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);
};

/** superclass for database fields: handle database and table names */
class XMLDatabaseFieldImportContext : public XMLTextFieldImportContext
{
	const ::rtl::OUString sPropertyDatabaseName;
	const ::rtl::OUString sPropertyTableName;
    const ::rtl::OUString sPropertyDataCommandType;
    const ::rtl::OUString sPropertyIsVisible;

	::rtl::OUString sDatabaseName;
	::rtl::OUString sTableName;

    sal_Int32 nCommandType;
    sal_Bool bCommandTypeOK;

    sal_Bool bDisplay;
    bool bDisplayOK;
    bool bUseDisplay;

protected:
	sal_Bool bDatabaseOK;
	sal_Bool bTableOK;

	/// protected constructor: only for subclasses
	XMLDatabaseFieldImportContext(SvXMLImport& rImport, 
								  XMLTextImportHelper& rHlp,
								  const sal_Char* pServiceName, 
								  sal_uInt16 nPrfx, 
								  const ::rtl::OUString& sLocalName,
                                  bool bUseDisplay );

public:

TYPEINFO();

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// prepare XTextField for insertion into document
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);
};

/** import database name fields (<text:database-name>) */
class XMLDatabaseNameImportContext : public XMLDatabaseFieldImportContext
{
public:

	TYPEINFO();

	XMLDatabaseNameImportContext(SvXMLImport& rImport, 
								 XMLTextImportHelper& rHlp,
								 sal_uInt16 nPrfx, 
								 const ::rtl::OUString& sLocalName);

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );
};

/** import database next fields (<text:database-next>) */
class XMLDatabaseNextImportContext : public XMLDatabaseFieldImportContext
{
	const ::rtl::OUString sPropertyCondition;
	const ::rtl::OUString sTrue;
	::rtl::OUString sCondition;
	sal_Bool bConditionOK;

protected:

	// for use in child classes
	XMLDatabaseNextImportContext(SvXMLImport& rImport, 
								 XMLTextImportHelper& rHlp,
								 const sal_Char* pServiceName,
								 sal_uInt16 nPrfx, 
								 const ::rtl::OUString& sLocalName);

public:

	TYPEINFO();

	XMLDatabaseNextImportContext(SvXMLImport& rImport, 
								 XMLTextImportHelper& rHlp,
								 sal_uInt16 nPrfx, 
								 const ::rtl::OUString& sLocalName);

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// prepare XTextField for insertion into document
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);
};

/** import database select fields (<text:database-select>) */
class XMLDatabaseSelectImportContext : public XMLDatabaseNextImportContext
{
	const ::rtl::OUString sPropertySetNumber;
	sal_Int32 nNumber;
	sal_Bool bNumberOK;

public:

	TYPEINFO();

	XMLDatabaseSelectImportContext(SvXMLImport& rImport, 
								   XMLTextImportHelper& rHlp,
								   sal_uInt16 nPrfx, 
								   const ::rtl::OUString& sLocalName);

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// prepare XTextField for insertion into document
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);
};

/** import database display number fields (<text:database-row-number>) */
class XMLDatabaseNumberImportContext : public XMLDatabaseFieldImportContext
{
	const ::rtl::OUString sPropertyNumberingType;
	const ::rtl::OUString sPropertySetNumber;
	::rtl::OUString sNumberFormat;
	::rtl::OUString sNumberSync;
	sal_Int32 nValue;
	sal_Bool bValueOK;

public:

	TYPEINFO();

	XMLDatabaseNumberImportContext(SvXMLImport& rImport, 
								   XMLTextImportHelper& rHlp,
								   sal_uInt16 nPrfx, 
								   const ::rtl::OUString& sLocalName);

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// prepare XTextField for insertion into document
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);
};

/** import docinfo fields with only fixed atribute */
class XMLSimpleDocInfoImportContext : public XMLTextFieldImportContext
{
	const ::rtl::OUString sPropertyFixed;
	const ::rtl::OUString sPropertyContent;
	const ::rtl::OUString sPropertyAuthor;
//STRIP013	const ::rtl::OUString sPropertyCurrentPresentation;

protected:
	sal_Bool bFixed;
	sal_Bool bHasAuthor;
	sal_Bool bHasContent;

public:

	TYPEINFO();

	XMLSimpleDocInfoImportContext(SvXMLImport& rImport,
								  XMLTextImportHelper& rHlp,
								  sal_uInt16 nPrfx,
								  const ::rtl::OUString& sLocalName,
								  sal_uInt16 nToken,
								  sal_Bool bContent,
								  sal_Bool bAuthor);

protected:

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// prepare XTextField for insertion into document
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);

	static const sal_Char* MapTokenToServiceName(sal_uInt16 nToken);
};

/** import docinfo fields with date or time attributes and numberformats */
class XMLDateTimeDocInfoImportContext : public XMLSimpleDocInfoImportContext
{
	const ::rtl::OUString sPropertyNumberFormat;
	const ::rtl::OUString sPropertyIsDate;
    const ::rtl::OUString sPropertyIsFixedLanguage;

	sal_Int32 nFormat;
	sal_Bool bFormatOK;
	sal_Bool bIsDate;
	sal_Bool bHasDateTime;
    sal_Bool bIsDefaultLanguage;

public:

	TYPEINFO();

	XMLDateTimeDocInfoImportContext(SvXMLImport& rImport,
									XMLTextImportHelper& rHlp,
									sal_uInt16 nPrfx,
									const ::rtl::OUString& sLocalName,
									sal_uInt16 nToken);

protected:

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// prepare XTextField for insertion into document
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);
};

/** import revision field (<text:editing-cycles>) */
class XMLRevisionDocInfoImportContext : public XMLSimpleDocInfoImportContext
{
	const ::rtl::OUString sPropertyRevision;
	sal_Int16 nRevision;
	sal_Bool bRevisionOK;

public:

	TYPEINFO();

	XMLRevisionDocInfoImportContext(SvXMLImport& rImport,
									XMLTextImportHelper& rHlp,
									sal_uInt16 nPrfx,
									const ::rtl::OUString& sLocalName,
									sal_uInt16 nToken);

protected:

	/// prepare XTextField for insertion into document
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);
};

/** import user docinfo field (<text:user-defined>) */
class XMLUserDocInfoImportContext : public XMLSimpleDocInfoImportContext
{
public:

	TYPEINFO();

	XMLUserDocInfoImportContext(SvXMLImport& rImport,
								XMLTextImportHelper& rHlp,
								sal_uInt16 nPrfx,
								const ::rtl::OUString& sLocalName,
								sal_uInt16 nToken);

protected:

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );
};

/** import hidden paragraph fields (<text:hidden-paragraph>) */
class XMLHiddenParagraphImportContext : public XMLTextFieldImportContext
{
	const ::rtl::OUString sPropertyCondition;
	const ::rtl::OUString sPropertyIsHidden;

	::rtl::OUString sCondition;
	sal_Bool bIsHidden;

public:

	TYPEINFO();

	XMLHiddenParagraphImportContext(SvXMLImport& rImport,
									XMLTextImportHelper& rHlp,
									sal_uInt16 nPrfx,
									const ::rtl::OUString& sLocalName);

protected:

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// prepare XTextField for insertion into document
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);
};

/** import conditional text fields (<text:conditional-text>) */
class XMLConditionalTextImportContext : public XMLTextFieldImportContext
{
	const ::rtl::OUString sPropertyCondition;
	const ::rtl::OUString sPropertyTrueContent;
	const ::rtl::OUString sPropertyFalseContent;
	const ::rtl::OUString sPropertyIsConditionTrue;
//STRIP013    const ::rtl::OUString sPropertyCurrentPresentation;

	::rtl::OUString sCondition;
	::rtl::OUString sTrueContent;
	::rtl::OUString sFalseContent;

	sal_Bool bConditionOK;
	sal_Bool bTrueOK;
	sal_Bool bFalseOK;
	sal_Bool bCurrentValue;

public:

	TYPEINFO();

	XMLConditionalTextImportContext(SvXMLImport& rImport,
									XMLTextImportHelper& rHlp,
									sal_uInt16 nPrfx,
									const ::rtl::OUString& sLocalName);

protected:

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// prepare XTextField for insertion into document
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);
};

/** import conditional text fields (<text:hidden-text>) */
class XMLHiddenTextImportContext : public XMLTextFieldImportContext
{
	const ::rtl::OUString sPropertyCondition;
	const ::rtl::OUString sPropertyContent;
	const ::rtl::OUString sPropertyIsHidden;

	::rtl::OUString sCondition;
	::rtl::OUString sString;

	sal_Bool bConditionOK;
	sal_Bool bStringOK;
	sal_Bool bIsHidden;

public:

	TYPEINFO();

	XMLHiddenTextImportContext(SvXMLImport& rImport,
							   XMLTextImportHelper& rHlp,
							   sal_uInt16 nPrfx,
							   const ::rtl::OUString& sLocalName);

protected:

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// prepare XTextField for insertion into document
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);
};

/** import file name fields (<text:file-name>) */
class XMLFileNameImportContext : public XMLTextFieldImportContext
{
	const ::rtl::OUString sPropertyFixed;
	const ::rtl::OUString sPropertyFileFormat;
//STRIP013	const ::rtl::OUString sPropertyCurrentPresentation;

	sal_Int16 nFormat;
	sal_Bool bFixed;

public:

	TYPEINFO();

	XMLFileNameImportContext(SvXMLImport& rImport,
							 XMLTextImportHelper& rHlp,
							 sal_uInt16 nPrfx,
							 const ::rtl::OUString& sLocalName);

protected:

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// prepare XTextField for insertion into document
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);
};

/** import document template name fields (<text:template-name>) */
class XMLTemplateNameImportContext : public XMLTextFieldImportContext
{
	const ::rtl::OUString sPropertyFileFormat;

	sal_Int16 nFormat;

public:

	TYPEINFO();

	XMLTemplateNameImportContext(SvXMLImport& rImport,
								 XMLTextImportHelper& rHlp,
								 sal_uInt16 nPrfx,
								 const ::rtl::OUString& sLocalName);

protected:

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// prepare XTextField for insertion into document
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);
};

/** import chapter fields (<text:chapter>) */
class XMLChapterImportContext : public XMLTextFieldImportContext
{
	const ::rtl::OUString sPropertyChapterFormat;
	const ::rtl::OUString sPropertyLevel;

	sal_Int16 nFormat;
	sal_Int8 nLevel;

public:

	TYPEINFO();

	XMLChapterImportContext(SvXMLImport& rImport,
							XMLTextImportHelper& rHlp,
							sal_uInt16 nPrfx,
							const ::rtl::OUString& sLocalName);

protected:

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// prepare XTextField for insertion into document
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);
};

/** import count fields (<text:[XXX]-count>) */
class XMLCountFieldImportContext : public XMLTextFieldImportContext
{
	const ::rtl::OUString sPropertyNumberingType;

	::rtl::OUString sNumberFormat;
	::rtl::OUString sLetterSync;

	sal_Bool bNumberFormatOK;

public:

	TYPEINFO();

	XMLCountFieldImportContext(SvXMLImport& rImport,
							   XMLTextImportHelper& rHlp,
							   sal_uInt16 nPrfx,
							   const ::rtl::OUString& sLocalName,
							   sal_uInt16 nToken);

protected:

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// prepare XTextField for insertion into document
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);

	static const sal_Char* MapTokenToServiceName(sal_uInt16 nToken);
};

/** import page variable fields (<text:get-page-variable>) */
class XMLPageVarGetFieldImportContext : public XMLTextFieldImportContext
{
	const ::rtl::OUString sPropertyNumberingType;

	::rtl::OUString sNumberFormat;
	::rtl::OUString sLetterSync;

	sal_Bool bNumberFormatOK;

public:

	TYPEINFO();

	XMLPageVarGetFieldImportContext(SvXMLImport& rImport,
									XMLTextImportHelper& rHlp,
									sal_uInt16 nPrfx,
									const ::rtl::OUString& sLocalName);

protected:

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// prepare XTextField for insertion into document
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);
};

/** import page variable fields (<text:get-page-variable>) */
class XMLPageVarSetFieldImportContext : public XMLTextFieldImportContext
{
	const ::rtl::OUString sPropertyOn;
	const ::rtl::OUString sPropertyOffset;

	sal_Int16 nAdjust;
	sal_Bool bActive;

public:

	TYPEINFO();

	XMLPageVarSetFieldImportContext(SvXMLImport& rImport,
									XMLTextImportHelper& rHlp,
									sal_uInt16 nPrfx,
									const ::rtl::OUString& sLocalName);

protected:

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// prepare XTextField for insertion into document
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);
};

/** import macro fields (<text:execute-macro>) */
class XMLMacroFieldImportContext : public XMLTextFieldImportContext
{

	const ::rtl::OUString sPropertyHint;
	const ::rtl::OUString sPropertyMacroName;
    const ::rtl::OUString sPropertyLibraryName;

	::rtl::OUString sDescription;
    SvXMLImportContextRef xEventContext;

	::rtl::OUString sMacro; // macro for old documents (pre 638i)

	sal_Bool bMacroOK;
	sal_Bool bDescriptionOK;

public:

	TYPEINFO();

	XMLMacroFieldImportContext(SvXMLImport& rImport,
							   XMLTextImportHelper& rHlp,
							   sal_uInt16 nPrfx,
							   const ::rtl::OUString& sLocalName);

protected:

	/// for <office:events> children
    virtual SvXMLImportContext *CreateChildContext( 
		sal_uInt16 nPrefix,
		const ::rtl::OUString& rLocalName,
		const ::com::sun::star::uno::Reference< 
		::com::sun::star::xml::sax::XAttributeList> & xAttrList );

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// prepare XTextField for insertion into document
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);
};

/** import reference fields (<text:reference-get>) */
class XMLReferenceFieldImportContext : public XMLTextFieldImportContext
{
	const ::rtl::OUString sPropertyReferenceFieldPart;
	const ::rtl::OUString sPropertyReferenceFieldSource;
	const ::rtl::OUString sPropertySourceName;
//STRIP013	const ::rtl::OUString sPropertyCurrentPresentation;

	::rtl::OUString sName;
	sal_uInt16 nElementToken;
	sal_Int16 nSource;
	sal_Int16 nType;
	sal_Int16 nSequenceNumber;

	sal_Bool bNameOK;
	sal_Bool bTypeOK;
	sal_Bool bSeqNumberOK;

public:

	TYPEINFO();

	XMLReferenceFieldImportContext(SvXMLImport& rImport,
								   XMLTextImportHelper& rHlp,
								   sal_uInt16 nToken,
								   sal_uInt16 nPrfx,
								   const ::rtl::OUString& sLocalName);

protected:

	/// start element
	virtual void StartElement(
		const ::com::sun::star::uno::Reference<
		::com::sun::star::xml::sax::XAttributeList> & xAttrList);

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// prepare XTextField for insertion into document
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);
};

/** import dde field declaration container (<text:dde-connection-decls>) */
class XMLDdeFieldDeclsImportContext : public SvXMLImportContext
{

	SvXMLTokenMap aTokenMap;

public:

	TYPEINFO();

	XMLDdeFieldDeclsImportContext(SvXMLImport& rImport,
								  sal_uInt16 nPrfx,
								  const ::rtl::OUString& sLocalName);

	virtual SvXMLImportContext *CreateChildContext( 
		sal_uInt16 nPrefix,
		const ::rtl::OUString& rLocalName,
		const ::com::sun::star::uno::Reference< 
		::com::sun::star::xml::sax::XAttributeList> & xAttrList );

};

/** import dde field declaration (<text:dde-connection-decl>) */
class XMLDdeFieldDeclImportContext : public SvXMLImportContext
{
	const ::rtl::OUString sPropertyIsAutomaticUpdate;
	const ::rtl::OUString sPropertyName;
	const ::rtl::OUString sPropertyDDECommandType;
	const ::rtl::OUString sPropertyDDECommandFile;
	const ::rtl::OUString sPropertyDDECommandElement;

	const SvXMLTokenMap& rTokenMap;

public:

	TYPEINFO();

	XMLDdeFieldDeclImportContext(SvXMLImport& rImport,
								 sal_uInt16 nPrfx,
								 const ::rtl::OUString& sLocalName,
								 const SvXMLTokenMap& rMap);

	// create fieldmaster
	virtual void StartElement(
		const ::com::sun::star::uno::Reference<
		::com::sun::star::xml::sax::XAttributeList> & xAttrList);
};

/** import dde fields (<text:dde-connection>) */
class XMLDdeFieldImportContext : public XMLTextFieldImportContext
{
	::rtl::OUString sName;

public:

	TYPEINFO();

	XMLDdeFieldImportContext(SvXMLImport& rImport,
							 XMLTextImportHelper& rHlp,
							 sal_uInt16 nPrfx,
							 const ::rtl::OUString& sLocalName);

protected:

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// create textfield, attach master, and insert into document
	virtual void EndElement();

	/// empty method
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);

};

/** import sheet name fields (Calc) dde fields (<text:sheet-name>) */
class XMLSheetNameImportContext : public XMLTextFieldImportContext
{

public:

	TYPEINFO();

	XMLSheetNameImportContext(SvXMLImport& rImport,
							  XMLTextImportHelper& rHlp,
							  sal_uInt16 nPrfx,
							  const ::rtl::OUString& sLocalName);

protected:

	/// no attributes -> empty method
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// no atributes -> empty method
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);
};

/** import hyperlinks as URL fields (Calc, Impress, Draw) (<office:a>) */
class XMLUrlFieldImportContext : public XMLTextFieldImportContext
{

	const ::rtl::OUString sPropertyURL;
	const ::rtl::OUString sPropertyTargetFrame;
	const ::rtl::OUString sPropertyRepresentation;

	::rtl::OUString sURL;
	::rtl::OUString sFrame;
	sal_Bool bFrameOK;

public:

	TYPEINFO();

	XMLUrlFieldImportContext(SvXMLImport& rImport,
							 XMLTextImportHelper& rHlp,
							 sal_uInt16 nPrfx,
							 const ::rtl::OUString& sLocalName);

protected:

	/// no attributes -> empty method
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// no atributes -> empty method
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);
};

/** import bibliography info fields (<text:bibliography-mark>) */
class XMLBibliographyFieldImportContext : public XMLTextFieldImportContext
{

	const ::rtl::OUString sPropertyFields;

	::std::vector< ::com::sun::star::beans::PropertyValue> aValues;

public:

	TYPEINFO();

	XMLBibliographyFieldImportContext(SvXMLImport& rImport,
									  XMLTextImportHelper& rHlp,
									  sal_uInt16 nPrfx,
									  const ::rtl::OUString& sLocalName);

protected:

	/// process attributes (fill aValues)
	virtual void StartElement(
		const ::com::sun::star::uno::Reference<
		::com::sun::star::xml::sax::XAttributeList> & xAttrList);

	/// empty method; all attributes are handled in StartElement
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// convert aValues into sequence and set property
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);

	static const sal_Char* MapBibliographyFieldName(::rtl::OUString sName);

};

/** Import an annotation field (<text:annotation>) */
class XMLAnnotationImportContext : public XMLTextFieldImportContext
{
	const ::rtl::OUString sPropertyAuthor;
	const ::rtl::OUString sPropertyContent;
	const ::rtl::OUString sPropertyDate;

	::rtl::OUString sAuthor;
	::rtl::OUStringBuffer aTextBuffer;
	::com::sun::star::util::Date aDate;

	sal_Bool bDateOK;

public:

	TYPEINFO();

	XMLAnnotationImportContext(SvXMLImport& rImport,
							   XMLTextImportHelper& rHlp,
							   sal_uInt16 nPrfx,
							   const ::rtl::OUString& sLocalName);

protected:

	/// process attributes
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// set properties
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);

	virtual SvXMLImportContext *CreateChildContext(
		USHORT nPrefix,
		const ::rtl::OUString& rLocalName,
		const ::com::sun::star::uno::Reference<
				::com::sun::star::xml::sax::XAttributeList >& xAttrList );
};

/** Import a script field (<text:script>) */
class XMLScriptImportContext : public XMLTextFieldImportContext
{
	const ::rtl::OUString sPropertyScriptType;
	const ::rtl::OUString sPropertyURLContent;
	const ::rtl::OUString sPropertyContent;

	::rtl::OUString sContent;
	::rtl::OUString sScriptType;

	sal_Bool bContentOK;
	sal_Bool bScriptTypeOK;
	sal_Bool bUrlContent;

public:

	TYPEINFO();

	XMLScriptImportContext(SvXMLImport& rImport,
						   XMLTextImportHelper& rHlp,
						   sal_uInt16 nPrfx,
						   const ::rtl::OUString& sLocalName);

protected:

	/// process attributes
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// set properties
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);
};

/** import measure fields (<text:measure>) */
class XMLMeasureFieldImportContext : public XMLTextFieldImportContext
{
	sal_Int16 mnKind;
public:

	TYPEINFO();

	XMLMeasureFieldImportContext(SvXMLImport& rImport,
									XMLTextImportHelper& rHlp,
									sal_uInt16 nPrfx,
									const ::rtl::OUString& sLocalName);

protected:

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// prepare XTextField for insertion into document
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);
};

/** dropdown field (filter legacy) */
class XMLDropDownFieldImportContext : public XMLTextFieldImportContext
{
    ::std::vector<rtl::OUString> aLabels;
    ::rtl::OUString sName;
    sal_Int32 nSelected;
    bool bNameOK;

    const ::rtl::OUString sPropertyItems;
    const ::rtl::OUString sPropertySelectedItem;
    const ::rtl::OUString sPropertyName;

public:
	TYPEINFO();

	XMLDropDownFieldImportContext(SvXMLImport& rImport,
									XMLTextImportHelper& rHlp,
									sal_uInt16 nPrfx,
									const ::rtl::OUString& sLocalName);

	virtual SvXMLImportContext* CreateChildContext( 
        USHORT nPrefix,
        const ::rtl::OUString& rLocalName,
        const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XAttributeList >& xAttrList );

protected:

	/// process attribute values
	virtual void ProcessAttribute( sal_uInt16 nAttrToken,
								   const ::rtl::OUString& sAttrValue );

	/// prepare XTextField for insertion into document
	virtual void PrepareField( 
		const ::com::sun::star::uno::Reference<
		::com::sun::star::beans::XPropertySet> & xPropertySet);
};

}//end of namespace binfilter
#endif
