MXmlEngUserData Class Reference

Link against: xmlengineDOM.lib

#include <xmlenguserdata.h>

Detailed Description

MXmlEngUserData is an abstract base class (interface) for user data that can be stored in the DOM tree.

Applications that wish to store user data in the DOM tree must wrap the user data in a class that implemens this interface.

Dll XmlEngineDOM.lib
Since:
S60 v3.1

Public Member Functions

virtual void Destroy ()=0
 Free memory that is allocated and do other case specific cleanup.
virtual MXmlEngUserData * CloneL ()=0
 Make a copy of the the object.
virtual void * ID ()
 Get id of the object.

Member Function Documentation

virtual MXmlEngUserData* MXmlEngUserData::CloneL (   )  [pure virtual]
 

Make a copy of the the object.

Note that if reference counting is used or the same pointer can be safely copied to other places the implementation of this method may just return a pointer to self.

Copying user data when copying nodes has not been implemented so this method is for future use (though there's no harm in implementing it, of course).

Since:
S60 v3.1
Returns:
Pointer to a copy of this object.
virtual void MXmlEngUserData::Destroy (   )  [pure virtual]
 

Free memory that is allocated and do other case specific cleanup.

Since:
S60 v3.1
virtual void* MXmlEngUserData::ID (   )  [inline, virtual]
 

Get id of the object.

It is up to user-data provider what the result is. Such a "user data identification" may be in use if several types of MXmlEngUserData objects are used.

Since:
S60 v3.1
Returns:
Pointer that somehow identifies the type of MXmlEngUserData (NULL by default)
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top