homescreenpluginsrv/inc/mhspsdomlistitem.h
changeset 0 79c6a41cd166
equal deleted inserted replaced
-1:000000000000 0:79c6a41cd166
       
     1 /*
       
     2 * Copyright (c) 2008 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 "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  Interface class for dom list items.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef Mhsps_DOM_LIST_ITEM_H
       
    21 #define Mhsps_DOM_LIST_ITEM_H
       
    22 
       
    23 //  INCLUDES
       
    24 
       
    25 // FORWARD DECLARATIONS
       
    26 
       
    27 
       
    28 // CLASS DECLARATION
       
    29 
       
    30 /**
       
    31 *  Class represents a list item interface. Items are stored into
       
    32 *  a ChspsDomList as a instance of this class.
       
    33 *
       
    34 *  @lib hspsdomdocument.lib
       
    35 *  @since S60 5.0
       
    36 *  @ingroup group_hspsdom
       
    37 */
       
    38 class MhspsDomListItem
       
    39     {
       
    40     public:  // Destructor
       
    41         
       
    42         /**
       
    43         * Destructor.
       
    44         */
       
    45         virtual ~MhspsDomListItem(){}
       
    46 
       
    47     public: // Serializing
       
    48                         
       
    49         /**
       
    50         * This list item's data size in bytes.
       
    51         * 
       
    52         * @since S60 5.0
       
    53         * @return Data size in bytes.
       
    54         */
       
    55         virtual TInt Size() const=0;
       
    56         
       
    57         /**
       
    58         * Externalize list item.
       
    59         * 
       
    60         * @since S60 5.0
       
    61         * @param aStream Output stream
       
    62         */
       
    63         virtual void ExternalizeL( RWriteStream& aStream )const=0;
       
    64         
       
    65         /**
       
    66         * Internalize list item.
       
    67         * 
       
    68         * @since S60 5.0
       
    69         * @param aStream Input stream
       
    70         */
       
    71         virtual void InternalizeL( RReadStream& aStream )=0;
       
    72         
       
    73         
       
    74         
       
    75     public: //Accessing     
       
    76         /**
       
    77         * Get the name of this item as UTF8 encoded, if any.
       
    78         *  
       
    79         * @since S60 5.0
       
    80         * @return Name buffer or KNullDesC8
       
    81         */
       
    82         virtual const TDesC8& Name()=0;     
       
    83  
       
    84     };
       
    85 
       
    86 #endif      // Mhsps_DOM_LIST_ITEM_H 
       
    87             
       
    88 // End of File