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 #warning The XML API will be removed wk25. Please see http://wikis.in.nokia.com/Browser/APIMigration for more information

    39 

    40 

    41 //  INCLUDES

    42 #include <e32std.h>

    43 

    44 // CLASS DECLARATION

    45 

    46 /**

    47 *  Interface for a list of XML elemnet attributes.

    48 *  Contains a list of attributes belonging to a certain element and is returned in the 

    49 *  MXMLContentHandler::StartElement() callback.

    50 *

    51 *  @lib XMLInterface.dll

    52 *  @since ?Series60_version

    53 *

    54 */

    55 

    56 class MXMLAttributes

    57 {

    58 public:

    59    

    60 /**

    61 * Look up the index of an attribute by name.

    62 * @since ?Series60_version

    63 * @param aName: Name of attribute to look up

    64 * @return Index of aName

    65 */

    66 	virtual TInt GetIndex(TDesC& aName) = 0;

    67 

    68 /**

    69 * Get the number of attributes in the list.

    70 * @since ?Series60_version

    71 * @param none

    72 * @return The number of attributes in the list.

    73 */

    74 	virtual  TInt GetLength() = 0;

    75 	

    76 /**

    77 * Look up the name of an attribute by index.

    78 * @since ?Series60_version

    79 * @param aIndex: Index of attribute to look up.

    80 * @return Name of attribute at index aIndex.

    81 */

    82 	virtual TPtrC GetName(TInt aIndex) = 0;

    83 

    84 /**

    85 * Look up an attribute's value by name.

    86 * @since ?Series60_version

    87 * @param aName: Name of attribute to look up

    88 * @return Value of attribute aName.

    89 */

    90 	virtual TPtrC GetValue(TDesC& aName) = 0;

    91 

    92 /**

    93 * Look up an attribute's value by index.

    94 * @since ?Series60_version

    95 * @param aIndex: Index of attribute to look up.

    96 * @return Value of attribute at aIndex.

    97 */

    98 	virtual TPtrC GetValue(TInt& aIndex) = 0;

    99 

   100 /**

   101 * Look up an attribute's type by index.

   102 * @since ?Series60_version

   103 * @param aIndex: Index of attribute to look up.

   104 * @return Type of attribute at aIndex.

   105 */

   106 // R&D: Feature: GetType missing from Attributes

   107 	virtual TPtrC GetType(TInt aIndex) = 0;

   108 

   109 /**

   110 * Look up an attribute's type by name.

   111 * @since ?Series60_version

   112 * @param aIndex: Index of attribute to look up.

   113 * @return ?description

   114 */

   115 // R&D: Feature: GetType missing from Attributes

   116 	virtual TPtrC GetType(TDesC& aName) = 0;

   117   

   118 };

   119 

   120 #endif      // __MXMLATTRIBUTES_H  

   121             

   122 // End of File