aboutsummaryrefslogtreecommitdiff
path: root/libcontextsubscriber/doc/html/nanoxml_8h-source.html
blob: 0065d547b7e9df8a310ea1fc29335c21f9b9dbba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libcontextsubscriber: nanoxml.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
    </ul>
  </div>
<h1>nanoxml.h</h1><a href="nanoxml_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright (C) 2009 Nokia Corporation.</span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * Contact: Marius Vollmer &lt;marius.vollmer@nokia.com&gt;</span>
<a name="l00005"></a>00005 <span class="comment"> *</span>
<a name="l00006"></a>00006 <span class="comment"> * This library is free software; you can redistribute it and/or</span>
<a name="l00007"></a>00007 <span class="comment"> * modify it under the terms of the GNU Lesser General Public License</span>
<a name="l00008"></a>00008 <span class="comment"> * version 2.1 as published by the Free Software Foundation.</span>
<a name="l00009"></a>00009 <span class="comment"> *</span>
<a name="l00010"></a>00010 <span class="comment"> * This library is distributed in the hope that it will be useful, but</span>
<a name="l00011"></a>00011 <span class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00012"></a>00012 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span>
<a name="l00013"></a>00013 <span class="comment"> * Lesser General Public License for more details.</span>
<a name="l00014"></a>00014 <span class="comment"> *</span>
<a name="l00015"></a>00015 <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span>
<a name="l00016"></a>00016 <span class="comment"> * License along with this library; if not, write to the Free Software</span>
<a name="l00017"></a>00017 <span class="comment"> * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA</span>
<a name="l00018"></a>00018 <span class="comment"> * 02110-1301 USA</span>
<a name="l00019"></a>00019 <span class="comment"> *</span>
<a name="l00020"></a>00020 <span class="comment"> */</span>
<a name="l00021"></a>00021 
<a name="l00022"></a>00022 <span class="preprocessor">#ifndef NANOXML_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define NANOXML_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;QVariant&gt;</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;QStringList&gt;</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;QObject&gt;</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;QXmlDefaultHandler&gt;</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;QStack&gt;</span>
<a name="l00030"></a>00030 
<a name="l00031"></a><a class="code" href="class_nano_xml.html">00031</a> <span class="keyword">class </span><a class="code" href="class_nano_xml.html" title="Parses XML files into a nano dom.">NanoXml</a> : <span class="keyword">public</span> QObject, QXmlDefaultHandler
<a name="l00032"></a>00032 {
<a name="l00033"></a>00033     Q_OBJECT
<a name="l00034"></a>00034 
<a name="l00035"></a>00035 <span class="keyword">public</span>:
<a name="l00036"></a>00036     <a class="code" href="class_nano_xml.html#6bba582991cf13e4af332ae999f650e0" title="Constructor.">NanoXml</a>(<span class="keyword">const</span> QString&amp; path);
<a name="l00037"></a>00037     <a class="code" href="class_nano_xml.html#940fbfce7d0fab29a5ba6b5b840c4d71" title="Destructor.">~NanoXml</a>();
<a name="l00038"></a>00038     <span class="keyword">const</span> QVariant&amp; <a class="code" href="class_nano_xml.html#34bebe2d3d74159d94c4d4b3abd6480f" title="Returns the root of the nanodom tree.">root</a>();
<a name="l00039"></a>00039     <span class="keyword">const</span> QString <a class="code" href="class_nano_xml.html#ae6e7c0a8785f75cb06abb27c348833b" title="Returns the namespace URI of the parsed (source) XML document.">namespaceUri</a>();
<a name="l00040"></a>00040     <span class="keywordtype">bool</span> <a class="code" href="class_nano_xml.html#b5729afbebfb708cab217298891fe31b" title="Returns true if parsing failed.">didFail</a>();
<a name="l00041"></a>00041 
<a name="l00042"></a>00042     QVariant <a class="code" href="class_nano_xml.html#fb90496573500eaa24180d37c180dcee" title="Returns the sub (the trailing) after a given key in the root nanodom tree.">keySub</a>(<span class="keyword">const</span> QString &amp;key);
<a name="l00043"></a>00043     QVariant <a class="code" href="class_nano_xml.html#064d4d3a52e05535a18305a4612c0450" title="1st level accessor. Returns a value for a key in the root nanodom tree.">keyValue</a>(<span class="keyword">const</span> QString &amp;key);
<a name="l00044"></a>00044     QVariant <a class="code" href="class_nano_xml.html#064d4d3a52e05535a18305a4612c0450" title="1st level accessor. Returns a value for a key in the root nanodom tree.">keyValue</a>(<span class="keyword">const</span> QString &amp;key1, <span class="keyword">const</span> QString &amp;key2);
<a name="l00045"></a>00045     QVariant <a class="code" href="class_nano_xml.html#064d4d3a52e05535a18305a4612c0450" title="1st level accessor. Returns a value for a key in the root nanodom tree.">keyValue</a>(<span class="keyword">const</span> QString &amp;key1, <span class="keyword">const</span> QString &amp;key2, <span class="keyword">const</span> QString &amp;key3);
<a name="l00046"></a>00046     QVariant <a class="code" href="class_nano_xml.html#064d4d3a52e05535a18305a4612c0450" title="1st level accessor. Returns a value for a key in the root nanodom tree.">keyValue</a>(<span class="keyword">const</span> QString &amp;key1, <span class="keyword">const</span> QString &amp;key2, <span class="keyword">const</span> QString &amp;key3,
<a name="l00047"></a>00047                       <span class="keyword">const</span> QString &amp;key4);
<a name="l00048"></a>00048     QVariant <a class="code" href="class_nano_xml.html#064d4d3a52e05535a18305a4612c0450" title="1st level accessor. Returns a value for a key in the root nanodom tree.">keyValue</a>(<span class="keyword">const</span> QString &amp;key1, <span class="keyword">const</span> QString &amp;key2, <span class="keyword">const</span> QString &amp;key3,
<a name="l00049"></a>00049                       <span class="keyword">const</span> QString &amp;key4, <span class="keyword">const</span> QString &amp;key5);
<a name="l00050"></a>00050     QVariantList <a class="code" href="class_nano_xml.html#ba42a9094fb57418e62b21d134095a8f" title="Returns the list of QVariants matching the key in the root tree.">keyValues</a>(<span class="keyword">const</span> QString &amp;key);
<a name="l00051"></a>00051 
<a name="l00052"></a>00052     <span class="keyword">static</span> QVariant <a class="code" href="class_nano_xml.html#fb90496573500eaa24180d37c180dcee" title="Returns the sub (the trailing) after a given key in the root nanodom tree.">keySub</a>(<span class="keyword">const</span> QString &amp;key, <span class="keyword">const</span> QVariant &amp;dom);
<a name="l00053"></a>00053     <span class="keyword">static</span> QVariant <a class="code" href="class_nano_xml.html#064d4d3a52e05535a18305a4612c0450" title="1st level accessor. Returns a value for a key in the root nanodom tree.">keyValue</a>(<span class="keyword">const</span> QString &amp;key, <span class="keyword">const</span> QVariant &amp;dom);
<a name="l00054"></a>00054     <span class="keyword">static</span> QVariant <a class="code" href="class_nano_xml.html#064d4d3a52e05535a18305a4612c0450" title="1st level accessor. Returns a value for a key in the root nanodom tree.">keyValue</a>(<span class="keyword">const</span> QString &amp;key1, <span class="keyword">const</span> QString &amp;key2, <span class="keyword">const</span> QVariant &amp;dom);
<a name="l00055"></a>00055     <span class="keyword">static</span> QVariant <a class="code" href="class_nano_xml.html#064d4d3a52e05535a18305a4612c0450" title="1st level accessor. Returns a value for a key in the root nanodom tree.">keyValue</a>(<span class="keyword">const</span> QString &amp;key1, <span class="keyword">const</span> QString &amp;key2, <span class="keyword">const</span> QString &amp;key3,
<a name="l00056"></a>00056                              <span class="keyword">const</span> QVariant &amp;dom);
<a name="l00057"></a>00057     <span class="keyword">static</span> QVariant <a class="code" href="class_nano_xml.html#064d4d3a52e05535a18305a4612c0450" title="1st level accessor. Returns a value for a key in the root nanodom tree.">keyValue</a>(<span class="keyword">const</span> QString &amp;key1, <span class="keyword">const</span> QString &amp;key2, <span class="keyword">const</span> QString &amp;key3,
<a name="l00058"></a>00058                                    <span class="keyword">const</span> QString &amp;key4, <span class="keyword">const</span> QVariant &amp;dom);
<a name="l00059"></a>00059     <span class="keyword">static</span> QVariant <a class="code" href="class_nano_xml.html#064d4d3a52e05535a18305a4612c0450" title="1st level accessor. Returns a value for a key in the root nanodom tree.">keyValue</a>(<span class="keyword">const</span> QString &amp;key1, <span class="keyword">const</span> QString &amp;key2, <span class="keyword">const</span> QString &amp;key3,
<a name="l00060"></a>00060                              <span class="keyword">const</span> QString &amp;key4, <span class="keyword">const</span> QString &amp;key5, <span class="keyword">const</span> QVariant &amp;dom);
<a name="l00061"></a>00061     <span class="keyword">static</span> QVariantList <a class="code" href="class_nano_xml.html#ba42a9094fb57418e62b21d134095a8f" title="Returns the list of QVariants matching the key in the root tree.">keyValues</a>(<span class="keyword">const</span> QString &amp;key, <span class="keyword">const</span> QVariant &amp;dom);
<a name="l00062"></a>00062 
<a name="l00063"></a>00063     <span class="keyword">static</span> QString <a class="code" href="class_nano_xml.html#4966386ef78c065e9fad50a6382770b0" title="Dumps a QVariant into a multi-line string for debugging purposes.">dumpTree</a>(<span class="keyword">const</span> QVariant &amp;tree, <span class="keywordtype">int</span> level);
<a name="l00064"></a>00064 
<a name="l00065"></a>00065 <span class="keyword">private</span>:
<a name="l00066"></a><a class="code" href="class_nano_xml.html#bfef8deeba2c746ee63ae4f1e64f7551">00066</a>     QList&lt;QVariant&gt; *<a class="code" href="class_nano_xml.html#bfef8deeba2c746ee63ae4f1e64f7551" title="The current list that we&amp;#39;re adding to. Top of the stack, kinda.">current</a>; 
<a name="l00067"></a><a class="code" href="class_nano_xml.html#fec8c67035475122807dfacfcd0c3563">00067</a>     QStack&lt;QList &lt;QVariant&gt;* &gt; <a class="code" href="class_nano_xml.html#fec8c67035475122807dfacfcd0c3563" title="The stack of lists.">stack</a>; 
<a name="l00068"></a><a class="code" href="class_nano_xml.html#2e0c55cb00dfdfcb09191b685c9c7624">00068</a>     QVariant <a class="code" href="class_nano_xml.html#2e0c55cb00dfdfcb09191b685c9c7624" title="The nanodom root. A list of QVariants usually.">rootVariant</a>; 
<a name="l00069"></a><a class="code" href="class_nano_xml.html#4d517f665a6ffe310ba89b94f5252295">00069</a>     <span class="keywordtype">bool</span> <a class="code" href="class_nano_xml.html#4d517f665a6ffe310ba89b94f5252295" title="This is set by the parser to signify an error.">failed</a>; 
<a name="l00070"></a><a class="code" href="class_nano_xml.html#80322fd3991316e0c5d9e42dbc024a21">00070</a>     QString <a class="code" href="class_nano_xml.html#80322fd3991316e0c5d9e42dbc024a21" title="Stores the namespace uri.">nspace</a>; 
<a name="l00071"></a>00071 
<a name="l00072"></a>00072     <span class="keywordtype">void</span> <a class="code" href="class_nano_xml.html#750f872971e1b36ecffc4ead3250e17d" title="Parser internal. Creates a new list and pushes it to the top of the stack.">pushList</a>();
<a name="l00073"></a>00073     <span class="keywordtype">void</span> <a class="code" href="class_nano_xml.html#0820f7cc298465a54350f998af40d929" title="Parser internal. Add a value (item) v to the current list on the stack.">addValue</a>(<span class="keyword">const</span> QString&amp; v);
<a name="l00074"></a>00074     <span class="keywordtype">void</span> <a class="code" href="class_nano_xml.html#db05786203f23b7a96ee1db103582729" title="Parser internal.">popList</a>();
<a name="l00075"></a>00075 
<a name="l00076"></a>00076 <span class="keyword">public</span>:
<a name="l00077"></a>00077     <span class="keywordtype">bool</span> <a class="code" href="class_nano_xml.html#9a53418260e9b9ae8bc3da9b0fae2b35" title="Called by the XML parser when parsing starts.">startElement</a>(<span class="keyword">const</span> QString&amp;, <span class="keyword">const</span> QString&amp;, <span class="keyword">const</span> QString &amp;name, <span class="keyword">const</span> QXmlAttributes &amp;attrs);
<a name="l00078"></a>00078     <span class="keywordtype">bool</span> <a class="code" href="class_nano_xml.html#e2884ebc5e4c6e60c2419ab47fb05d37" title="Called by the XML parser when parsing starts.">endElement</a>(<span class="keyword">const</span> QString&amp;, <span class="keyword">const</span> QString&amp;, <span class="keyword">const</span> QString &amp;name);
<a name="l00079"></a>00079     <span class="keywordtype">bool</span> <a class="code" href="class_nano_xml.html#bb825f9876e40c023c0b3b1ab0b09828" title="Called when a namespace prefix mapping starts.">startPrefixMapping</a>(<span class="keyword">const</span> QString &amp;prefix, <span class="keyword">const</span> QString &amp;uri);
<a name="l00080"></a>00080     <span class="keywordtype">bool</span> <a class="code" href="class_nano_xml.html#d051fdc20099f73a6595cb229e5c5854" title="Called by the XML parser when parsing starts.">characters</a>(<span class="keyword">const</span> QString &amp;chars);
<a name="l00081"></a>00081 };
<a name="l00082"></a>00082 
<a name="l00083"></a>00083 <span class="preprocessor">#endif // NANOXML_H</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Oct 23 08:59:23 2009 for libcontextsubscriber by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>