xmlsrv_plat/xml_parser_api/inc/rxmlreader.h
author hgs
Mon, 13 Sep 2010 13:16:40 +0530
changeset 34 c7e9f1c97567
parent 24 xmlsrv_plat/xml_parser_api/inc/RXMLReader.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
hgs
parents:
diff changeset
    25
/**
hgs
parents:
diff changeset
    26
 * DO NOT USE THIS API. DEPRECATED AND REMOVED IN S60 5.0. USE SYMBIAN XML FRAMEWORK INSTEAD.
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
hgs
parents:
diff changeset
    36
hgs
parents:
diff changeset
    37
hgs
parents:
diff changeset
    38
hgs
parents:
diff changeset
    39
hgs
parents:
diff changeset
    40
hgs
parents:
diff changeset
    41
#ifndef __RXMLREADER_H
hgs
parents:
diff changeset
    42
#define __RXMLREADER_H
hgs
parents:
diff changeset
    43
hgs
parents:
diff changeset
    44
#warning The XML API will be removed wk25. Please see http://wikis.in.nokia.com/Browser/APIMigration for more information
hgs
parents:
diff changeset
    45
hgs
parents:
diff changeset
    46
hgs
parents:
diff changeset
    47
//  INCLUDES
hgs
parents:
diff changeset
    48
#include <F32File.h>
hgs
parents:
diff changeset
    49
hgs
parents:
diff changeset
    50
#include <xml/MXMLContentHandler.h>
hgs
parents:
diff changeset
    51
#include <xml/MWBXMLContentHandler.h>
hgs
parents:
diff changeset
    52
#include <xml/XMLUtils.h>
hgs
parents:
diff changeset
    53
hgs
parents:
diff changeset
    54
hgs
parents:
diff changeset
    55
// CLASS DECLARATION
hgs
parents:
diff changeset
    56
class CXMLReader;
hgs
parents:
diff changeset
    57
/**
hgs
parents:
diff changeset
    58
*  Interface for XML Parser.
hgs
parents:
diff changeset
    59
*  
hgs
parents:
diff changeset
    60
*  @lib XMLInterface.dll
hgs
parents:
diff changeset
    61
*  @since ?Series60_version
hgs
parents:
diff changeset
    62
*/
hgs
parents:
diff changeset
    63
