1.1 --- a/epoc32/include/xmlenguserdata.h Tue Nov 24 13:55:44 2009 +0000
1.2 +++ b/epoc32/include/xmlenguserdata.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -1,1 +1,74 @@
1.4 -xmlenguserdata.h
1.5 +/*
1.6 +* Copyright (c) 2004-2005 Nokia Corporation and/or its subsidiary(-ies).
1.7 +* All rights reserved.
1.8 +* This component and the accompanying materials are made available
1.9 +* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
1.10 +* which accompanies this distribution, and is available
1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.12 +*
1.13 +* Initial Contributors:
1.14 +* Nokia Corporation - initial contribution.
1.15 +*
1.16 +* Contributors:
1.17 +*
1.18 +* Description: Interface class describing class that may contains user
1.19 + * data aded to node
1.20 + *
1.21 +*/
1.22 +
1.23 +
1.24 +
1.25 +
1.26 +
1.27 +
1.28 +
1.29 +#ifndef XMLENGINE_USERDATA_H_INCLUDED
1.30 +#define XMLENGINE_USERDATA_H_INCLUDED
1.31 +
1.32 +#include <e32def.h>
1.33 +
1.34 +/**
1.35 + * MXmlEngUserData is an abstract base class (interface) for user data that can be
1.36 + * stored in the DOM tree. Applications that wish to store user data in the
1.37 + * DOM tree must wrap the user data in a class that implemens this interface.
1.38 + *
1.39 + * @lib XmlEngineDOM.lib
1.40 + * @since S60 v3.1
1.41 + */
1.42 +class MXmlEngUserData {
1.43 +public:
1.44 + /**
1.45 + * Free memory that is allocated and do other case specific cleanup.
1.46 + *
1.47 + * @since S60 v3.1
1.48 + */
1.49 + virtual void Destroy() = 0;
1.50 +
1.51 + /**
1.52 + * Make a copy of the the object. Note that if reference counting is used or
1.53 + * the same pointer can be safely copied to other places the implementation
1.54 + * of this method may just return a pointer to self.
1.55 + *
1.56 + * Copying user data when copying nodes has not been implemented
1.57 + * so this method is for future use (though there's no harm in implementing
1.58 + * it, of course).
1.59 + *
1.60 + * @since S60 v3.1
1.61 + * @return Pointer to a copy of this object.
1.62 + */
1.63 + virtual MXmlEngUserData* CloneL() = 0;
1.64 +
1.65 + /**
1.66 + * Get id of the object. It is up to user-data provider what the result is.
1.67 + * Such a "user data identification" may be in use if several types of
1.68 + * MXmlEngUserData objects are used.
1.69 + *
1.70 + * @since S60 v3.1
1.71 + * @return Pointer that somehow identifies the type of MXmlEngUserData (NULL by default)
1.72 + */
1.73 + virtual void* ID() {return NULL;}
1.74 +};
1.75 +
1.76 +
1.77 +
1.78 +#endif /* XMLENGINE_USERDATA_H_INCLUDED*/