xmlsrv_plat/xml_parser_api/inc/mwbxmlcontenthandler.h
author hgs
Mon, 13 Sep 2010 13:16:40 +0530
changeset 34 c7e9f1c97567
parent 24 xmlsrv_plat/xml_parser_api/inc/MWBXMLContentHandler.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
 * DO NOT USE THIS API. DEPRECATED AND REMOVED IN S60 5.0. USE SYMBIAN XML FRAMEWORK INSTEAD.
hgs
parents:
diff changeset
    24
 */
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
#ifndef __MWBXMLCONTENTHANDLER_H
hgs
parents:
diff changeset
    33
#define __MWBXMLCONTENTHANDLER_H
hgs
parents:
diff changeset
    34
hgs
parents:
diff changeset
    35
#warning The XML API will be removed wk25. Please see http://wikis.in.nokia.com/Browser/APIMigration for more information
hgs
parents:
diff changeset
    36
hgs
parents:
diff changeset
    37
//  INCLUDES
hgs
parents:
diff changeset
    38
#include <e32std.h>
hgs
parents:
diff changeset
    39
hgs
parents:
diff changeset
    40
// CLASS DECLARATION
hgs
parents:
diff changeset
    41
hgs
parents:
diff changeset
    42
/**
hgs
parents:
diff changeset
    43
*  Interface for SAX wbxml Parser Callback events.
hgs
parents:
diff changeset
    44
*  If an application (client) needs to be informed of basic parsing events, 
hgs
parents:
diff changeset
    45
*  it implements this interface and registers an instance with the SAX parser using the SetContentHandler() method.
hgs
parents:
diff changeset
    46
*  The parser uses the instance to report basic document-related events like the start and end of elements.
hgs
parents:
diff changeset
    47
*
hgs
parents:
diff changeset
    48
*  @lib XMLInterface.dll
hgs
parents:
diff changeset
    49
*  @since ?Series60_version
hgs
parents:
diff changeset
    50
*/
hgs
parents:
diff changeset
    51
