/************************************************************************* * * $RCSfile: propertyimport.hxx,v $ * * $Revision: 1.14 $ * * last change: $Author: rt $ $Date: 2004-05-07 16:00:15 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses * * - GNU Lesser General Public License Version 2.1 * - Sun Industry Standards Source License Version 1.1 * * Sun Microsystems Inc., October, 2000 * * GNU Lesser General Public License Version 2.1 * ============================================= * Copyright 2000 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 * * * Sun Industry Standards Source License Version 1.1 * ================================================= * The contents of this file are subject to the Sun Industry Standards * Source License Version 1.1 (the "License"); You may not use this file * except in compliance with the License. You may obtain a copy of the * License at http://www.openoffice.org/license.html. * * Software provided under this License is provided on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. * See the License for the specific provisions governing your rights and * obligations concerning the Software. * * The Initial Developer of the Original Code is: Sun Microsystems, Inc.. * * Copyright: 2000 by Sun Microsystems, Inc. * * All Rights Reserved. * * Contributor(s): _______________________________________ * * ************************************************************************/ #ifndef _XMLOFF_FORMS_PROPERTYIMPORT_HXX_ #define _XMLOFF_FORMS_PROPERTYIMPORT_HXX_ #ifndef _XMLOFF_XMLICTXT_HXX #include "xmlictxt.hxx" #endif #ifndef _XMLOFF_FORMATTRIBUTES_HXX_ #include "formattributes.hxx" #endif #ifndef _VOS_REF_HXX_ #include #endif #ifndef _COMPHELPER_STLTYPES_HXX_ #include #endif #ifndef _COM_SUN_STAR_BEANS_PROPERTYVALUE_HPP_ #include #endif namespace com { namespace sun { namespace star { namespace util { struct Time; struct Date; } } } } //......................................................................... namespace xmloff { //......................................................................... class IFormsImportContext; //===================================================================== //= OPropertyImport //===================================================================== /** Helper class for importing property values

This class imports properties which are stored as attributes as well as properties which are stored in <form:properties> elements.

