1 /* |
1 // Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies). |
2 * Copyright (c) 2004-2006 Nokia Corporation and/or its subsidiary(-ies). |
2 // All rights reserved. |
3 * All rights reserved. |
3 // This component and the accompanying materials are made available |
4 * This component and the accompanying materials are made available |
4 // under the terms of "Eclipse Public License v1.0" |
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 |
5 // which accompanies this distribution, and is available |
6 * which accompanies this distribution, and is available |
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html". |
7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html". |
7 // |
8 * |
8 // Initial Contributors: |
9 * Initial Contributors: |
9 // Nokia Corporation - initial contribution. |
10 * Nokia Corporation - initial contribution. |
10 // |
11 * |
11 // Contributors: |
12 * Contributors: |
12 // |
13 * |
13 // Description: |
14 * Description: Processing instruction node functions |
14 // Processing instruction node functions |
15 * |
15 // |
16 */ |
|
17 |
|
18 |
|
19 |
|
20 |
|
21 |
|
22 |
|
23 |
|
24 #ifndef XMLENGINE_PROCESSINGINSTRUCTION_H_INCLUDED |
|
25 #define XMLENGINE_PROCESSINGINSTRUCTION_H_INCLUDED |
|
26 |
|
27 #include "xmlengnode.h" |
|
28 |
16 |
29 |
17 |
30 |
18 |
31 /** |
19 /** |
32 * Instance of TXmlEngProcessingInstruction class represents an XML processing |
20 @file |
33 * instruction in the DOM tree. |
21 @publishedAll |
34 * |
22 @released |
35 * @lib XmlEngineDOM.lib |
23 */ |
36 * @since S60 v3.1 |
24 #ifndef XMLENGPROCESSINGINSTRUCTION_H |
37 */ |
25 #define XMLENGPROCESSINGINSTRUCTION_H |
|
26 |
|
27 #include <xml/dom/xmlengnode.h> |
|
28 |
|
29 |
|
30 |
|
31 /** |
|
32 This class represents an XML processing instruction in the DOM tree. This class |
|
33 is usually instantiated through RXmlEngDocument::CreateProcessingInstruction(). |
|
34 */ |
38 class TXmlEngProcessingInstruction : public TXmlEngNode |
35 class TXmlEngProcessingInstruction : public TXmlEngNode |
39 { |
36 { |
40 public: |
37 public: |
41 /** |
38 /** Default constructor */ |
42 * Default constructor |
|
43 * |
|
44 * @since S60 v3.1 |
|
45 */ |
|
46 inline TXmlEngProcessingInstruction(); |
39 inline TXmlEngProcessingInstruction(); |
47 |
40 |
48 /** |
41 /** |
49 * Get target of processing instruction. |
42 Gets a reference to the the target part of the processing instruction. |
50 * |
43 |
51 * @since S60 v3.1 |
44 @code |
52 * @return "Target" part of a processing instruction |
45 <?target data?> |
53 * |
46 @endcode |
54 * @code |
47 |
55 * <?target data?> |
48 @see http://www.w3.org/TR/2004/REC-xml-20040204/#sec-pi |
56 * @endcode |
49 @return A reference to the target part |
57 * @see http://www.w3.org/TR/2004/REC-xml-20040204/#sec-pi |
50 */ |
58 */ |
|
59 IMPORT_C TPtrC8 Target() const; |
51 IMPORT_C TPtrC8 Target() const; |
60 |
52 |
61 /** |
53 /** |
62 * Get data of processing instruction. |
54 Gets a reference to the data part of the processing instruction. |
63 * |
55 |
64 * @since S60 v3.1 |
56 @code |
65 * @return "Data" part of a processing instruction |
57 <?target data?> |
66 * |
58 @endcode |
67 * @code |
59 |
68 * <?target data?> |
60 @see http://www.w3.org/TR/2004/REC-xml-20040204/#sec-pi |
69 * @endcode |
61 @return A reference to the data part |
70 * @see http://www.w3.org/TR/2004/REC-xml-20040204/#sec-pi |
62 */ |
71 */ |
|
72 IMPORT_C TPtrC8 Data() const; |
63 IMPORT_C TPtrC8 Data() const; |
73 |
64 |
74 /** |
65 /** |
75 * Sets data part of processing instruction |
66 Copies the parameter and sets the data part of the processing instruction. |
76 * |
67 Note: The processing instruction contents should not contain the "?>" |
77 * @since S60 v3.1 |
68 sequence |
78 * @param aData New data part of processing instruction |
69 @param aData The data part to set |
79 * @note PI contents should not contain "?>" sequence |
70 @leave - One of the system-wide error codes |
80 */ |
71 */ |
81 IMPORT_C void SetDataL(const TDesC8& aData); |
72 IMPORT_C void SetDataL(const TDesC8& aData); |
82 |
73 |
83 protected: |
74 protected: |
84 /** |
75 /** |
85 * Constructor |
76 Constructor |
86 * |
77 @param aInternal Processing instruction pointer |
87 * @since S60 v3.1 |
78 */ |
88 * @param aInternal processing instruction pointer |
|
89 */ |
|
90 inline TXmlEngProcessingInstruction(void* aInternal); |
79 inline TXmlEngProcessingInstruction(void* aInternal); |
91 }; |
80 }; |
92 |
81 |
93 |
82 |
|
83 #include <xml/dom/xmlengprocessinginstruction.inl> |
|
84 #endif /* XMLENGPROCESSINGINSTRUCTION_H */ |
94 |
85 |
95 #include "xmlengprocessinginstruction.inl" |
|
96 #endif /* XMLENGINE_PROCESSINGINSTRUCTION_H_INCLUDED */ |
|