class MWBXMLContentHandler
hgs
parents:
diff changeset
    52
{
hgs
parents:
diff changeset
    53
public:
hgs
parents:
diff changeset
    54
/**
hgs
parents:
diff changeset
    55
* Receive notification of the beginning of a wbxml document.
hgs
parents:
diff changeset
    56
* @since ?Series60_version
hgs
parents:
diff changeset
    57
* @param none
hgs
parents:
diff changeset
    58
* @return 1 if sucess.
hgs
parents:
diff changeset
    59
*/		
hgs
parents:
diff changeset
    60
    virtual TInt StartDocument() = 0;
hgs
parents:
diff changeset
    61
hgs
parents:
diff changeset
    62
/**
hgs
parents:
diff changeset
    63
* Receive notification of the end of a wbxml document.
hgs
parents:
diff changeset
    64
* @since ?Series60_version
hgs
parents:
diff changeset
    65
* @param none
hgs
parents:
diff changeset
    66
* @return 1 if sucess.
hgs
parents:
diff changeset
    67
*/
hgs
parents:
diff changeset
    68
	virtual TInt EndDocument() = 0;
hgs
parents:
diff changeset
    69
hgs
parents:
diff changeset
    70
/**
hgs
parents:
diff changeset
    71
* Receive notification of the beginning of an element.
hgs
parents:
diff changeset
    72
* @since ?Series60_version
hgs
parents:
diff changeset
    73
* @return 1 if sucess.
hgs
parents:
diff changeset
    74
*/
hgs
parents:
diff changeset
    75
	inline virtual TInt TagStart(){return 1;}
hgs
parents:
diff changeset
    76
hgs
parents:
diff changeset
    77
/**
hgs
parents:
diff changeset
    78
* Receive notification of the end of an element.
hgs
parents:
diff changeset
    79
* @since ?Series60_version
hgs
parents:
diff changeset
    80
* @param none 
hgs
parents:
diff changeset
    81
* @return 1 if sucess.
hgs
parents:
diff changeset
    82
*/
hgs
parents:
diff changeset
    83
	inline virtual TInt TagEnd(){return 1;}
hgs
parents:
diff changeset
    84
hgs
parents:
diff changeset
    85
/**
hgs
parents:
diff changeset
    86
* Receive notification of the beginning of a processing instruction.
hgs
parents:
diff changeset
    87
* @since ?Series60_version
hgs
parents:
diff changeset
    88
* @param none 
hgs
parents:
diff changeset
    89
* @return 1 if sucess.
hgs
parents:
diff changeset
    90
*/
hgs
parents:
diff changeset
    91
	inline virtual TInt ProcessingInstruction(){return 1;}
hgs
parents:
diff changeset
    92
hgs
parents:
diff changeset
    93
/**
hgs
parents:
diff changeset
    94
* Receive notification of the end of a processing instruction.
hgs
parents:
diff changeset
    95
* @since ?Series60_version
hgs
parents:
diff changeset
    96
* @param none 
hgs
parents:
diff changeset
    97
* @return 1 if sucess.
hgs
parents:
diff changeset
    98
*/
hgs
parents:
diff changeset
    99
	inline virtual TInt ProcessingInstructionEnd(){return 1;}
hgs
parents:
diff changeset
   100
	
hgs
parents:
diff changeset
   101
/**
hgs
parents:
diff changeset
   102
* Receive notification of a attribute.
hgs
parents:
diff changeset
   103
* @since ?Series60_version
hgs
parents:
diff changeset
   104
* @param none 
hgs
parents:
diff changeset
   105
* @return 1 if sucess.
hgs
parents:
diff changeset
   106
*/
hgs
parents:
diff changeset
   107
	inline virtual TInt AttributeStart(){return 1;}
hgs
parents:
diff changeset
   108
hgs
parents:
diff changeset
   109
/**
hgs
parents:
diff changeset
   110
* Receive notification of a attribute value.
hgs
parents:
diff changeset
   111
* @since ?Series60_version
hgs
parents:
diff changeset
   112
* @param none 
hgs
parents:
diff changeset
   113
* @return 1 if sucess.
hgs
parents:
diff changeset
   114
*/
hgs
parents:
diff changeset
   115
	inline virtual TInt AttributeValue(){return 1;}
hgs
parents:
diff changeset
   116
/**
hgs
parents:
diff changeset
   117
* Receive notification of content.
hgs
parents:
diff changeset
   118
* @since ?Series60_version
hgs
parents:
diff changeset
   119
* @param none 
hgs
parents:
diff changeset
   120
* @return 1 if sucess.
hgs
parents:
diff changeset
   121
*/
hgs
parents:
diff changeset
   122
	inline virtual TInt Content(){return 1;}
hgs
parents:
diff changeset
   123
hgs
parents:
diff changeset
   124
/**
hgs
parents:
diff changeset
   125
* Receive notification of a code page switch in the document.
hgs
parents:
diff changeset
   126
* @since ?Series60_version
hgs
parents:
diff changeset
   127
* @param none 
hgs
parents:
diff changeset
   128
* @return 1 if sucess.
hgs
parents:
diff changeset
   129
*/
hgs
parents:
diff changeset
   130
	inline virtual TInt CodePageSwitch(){return 1;}
hgs
parents:
diff changeset
   131
hgs
parents:
diff changeset
   132
/**
hgs
parents:
diff changeset
   133
* Receive notification of a extencion.
hgs
parents:
diff changeset
   134
* @since ?Series60_version
hgs
parents:
diff changeset
   135
* @param none 
hgs
parents:
diff changeset
   136
* @return 1 if sucess.
hgs
parents:
diff changeset
   137
*/
hgs
parents:
diff changeset
   138
	inline virtual TInt Extension(){return 1;}
hgs
parents:
diff changeset
   139
	
hgs
parents:
diff changeset
   140
	// Handle data types
hgs
parents:
diff changeset
   141
hgs
parents:
diff changeset
   142
/**
hgs
parents:
diff changeset
   143
* Receive notification of a Token.
hgs
parents:
diff changeset
   144
* @since ?Series60_version
hgs
parents:
diff changeset
   145
* @param aToken: binary token
hgs
parents:
diff changeset
   146
* @param aString: string representation of aToken 
hgs
parents:
diff changeset
   147
* @return 1 if sucess.
hgs
parents:
diff changeset
   148
*/
hgs
parents:
diff changeset
   149
	inline virtual TInt Token(TUint8 /*aToken*/, TDesC& /*aString*/){return 1;}
hgs
parents:
diff changeset
   150
/**
hgs
parents:
diff changeset
   151
* Receive notification of a Fully Qualifyed Token.
hgs
parents:
diff changeset
   152
* @since ?Series60_version
hgs
parents:
diff changeset
   153
* @param aToken: binary token
hgs
parents:
diff changeset
   154
* @param aString: string representation of aToken 
hgs
parents:
diff changeset
   155
* @return 1 if sucess.
hgs
parents:
diff changeset
   156
*/
hgs
parents:
diff changeset
   157
	inline virtual TInt FQToken(TUint32 /*aToken*/, TDesC& /*aString*/){return 1;}
hgs
parents:
diff changeset
   158
hgs
parents:
diff changeset
   159
/**
hgs
parents:
diff changeset
   160
* Receive notification of a inline string.
hgs
parents:
diff changeset
   161
* @since ?Series60_version
hgs
parents:
diff changeset
   162
* @param aString: the inline string. 
hgs
parents:
diff changeset
   163
* @return 1 if sucess.
hgs
parents:
diff changeset
   164
*/
hgs
parents:
diff changeset
   165
	inline virtual TInt InlineString(TDesC& /*aString*/){return 1;}
hgs
parents:
diff changeset
   166
hgs
parents:
diff changeset
   167
/**
hgs
parents:
diff changeset
   168
* Receive notification of a table string.
hgs
parents:
diff changeset
   169
* @since ?Series60_version
hgs
parents:
diff changeset
   170
* @param aString: the table string. 
hgs
parents:
diff changeset
   171
* @return 1 if sucess.
hgs
parents:
diff changeset
   172
*/
hgs
parents:
diff changeset
   173
	inline virtual TInt TableString(TDesC& /*aString*/){return 1;}
hgs
parents:
diff changeset
   174
/**
hgs
parents:
diff changeset
   175
* Receive notification of binary data.
hgs
parents:
diff changeset
   176
* @since ?Series60_version
hgs
parents:
diff changeset
   177
* @param aToken: binary data
hgs
parents:
diff changeset
   178
* @return 1 if sucess.
hgs
parents:
diff changeset
   179
*/
hgs
parents:
diff changeset
   180
	inline virtual TInt Binary(TUint32 /*aToken*/){return 1;}
hgs
parents:
diff changeset
   181
hgs
parents:
diff changeset
   182
/**
hgs
parents:
diff changeset
   183
* Receive notification of opaque data.
hgs
parents:
diff changeset
   184
* @since ?Series60_version
hgs
parents:
diff changeset
   185
* @param aToken: binary data
hgs
parents:
diff changeset
   186
* @param aString: the string representation of aToken 
hgs
parents:
diff changeset
   187
* @return 1 if sucess.
hgs
parents:
diff changeset
   188
*/
hgs
parents:
diff changeset
   189
	inline virtual TInt Opaque(TUint32 /*aToken*/, TDesC& /*aString*/){return 1;}
hgs
parents:
diff changeset
   190
hgs
parents:
diff changeset
   191
/**
hgs
parents:
diff changeset
   192
* Receive notification of entity.
hgs
parents:
diff changeset
   193
* @since ?Series60_version
hgs
parents:
diff changeset
   194
* @param aToken: the entity
hgs
parents:
diff changeset
   195
* @param aString: the string representation of aToken.
hgs
parents:
diff changeset
   196
* @return 1 if sucess.
hgs
parents:
diff changeset
   197
*/
hgs
parents:
diff changeset
   198
	inline virtual TInt Entity(TUint32 /*aToken*/, TDesC& /*aString*/){return 1;}
hgs
parents:
diff changeset
   199
	  	
hgs
parents:
diff changeset
   200
/**
hgs
parents:
diff changeset
   201
* Receive notification of parse error.
hgs
parents:
diff changeset
   202
* @since ?Series60_version
hgs
parents:
diff changeset
   203
* @param 
hgs
parents:
diff changeset
   204
* @return 1 if sucess.
hgs
parents:
diff changeset
   205
*/
hgs
parents:
diff changeset
   206
	inline virtual TInt Exception(){return 1;}
hgs
parents:
diff changeset
   207
hgs
parents:
diff changeset
   208
};
hgs
parents:
diff changeset
   209
hgs
parents:
diff changeset
   210
hgs
parents:
diff changeset
   211
#endif      // __MXMLCONTENTHANDLER_H   
hgs
parents:
diff changeset
   212
            
hgs
parents:
diff changeset
   213
// End of File