class RXMLReader
hgs
parents:
diff changeset
    64
{
hgs
parents:
diff changeset
    65
public: // New functions
hgs
parents:
diff changeset
    66
hgs
parents:
diff changeset
    67
	inline RXMLReader();
hgs
parents:
diff changeset
    68
hgs
parents:
diff changeset
    69
/** 
hgs
parents:
diff changeset
    70
* Creates the parser. 
hgs
parents:
diff changeset
    71
* This function leaves with an apropriate code if the create failed.
hgs
parents:
diff changeset
    72
* 
hgs
parents:
diff changeset
    73
*/
hgs
parents:
diff changeset
    74
	IMPORT_C void CreateL();
hgs
parents:
diff changeset
    75
hgs
parents:
diff changeset
    76
/** 
hgs
parents:
diff changeset
    77
* Destroys the parser. 
hgs
parents:
diff changeset
    78
* 
hgs
parents:
diff changeset
    79
*/
hgs
parents:
diff changeset
    80
	IMPORT_C void Destroy();
hgs
parents:
diff changeset
    81
hgs
parents:
diff changeset
    82
/** 
hgs
parents:
diff changeset
    83
* Destroys the parser. 
hgs
parents:
diff changeset
    84
* 
hgs
parents:
diff changeset
    85
*/
hgs
parents:
diff changeset
    86
	IMPORT_C void Close();
hgs
parents:
diff changeset
    87
	
hgs
parents:
diff changeset
    88
hgs
parents:
diff changeset
    89
/**
hgs
parents:
diff changeset
    90
* Enables/Dissables a feature.
hgs
parents:
diff changeset
    91
* @since ?Series60_version
hgs
parents:
diff changeset
    92
* @param aFeature: The feature to Enable/Dissable.
hgs
parents:
diff changeset
    93
* @param aStatus: TRUE Enables the feature, FALSE Dissables.
hgs
parents:
diff changeset
    94
* @return KErrNone if OK, KErrNotSupported if feature not supported.
hgs
parents:
diff changeset
    95
*/
hgs
parents:
diff changeset
    96
	IMPORT_C TInt SetFeature(TXMLFeature aFeature, TBool aStatus);
hgs
parents:
diff changeset
    97
hgs
parents:
diff changeset
    98
/**
hgs
parents:
diff changeset
    99
* Check if a feature is Enabled.
hgs
parents:
diff changeset
   100
* @since ?Series60_version
hgs
parents:
diff changeset
   101
* @param aFeature: The feature to check.
hgs
parents:
diff changeset
   102
* @param aStatus: TRUE if aFeature is Enabled. 
hgs
parents:
diff changeset
   103
* @return KErrNone if OK, KErrNotSupported if feature not supported.
hgs
parents:
diff changeset
   104
*/
hgs
parents:
diff changeset
   105
	IMPORT_C TInt GetFeature(TXMLFeature aFeature, TBool& aStatus);
hgs
parents:
diff changeset
   106
hgs
parents:
diff changeset
   107
/**
hgs
parents:
diff changeset
   108
* Allow an application to register a content event handler (for XML).
hgs
parents:
diff changeset
   109
* @since ?Series60_version
hgs
parents:
diff changeset
   110
* @param aContentHandler: The handler.
hgs
parents:
diff changeset
   111
* @return Status, KErrNone if OK.
hgs
parents:
diff changeset
   112
*/
hgs
parents:
diff changeset
   113
	IMPORT_C TInt SetContentHandler(MXMLContentHandler* aContentHandler);
hgs
parents:
diff changeset
   114
hgs
parents:
diff changeset
   115
/**
hgs
parents:
diff changeset
   116
* Allow an application to register a content event handler (for WBXML).
hgs
parents:
diff changeset
   117
* @since ?Series60_version
hgs
parents:
diff changeset
   118
* @param aContentHandler: The handler.
hgs
parents:
diff changeset
   119
* @return Status, KErrNone if OK.
hgs
parents:
diff changeset
   120
*/
hgs
parents:
diff changeset
   121
	IMPORT_C TInt SetContentHandler(MWBXMLContentHandler* aContentHandler);
hgs
parents:
diff changeset
   122
hgs
parents:
diff changeset
   123
/**
hgs
parents:
diff changeset
   124
* Parse an XML document.
hgs
parents:
diff changeset
   125
* @since ?Series60_version
hgs
parents:
diff changeset
   126
* @param aRFs: An open filesession.
hgs
parents:
diff changeset
   127
* @param aFileToParse: Filename of file to parse.
hgs
parents:
diff changeset
   128
* @return
hgs
parents:
diff changeset
   129
*/
hgs
parents:
diff changeset
   130
	IMPORT_C void ParseL(RFs &aRFs, const TDesC& aFileToParse);
hgs
parents:
diff changeset
   131
hgs
parents:
diff changeset
   132
/**
hgs
parents:
diff changeset
   133
* Parse an XML document.
hgs
parents:
diff changeset
   134
* @since ?Series60_version
hgs
parents:
diff changeset
   135
* @param aBuff: Buffer containing document to parse. 
hgs
parents:
diff changeset
   136
* @return 
hgs
parents:
diff changeset
   137
*/
hgs
parents:
diff changeset
   138
	IMPORT_C void ParseL(const TDesC8& aBuff);
hgs
parents:
diff changeset
   139
hgs
parents:
diff changeset
   140
/**
hgs
parents:
diff changeset
   141
* Parse an XML document.
hgs
parents:
diff changeset
   142
* @since ?Series60_version
hgs
parents:
diff changeset
   143
* @param aOpenedFile: Opened file containing document to parse. 
hgs
parents:
diff changeset
   144
* @return 
hgs
parents:
diff changeset
   145
*/
hgs
parents:
diff changeset
   146
	IMPORT_C void ParseL(RFile& aOpenedFile);
hgs
parents:
diff changeset
   147
hgs
parents:
diff changeset
   148
private:
hgs
parents:
diff changeset
   149
	friend class CXMLReader;
hgs
parents:
diff changeset
   150
hgs
parents:
diff changeset
   151
	CXMLReader* iImplementation;
hgs
parents:
diff changeset
   152
};
hgs
parents:
diff changeset
   153
hgs
parents:
diff changeset
   154
inline RXMLReader::RXMLReader()
hgs
parents:
diff changeset
   155
		: iImplementation(0)
hgs
parents:
diff changeset
   156
	{
hgs
parents:
diff changeset
   157
	}
hgs
parents:
diff changeset
   158
hgs
parents:
diff changeset
   159
#endif      // __RXMLREADER_H   
hgs
parents:
diff changeset
   160
            
hgs
parents:
diff changeset
   161
// End of File