williamr@2
|
1 |
/*
|
williamr@2
|
2 |
* Copyright (c) 2004-2006 Nokia Corporation and/or its subsidiary(-ies).
|
williamr@2
|
3 |
* All rights reserved.
|
williamr@2
|
4 |
* This component and the accompanying materials are made available
|
williamr@2
|
5 |
* 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
|
williamr@2
|
6 |
* which accompanies this distribution, and is available
|
williamr@2
|
7 |
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
|
williamr@2
|
8 |
*
|
williamr@2
|
9 |
* Initial Contributors:
|
williamr@2
|
10 |
* Nokia Corporation - initial contribution.
|
williamr@2
|
11 |
*
|
williamr@2
|
12 |
* Contributors:
|
williamr@2
|
13 |
*
|
williamr@2
|
14 |
* Description: Serialization options functions
|
williamr@2
|
15 |
*
|
williamr@2
|
16 |
*/
|
williamr@2
|
17 |
|
williamr@2
|
18 |
|
williamr@2
|
19 |
|
williamr@2
|
20 |
|
williamr@2
|
21 |
|
williamr@2
|
22 |
|
williamr@2
|
23 |
|
williamr@2
|
24 |
|
williamr@2
|
25 |
#ifndef XMLENGINE_SERIALIZATIONOPTIONS_H_INCLUDED
|
williamr@2
|
26 |
#define XMLENGINE_SERIALIZATIONOPTIONS_H_INCLUDED
|
williamr@2
|
27 |
|
williamr@2
|
28 |
#include <e32base.h>
|
williamr@2
|
29 |
|
williamr@2
|
30 |
// FORWARD DECLARATION
|
williamr@2
|
31 |
class MXmlEngOutputStream;
|
williamr@2
|
32 |
class MXmlEngDataSerializer;
|
williamr@2
|
33 |
class MXmlEngNodeFilter;
|
williamr@2
|
34 |
|
williamr@2
|
35 |
/**
|
williamr@2
|
36 |
* Class allow to set serialization option during document save.
|
williamr@2
|
37 |
*
|
williamr@2
|
38 |
* @lib XmlEngineDOM.lib
|
williamr@2
|
39 |
* @since S60 v3.1
|
williamr@2
|
40 |
*/
|
williamr@2
|
41 |
class TXmlEngSerializationOptions
|
williamr@2
|
42 |
{
|
williamr@2
|
43 |
public:
|
williamr@2
|
44 |
/** Use indent in output */
|
williamr@2
|
45 |
static const TUint KOptionIndent = 0x01;
|
williamr@2
|
46 |
/** Skip xml declaration */
|
williamr@2
|
47 |
static const TUint KOptionOmitXMLDeclaration = 0x02;
|
williamr@2
|
48 |
/** Add standalone in xml declaration. KOptionOmitXMLDeclaration must not be set */
|
williamr@2
|
49 |
static const TUint KOptionStandalone = 0x04;
|
williamr@2
|
50 |
/** Add encoding in xml declaration. KOptionOmitXMLDeclaration must not be set */
|
williamr@2
|
51 |
static const TUint KOptionEncoding = 0x08;
|
williamr@2
|
52 |
/** Not supported currently */
|
williamr@2
|
53 |
static const TUint KOptionIncludeNsPrefixes = 0x10;
|
williamr@2
|
54 |
/** Not supported currently */
|
williamr@2
|
55 |
static const TUint KOptionCDATASectionElements = 0x20;
|
williamr@2
|
56 |
/** Decode base64 encoded binary containers content upon XOP serialization*/
|
williamr@2
|
57 |
static const TUint KOptionDecodeBinaryContainers = 0x40;
|
williamr@2
|
58 |
|
williamr@2
|
59 |
/**
|
williamr@2
|
60 |
* Constructor
|
williamr@2
|
61 |
*
|
williamr@2
|
62 |
* @since S60 v3.1
|
williamr@2
|
63 |
* @param aOptionFlags Serialization options
|
williamr@2
|
64 |
* @param aEncoding Serialization encoding
|
williamr@2
|
65 |
*/
|
williamr@2
|
66 |
IMPORT_C TXmlEngSerializationOptions( TUint aOptionFlags =
|
williamr@2
|
67 |
(TXmlEngSerializationOptions::KOptionIndent |
|
williamr@2
|
68 |
TXmlEngSerializationOptions::KOptionStandalone |
|
williamr@2
|
69 |
TXmlEngSerializationOptions::KOptionEncoding),
|
williamr@2
|
70 |
const TDesC8& aEncoding = KNullDesC8);
|
williamr@2
|
71 |
|
williamr@2
|
72 |
/**
|
williamr@2
|
73 |
* Set node filter
|
williamr@2
|
74 |
*
|
williamr@2
|
75 |
* @since S60 v3.1
|
williamr@2
|
76 |
* @param aFilter New node filter
|
williamr@2
|
77 |
*/
|
williamr@2
|
78 |
IMPORT_C void SetNodeFilter(MXmlEngNodeFilter* aFilter);
|
williamr@2
|
79 |
|
williamr@2
|
80 |
public:
|
williamr@2
|
81 |
/** Options flag */
|
williamr@2
|
82 |
TUint iOptions;
|
williamr@2
|
83 |
/** Encoding */
|
williamr@2
|
84 |
TPtrC8 iEncoding;
|
williamr@2
|
85 |
/** Node filter */
|
williamr@2
|
86 |
MXmlEngNodeFilter* iNodeFilter;
|
williamr@2
|
87 |
/** Object whose serialization callback is invoked **/
|
williamr@2
|
88 |
MXmlEngDataSerializer* iDataSerializer;
|
williamr@2
|
89 |
};
|
williamr@2
|
90 |
|
williamr@2
|
91 |
|
williamr@2
|
92 |
|
williamr@2
|
93 |
#endif /* XMLENGINE_SERIALIZATIONOPTIONS_H_INCLUDED */
|