xmlsrv_plat/xml_parser_api/inc/mxmlattributes.h
author hgs
Mon, 13 Sep 2010 13:16:40 +0530
changeset 34 c7e9f1c97567
parent 24 xmlsrv_plat/xml_parser_api/inc/MXMLAttributes.h@74f0b3eb154c
permissions -rw-r--r--
201037
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
24
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2002 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of the License "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
/**
hgs
parents:
diff changeset
    24
 * DO NOT USE THIS API. DEPRECATED AND REMOVED IN S60 5.0. USE SYMBIAN XML FRAMEWORK INSTEAD.
hgs
parents:
diff changeset
    25
 */
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
hgs
parents:
diff changeset
    31
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
hgs
parents:
diff changeset
    34
hgs
parents:
diff changeset
    35
#ifndef __MXMLATTRIBUTES_H
hgs
parents:
diff changeset
    36
#define __MXMLATTRIBUTES_H
hgs
parents:
diff changeset
    37
hgs
parents:
diff changeset
    38
#warning The XML API will be removed wk25. Please see http://wikis.in.nokia.com/Browser/APIMigration for more information
hgs
parents:
diff changeset
    39
hgs
parents:
diff changeset
    40
hgs
parents:
diff changeset
    41
//  INCLUDES
hgs
parents:
diff changeset
    42
#include <e32std.h>
hgs
parents:
diff changeset
    43
hgs
parents:
diff changeset
    44
// CLASS DECLARATION
hgs
parents:
diff changeset
    45
hgs
parents:
diff changeset
    46
/**
hgs
parents:
diff changeset
    47
*  Interface for a list of XML elemnet attributes.
hgs
parents:
diff changeset
    48
*  Contains a list of attributes belonging to a certain element and is returned in the 
hgs
parents:
diff changeset
    49
*  MXMLContentHandler::StartElement() callback.
hgs
parents:
diff changeset
    50
*
hgs
parents:
diff changeset
    51
*  @lib XMLInterface.dll
hgs
parents:
diff changeset
    52
*  @since ?Series60_version
hgs
parents:
diff changeset
    53
*
hgs
parents:
diff changeset
    54
*/
hgs
parents:
diff changeset
    55
hgs
parents:
diff changeset
    56
class MXMLAttributes
hgs
parents:
diff changeset
    57
{
hgs
parents:
diff changeset
    58
public:
hgs
parents:
diff changeset
    59
   
hgs
parents:
diff changeset
    60
/**
hgs
parents:
diff changeset
    61
* Look up the index of an attribute by name.
hgs
parents:
diff changeset
    62
* @since ?Series60_version
hgs
parents:
diff changeset
    63
* @param aName: Name of attribute to look up
hgs
parents:
diff changeset
    64
* @return Index of aName
hgs
parents:
diff changeset
    65
*/
hgs
parents:
diff changeset
    66
	virtual TInt GetIndex(TDesC& aName) = 0;
hgs
parents:
diff changeset
    67
hgs
parents:
diff changeset
    68
/**
hgs
parents:
diff changeset
    69
* Get the number of attributes in the list.
hgs
parents:
diff changeset
    70
* @since ?Series60_version
hgs
parents:
diff changeset
    71
* @param none
hgs
parents:
diff changeset
    72
* @return The number of attributes in the list.
hgs
parents:
diff changeset
    73
*/
hgs
parents:
diff changeset
    74
	virtual  TInt GetLength() = 0;
hgs
parents:
diff changeset
    75
	
hgs
parents:
diff changeset
    76
/**
hgs
parents:
diff changeset
    77
* Look up the name of an attribute by index.
hgs
parents:
diff changeset
    78
* @since ?Series60_version
hgs
parents:
diff changeset
    79
* @param aIndex: Index of attribute to look up.
hgs
parents:
diff changeset
    80
* @return Name of attribute at index aIndex.
hgs
parents:
diff changeset
    81
*/
hgs
parents:
diff changeset
    82
	virtual TPtrC GetName(TInt aIndex) = 0;
hgs
parents:
diff changeset
    83
hgs
parents:
diff changeset
    84
/**
hgs
parents:
diff changeset
    85
* Look up an attribute's value by name.
hgs
parents:
diff changeset
    86
* @since ?Series60_version
hgs
parents:
diff changeset
    87
* @param aName: Name of attribute to look up
hgs
parents:
diff changeset
    88
* @return Value of attribute aName.
hgs
parents:
diff changeset
    89
*/
hgs
parents:
diff changeset
    90
	virtual TPtrC GetValue(TDesC& aName) = 0;
hgs
parents:
diff changeset
    91
hgs
parents:
diff changeset
    92
/**
hgs
parents:
diff changeset
    93
* Look up an attribute's value by index.
hgs
parents:
diff changeset
    94
* @since ?Series60_version
hgs
parents:
diff changeset
    95
* @param aIndex: Index of attribute to look up.
hgs
parents:
diff changeset
    96
* @return Value of attribute at aIndex.
hgs
parents:
diff changeset
    97
*/
hgs
parents:
diff changeset
    98
	virtual TPtrC GetValue(TInt& aIndex) = 0;
hgs
parents:
diff changeset
    99
hgs
parents:
diff changeset
   100
/**
hgs
parents:
diff changeset
   101
* Look up an attribute's type by index.
hgs
parents:
diff changeset
   102
* @since ?Series60_version
hgs
parents:
diff changeset
   103
* @param aIndex: Index of attribute to look up.
hgs
parents:
diff changeset
   104
* @return Type of attribute at aIndex.
hgs
parents:
diff changeset
   105
*/
hgs
parents:
diff changeset
   106
// R&D: Feature: GetType missing from Attributes
hgs
parents:
diff changeset
   107
	virtual TPtrC GetType(TInt aIndex) = 0;
hgs
parents:
diff changeset
   108
hgs
parents:
diff changeset
   109
/**
hgs
parents:
diff changeset
   110
* Look up an attribute's type by name.
hgs
parents:
diff changeset
   111
* @since ?Series60_version
hgs
parents:
diff changeset
   112
* @param aIndex: Index of attribute to look up.
hgs
parents:
diff changeset
   113
* @return ?description
hgs
parents:
diff changeset
   114
*/
hgs
parents:
diff changeset
   115
// R&D: Feature: GetType missing from Attributes
hgs
parents:
diff changeset
   116
	virtual TPtrC GetType(TDesC& aName) = 0;
hgs
parents:
diff changeset
   117
  
hgs
parents:
diff changeset
   118
};
hgs
parents:
diff changeset
   119
hgs
parents:
diff changeset
   120
#endif      // __MXMLATTRIBUTES_H  
hgs
parents:
diff changeset
   121
            
hgs
parents:
diff changeset
   122
// End of File