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