epoc32/include/gmxmlparser.h
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
     1 // Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
     1 // Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     3 // This component and the accompanying materials are made available
     4 // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     7 //
     8 // Initial Contributors:
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
     9 // Nokia Corporation - initial contribution.
    10 //
    10 //
    11 // Contributors:
    11 // Contributors:
    15 // which is responsible for creating a DOM structure
    15 // which is responsible for creating a DOM structure
    16 // from a given XML file.
    16 // from a given XML file.
    17 // 
    17 // 
    18 //
    18 //
    19 
    19 
    20 
       
    21 
       
    22 /**
    20 /**
    23  @file
    21  @file
    24 */
    22 */
    25 
    23 
    26 #ifndef __GMXMLPARSER_H__
    24 #ifndef __GMXMLPARSER_H__
    27 #define __GMXMLPARSER_H__
    25 #define __GMXMLPARSER_H__
    28 
    26 
    29 #include <e32std.h>
    27 #include <e32std.h>
    30 #include <eikenv.h>
    28 #include <txtetext.h>
    31 #include <gmxmlconstants.h>
    29 #include <gmxmlconstants.h>
       
    30 #include <f32file.h>
    32 
    31 
    33 //forward reference
    32 //forward reference
    34 class CMDXMLDocument;
    33 class CMDXMLDocument;
    35 class CMDXMLEntityConverter;
    34 class CMDXMLEntityConverter;
    36 class CMDXMLElement;
    35 class CMDXMLElement;
    64 	{
    63 	{
    65 public:
    64 public:
    66 	/** Status codes returned by GetData() implementations. */
    65 	/** Status codes returned by GetData() implementations. */
    67 	enum TDataProviderResults
    66 	enum TDataProviderResults
    68 		{
    67 		{
    69 		KMoreData,		///< Returned by the interface implementation when it is returning more data.
    68 		KMoreData,		//< Returned by the interface implementation when it is returning more data.
    70 		KDataStreamError,	///< Returned by the interface when an unrecoverable error prevents obtaining more data.  A recoverable error should be represented by KDataNotReady.
    69 		KDataStreamError,	//< Returned by the interface when an unrecoverable error prevents obtaining more data.  A recoverable error should be represented by KDataNotReady.
    71 		KDataStreamEnd	///< Returned by the interface when there is no more data to come.
    70 		KDataStreamEnd	//< Returned by the interface when there is no more data to come.
    72 		};
    71 		};
    73 
    72 
    74 public:
    73 public:
    75 	/** 
    74 	/** 
    76 	The XML Parser calls this on a specific data provider to get more data
    75 	The XML Parser calls this on a specific data provider to get more data
   221 	IMPORT_C void ParseSourceL(MMDXMLParserDataProvider *aSource);
   220 	IMPORT_C void ParseSourceL(MMDXMLParserDataProvider *aSource);
   222 
   221 
   223 	/** Defines input stream character widths. */
   222 	/** Defines input stream character widths. */
   224 	enum TMDXMLParserInputCharWidth
   223 	enum TMDXMLParserInputCharWidth
   225 		{
   224 		{
   226 		EAscii = 0x01, ///< ASCII
   225 		EAscii = 0x01, //< ASCII
   227 		EUnicode = 0x02 ///<Unicode
   226 		EUnicode = 0x02 //<Unicode
   228 		};
   227 		};
   229 	
   228 	
   230 	/** Sets the input stream character width.
   229 	/** Sets the input stream character width.
   231 	 *
   230 	 *
   232 	 * @param aWidth Character width for incoming stream.  Possible values are EAscii and EUnicode (representing Ascii/UTF8 and Unicode respectively).
   231 	 * @param aWidth Character width for incoming stream.  Possible values are EAscii and EUnicode (representing Ascii/UTF8 and Unicode respectively).