|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). |
|
4 ** All rights reserved. |
|
5 ** Contact: Nokia Corporation (qt-info@nokia.com) |
|
6 ** |
|
7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit. |
|
8 ** |
|
9 ** $QT_BEGIN_LICENSE:LGPL$ |
|
10 ** No Commercial Usage |
|
11 ** This file contains pre-release code and may not be distributed. |
|
12 ** You may use this file in accordance with the terms and conditions |
|
13 ** contained in the Technology Preview License Agreement accompanying |
|
14 ** this package. |
|
15 ** |
|
16 ** GNU Lesser General Public License Usage |
|
17 ** Alternatively, this file may be used under the terms of the GNU Lesser |
|
18 ** General Public License version 2.1 as published by the Free Software |
|
19 ** Foundation and appearing in the file LICENSE.LGPL included in the |
|
20 ** packaging of this file. Please review the following information to |
|
21 ** ensure the GNU Lesser General Public License version 2.1 requirements |
|
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
|
23 ** |
|
24 ** In addition, as a special exception, Nokia gives you certain additional |
|
25 ** rights. These rights are described in the Nokia Qt LGPL Exception |
|
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
|
27 ** |
|
28 ** If you have questions regarding the use of this file, please contact |
|
29 ** Nokia at qt-info@nokia.com. |
|
30 ** |
|
31 ** |
|
32 ** |
|
33 ** |
|
34 ** |
|
35 ** |
|
36 ** |
|
37 ** |
|
38 ** $QT_END_LICENSE$ |
|
39 ** |
|
40 ****************************************************************************/ |
|
41 |
|
42 // |
|
43 // W A R N I N G |
|
44 // ------------- |
|
45 // |
|
46 // This file is not part of the Qt API. It exists purely as an |
|
47 // implementation detail. This header file may change from version to |
|
48 // version without notice, or even be removed. |
|
49 // |
|
50 // We mean it. |
|
51 |
|
52 #ifndef Patternist_NodeBuilder_H |
|
53 #define Patternist_NodeBuilder_H |
|
54 |
|
55 #include "qitem_p.h" |
|
56 #include "qabstractxmlreceiver.h" |
|
57 #include "qautoptr_p.h" |
|
58 |
|
59 QT_BEGIN_HEADER |
|
60 |
|
61 QT_BEGIN_NAMESPACE |
|
62 |
|
63 namespace QPatternist |
|
64 { |
|
65 /** |
|
66 * @short Receives QAbstractXmlReceiver events and builds a node tree |
|
67 * in memory that afterwards can be retrieved via builtNode() |
|
68 * |
|
69 * @ingroup Patternist_xdm |
|
70 * @author Frans Englich <frans.englich@nokia.com> |
|
71 */ |
|
72 class NodeBuilder : public QAbstractXmlReceiver |
|
73 { |
|
74 public: |
|
75 typedef AutoPtr<NodeBuilder> Ptr; |
|
76 |
|
77 inline NodeBuilder() |
|
78 { |
|
79 } |
|
80 |
|
81 /** |
|
82 * @short Returns the document that has been built. |
|
83 * |
|
84 * If this function is called before any events have been received, the result is undefined. |
|
85 * |
|
86 * The top node that was constructed can be retrieved by calling |
|
87 * NodeModel::root() on the returned NodeModel. |
|
88 * |
|
89 * This function is not @c const, because some implementations delay |
|
90 * the node construction until the node is needed. Also, text nodes are |
|
91 * difficult, at best, to construct until one knows that all text content |
|
92 * has been received(which a call to this function in a natural way |
|
93 * signals). |
|
94 */ |
|
95 virtual QAbstractXmlNodeModel::Ptr builtDocument() = 0; |
|
96 |
|
97 /** |
|
98 * @short Creates a copy of this NodeBuilder, that operates independently of |
|
99 * this NodeBuilder. |
|
100 * |
|
101 * The caller owns the returned instance. |
|
102 */ |
|
103 virtual NodeBuilder::Ptr create(const QUrl &baseURI) const = 0; |
|
104 }; |
|
105 } |
|
106 |
|
107 QT_END_NAMESPACE |
|
108 |
|
109 QT_END_HEADER |
|
110 |
|
111 #endif |