*/ class OPropertyImport : public SvXMLImportContext { friend class OSinglePropertyContext; protected: typedef ::std::vector< ::com::sun::star::beans::PropertyValue > PropertyValueArray; PropertyValueArray m_aValues; // the values which the instance collects between StartElement and EndElement DECLARE_STL_STDKEY_SET( ::rtl::OUString, StringSet ); StringSet m_aEncounteredAttributes; IFormsImportContext& m_rContext; sal_Bool m_bTrackAttributes; // TODO: think about the restriction that the class does not know anything about the object it is importing. // Perhaps this object should be known to the class, so setting the properties ('normal' ones as well as // style properties) can be done in our own EndElement instead of letting derived classes do this. public: OPropertyImport(IFormsImportContext& _rImport, sal_uInt16 _nPrefix, const ::rtl::OUString& _rName); virtual SvXMLImportContext* CreateChildContext( sal_uInt16 _nPrefix, const ::rtl::OUString& _rLocalName, const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XAttributeList >& _rxAttrList); virtual void StartElement( const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XAttributeList >& _rxAttrList); virtual void Characters(const ::rtl::OUString& _rChars); protected: /** handle one single attribute.

This is called for every attribute of the element. This class' implementaion checks if the attribute describes a property, if so, it is added to m_aValues.

All non-property attributes should be handled in derived classes.

@param _nNamespaceKey key of the namespace used in the attribute @param _rLocalName local (relative to the namespace) attribute name @param _rValue attribute value */ virtual void handleAttribute(sal_uInt16 _nNamespaceKey, const ::rtl::OUString& _rLocalName, const ::rtl::OUString& _rValue); /** determine if the element imported by the object had an given attribute.

Please be aware of the fact that the name given must be a local name, i.e. not contain a namespace. All form relevant attributes are in the same namespace, so this would be an redundant information.

*/ sal_Bool encounteredAttribute(const ::rtl::OUString& _rAttributeName) const; /** determine if the element imported by the object had an given attribute.

Please be aware of the fact that the name given must be a local name, i.e. not contain a namespace. All form relevant attributes are in the same namespace, so this would be an redundant information.

*/ sal_Bool encounteredAttribute(const sal_Char* _pAttributeName) const { return encounteredAttribute(::rtl::OUString::createFromAscii(_pAttributeName)); } /** enables the tracking of the encountered attributes

The tracking will raise the import costs a little bit, but it's cheaper than derived classes tracking this themself.

*/ void enableTrackAttributes() { m_bTrackAttributes = sal_True; } void implPushBackPropertyValue(const ::com::sun::star::beans::PropertyValue& _rProp) { m_aValues.push_back(_rProp); } static ::com::sun::star::uno::Any convertString( SvXMLImport& _rImporter, const ::com::sun::star::uno::Type& _rExpectedType, const ::rtl::OUString& _rReadCharacters, const SvXMLEnumMapEntry* _pEnumMap = NULL, const sal_Bool _bInvertBoolean = sal_False ); private: static ::com::sun::star::util::Time implGetTime(double _nValue); static ::com::sun::star::util::Date implGetDate(double _nValue); }; SV_DECL_IMPL_REF( OPropertyImport ) //===================================================================== //= OPropertyElementsContext //===================================================================== /** helper class for importing the <form:properties> element */ class OPropertyElementsContext : public SvXMLImportContext { protected: OPropertyImportRef m_xPropertyImporter; // to add the properties public: OPropertyElementsContext(SvXMLImport& _rImport, sal_uInt16 _nPrefix, const ::rtl::OUString& _rName, const OPropertyImportRef& _rPropertyImporter); virtual SvXMLImportContext* CreateChildContext( sal_uInt16 _nPrefix, const ::rtl::OUString& _rLocalName, const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XAttributeList >& _rxAttrList); #if OSL_DEBUG_LEVEL > 0 virtual void StartElement( const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XAttributeList >& _rxAttrList); virtual void Characters(const ::rtl::OUString& _rChars); #endif }; //===================================================================== //= OSinglePropertyContext //===================================================================== SV_DECL_REF( OAccumulateCharacters ) /** helper class for importing a single <form:property> element */ class OSinglePropertyContext : public SvXMLImportContext { OPropertyImportRef m_xPropertyImporter; // to add the properties OAccumulateCharactersRef m_xValueReader; // the class reading the characters ::com::sun::star::beans::PropertyValue m_aPropValue; // the property the instance imports currently ::com::sun::star::uno::Type m_aPropType; // the type of the property the instance imports currently public: OSinglePropertyContext(SvXMLImport& _rImport, sal_uInt16 _nPrefix, const ::rtl::OUString& _rName, const OPropertyImportRef& _rPropertyImporter); virtual SvXMLImportContext* CreateChildContext( sal_uInt16 _nPrefix, const ::rtl::OUString& _rLocalName, const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XAttributeList >& _rxAttrList); virtual void StartElement( const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XAttributeList >& _rxAttrList); #if OSL_DEBUG_LEVEL > 0 virtual void Characters(const ::rtl::OUString& _rChars); #endif virtual void EndElement(); }; //===================================================================== //= OAccumulateCharacters //===================================================================== /** helper class which accumulates the characters it gets */ class OAccumulateCharacters : public SvXMLImportContext { protected: ::rtl::OUString m_sCharacters; sal_Bool m_bPropertyIsVoid; //added by BerryJia for Bug102407 public: OAccumulateCharacters(SvXMLImport& _rImport, sal_uInt16 _nPrefix, const ::rtl::OUString& _rName); virtual void StartElement( const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XAttributeList >& _rxAttrList); // SvXMLImportContext overridables virtual void Characters(const ::rtl::OUString& _rChars); //added by BerryJia for Bug102407 sal_Bool isVoid(); ::rtl::OUString getCharacters() const { return m_sCharacters; } }; SV_IMPL_REF( OAccumulateCharacters ) //......................................................................... } // namespace xmloff //......................................................................... #endif // _XMLOFF_FORMS_PROPERTYIMPORT_HXX_