web_plat/xml_parser_api/inc/MXMLAttributes.h
changeset 0 dd21522fd290
child 48 79859ed3eea9
equal deleted inserted replaced
-1:000000000000 0:dd21522fd290
       
     1 /*
       
     2 * Copyright (c) 2002 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 "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:  
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 
       
    21 
       
    22 
       
    23 /**
       
    24  * DO NOT USE THIS API. DEPRECATED AND REMOVED IN S60 5.0. USE SYMBIAN XML FRAMEWORK INSTEAD.
       
    25  */
       
    26 
       
    27 
       
    28 
       
    29 
       
    30 
       
    31 
       
    32 
       
    33 
       
    34 
       
    35 #ifndef __MXMLATTRIBUTES_H
       
    36 #define __MXMLATTRIBUTES_H
       
    37 
       
    38 //  INCLUDES
       
    39 #include <e32std.h>
       
    40 
       
    41 // CLASS DECLARATION
       
    42 
       
    43 /**
       
    44 *  Interface for a list of XML elemnet attributes.
       
    45 *  Contains a list of attributes belonging to a certain element and is returned in the 
       
    46 *  MXMLContentHandler::StartElement() callback.
       
    47 *
       
    48 *  @lib XMLInterface.dll
       
    49 *  @since ?Series60_version
       
    50 *
       
    51 */
       
    52 
       
    53 class MXMLAttributes
       
    54 {
       
    55 public:
       
    56    
       
    57 /**
       
    58 * Look up the index of an attribute by name.
       
    59 * @since ?Series60_version
       
    60 * @param aName: Name of attribute to look up
       
    61 * @return Index of aName
       
    62 */
       
    63 	virtual TInt GetIndex(TDesC& aName) = 0;
       
    64 
       
    65 /**
       
    66 * Get the number of attributes in the list.
       
    67 * @since ?Series60_version
       
    68 * @param none
       
    69 * @return The number of attributes in the list.
       
    70 */
       
    71 	virtual  TInt GetLength() = 0;
       
    72 	
       
    73 /**
       
    74 * Look up the name of an attribute by index.
       
    75 * @since ?Series60_version
       
    76 * @param aIndex: Index of attribute to look up.
       
    77 * @return Name of attribute at index aIndex.
       
    78 */
       
    79 	virtual TPtrC GetName(TInt aIndex) = 0;
       
    80 
       
    81 /**
       
    82 * Look up an attribute's value by name.
       
    83 * @since ?Series60_version
       
    84 * @param aName: Name of attribute to look up
       
    85 * @return Value of attribute aName.
       
    86 */
       
    87 	virtual TPtrC GetValue(TDesC& aName) = 0;
       
    88 
       
    89 /**
       
    90 * Look up an attribute's value by index.
       
    91 * @since ?Series60_version
       
    92 * @param aIndex: Index of attribute to look up.
       
    93 * @return Value of attribute at aIndex.
       
    94 */
       
    95 	virtual TPtrC GetValue(TInt& aIndex) = 0;
       
    96 
       
    97 /**
       
    98 * Look up an attribute's type by index.
       
    99 * @since ?Series60_version
       
   100 * @param aIndex: Index of attribute to look up.
       
   101 * @return Type of attribute at aIndex.
       
   102 */
       
   103 // R&D: Feature: GetType missing from Attributes
       
   104 	virtual TPtrC GetType(TInt aIndex) = 0;
       
   105 
       
   106 /**
       
   107 * Look up an attribute's type by name.
       
   108 * @since ?Series60_version
       
   109 * @param aIndex: Index of attribute to look up.
       
   110 * @return ?description
       
   111 */
       
   112 // R&D: Feature: GetType missing from Attributes
       
   113 	virtual TPtrC GetType(TDesC& aName) = 0;
       
   114   
       
   115 };
       
   116 
       
   117 #endif      // __MXMLATTRIBUTES_H  
       
   118             
       
   119 // End of File