1 xmlenguserdata.h

     1 /*

     2 * Copyright (c) 2004-2005 Nokia Corporation and/or its subsidiary(-ies). 

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * 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

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:       Interface class describing class that may contains user

    15  *                 data aded to node

    16  *

    17 */

    18 

    19 

    20 

    21 

    22 

    23 

    24 

    25 #ifndef XMLENGINE_USERDATA_H_INCLUDED

    26 #define XMLENGINE_USERDATA_H_INCLUDED

    27 

    28 #include <e32def.h>

    29 

    30 /**

    31  * MXmlEngUserData is an abstract base class (interface) for user data that can be

    32  * stored in the DOM tree. Applications that wish to store user data in the 

    33  * DOM tree must wrap the user data in a class that implemens this interface.

    34  *

    35  * @lib XmlEngineDOM.lib

    36  * @since S60 v3.1

    37  */

    38 class MXmlEngUserData {

    39 public:

    40     /**

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

    42      *

    43      * @since S60 v3.1

    44      */

    45     virtual void Destroy() = 0;

    46     

    47     /**

    48      * Make a copy of the the object. Note that if reference counting is used or

    49      * the same pointer can be safely copied to other places the implementation

    50      * of this method may just return a pointer to self.

    51      *

    52      * Copying user data when copying nodes has not been implemented

    53      * so this method is for future use (though there's no harm in implementing 

    54      * it, of course).

    55      *

    56      * @since S60 v3.1

    57      * @return Pointer to a copy of this object.

    58      */

    59     virtual MXmlEngUserData* CloneL() = 0;

    60 

    61     /**

    62      * Get id of the object. It is up to user-data provider what the result is.

    63      * Such a "user data identification" may be in use if several types of

    64      * MXmlEngUserData objects are used.

    65      *

    66      * @since S60 v3.1

    67      * @return Pointer that somehow identifies the type of MXmlEngUserData (NULL by default)

    68      */

    69     virtual void* ID() {return NULL;}

    70 };

    71 

    72 

    73 

    74 #endif /* XMLENGINE_USERDATA_H_INCLUDED*/