diff options
Diffstat (limited to 'libcontextsubscriber/doc/html/class_info_xml_keys_finder.html')
| -rw-r--r-- | libcontextsubscriber/doc/html/class_info_xml_keys_finder.html | 465 |
1 files changed, 465 insertions, 0 deletions
diff --git a/libcontextsubscriber/doc/html/class_info_xml_keys_finder.html b/libcontextsubscriber/doc/html/class_info_xml_keys_finder.html new file mode 100644 index 00000000..42b94c24 --- /dev/null +++ b/libcontextsubscriber/doc/html/class_info_xml_keys_finder.html @@ -0,0 +1,465 @@ +<!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: InfoXmlKeysFinder Class Reference</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 Page</span></a></li> + <li><a href="pages.html"><span>Related Pages</span></a></li> + <li><a href="namespaces.html"><span>Namespaces</span></a></li> + <li class="current"><a href="annotated.html"><span>Classes</span></a></li> + <li><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="annotated.html"><span>Class List</span></a></li> + <li><a href="classes.html"><span>Class Index</span></a></li> + <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> + <li><a href="functions.html"><span>Class Members</span></a></li> + </ul> + </div> +</div> +<div class="contents"> +<h1>InfoXmlKeysFinder Class Reference</h1><!-- doxytag: class="InfoXmlKeysFinder" -->Implements a SAX parser to parse xml files with provider/key data. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="infoxmlkeysfinder_8h-source.html">infoxmlkeysfinder.h</a>></code> +<p> + +<p> +<a href="class_info_xml_keys_finder-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_xml_keys_finder.html#35c50b557e9f74021ffa1ea5b7350d38">startDocument</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called when parsing starts. <a href="#35c50b557e9f74021ffa1ea5b7350d38"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_xml_keys_finder.html#d906f74a27d94e35e06ebd968e68fceb">startElement</a> (const QString &, const QString &, const QString &name, const QXmlAttributes &attrs)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called for each <element> when we start parsing it. <a href="#d906f74a27d94e35e06ebd968e68fceb"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_xml_keys_finder.html#b39257db6f5769f63a465c051591a122">endElement</a> (const QString &, const QString &, const QString &name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called for each </element> when we stop parsing it. <a href="#b39257db6f5769f63a465c051591a122"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_xml_keys_finder.html#1993a736923cbba62ddf2edac629f009">characters</a> (const QString &ch)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called for each bit of textual data. We trim spaces here. <a href="#1993a736923cbba62ddf2edac629f009"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">QHash< QString, <a class="el" href="struct_info_key_data.html">InfoKeyData</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_xml_keys_finder.html#d19e4bb015ae0883147d659e03509145">keyDataHash</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">A hash containing keyname -> <a class="el" href="struct_info_key_data.html" title="Simple storage class that groups info about a given key.">InfoKeyData</a> mapping. This is parse output. <a href="#d19e4bb015ae0883147d659e03509145"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Private Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_xml_keys_finder.html#4ff23bab883a5d48b621c5b806e2d4f3">getAttrValue</a> (const QXmlAttributes &attrs, const QString &attrName)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">In the given <em>attrs</em> atribute list, find the one with <em>attrName</em> and return it's value. <a href="#4ff23bab883a5d48b621c5b806e2d4f3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_xml_keys_finder.html#fc43589dc22f5c60467f37db0d361200">canonicalizeType</a> (const QString &type)</td></tr> + +<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_xml_keys_finder.html#03ba7b170ed64cc7ba9b81d84b870aa2">inProvider</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Are we in the <provider>... <a href="#03ba7b170ed64cc7ba9b81d84b870aa2"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_xml_keys_finder.html#3570cbf10985654fdeb7f692d2fe20a2">inKey</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Are we in the <key>... <a href="#3570cbf10985654fdeb7f692d2fe20a2"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_xml_keys_finder.html#6660fb6f12489e739154df9976aa6c69">inKeyType</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Are we in the <key><type>... <a href="#6660fb6f12489e739154df9976aa6c69"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_xml_keys_finder.html#98ea99f78671be0c78132ff23ffe9126">complexKeyType</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Are we in a sub-element of <type>... <a href="#98ea99f78671be0c78132ff23ffe9126"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_xml_keys_finder.html#18059f98a714e7a62def98dfb770bc71">inKeyDoc</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Are we in the <key><doc>... <a href="#18059f98a714e7a62def98dfb770bc71"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_xml_keys_finder.html#3fdc07f367a5272707c7e421bdaf3277">currentPlugin</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">For our current parse position, the <provider plugin="?">. <a href="#3fdc07f367a5272707c7e421bdaf3277"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_xml_keys_finder.html#e693452ee04be8ac9a2ec42029e34183">currentConstructionString</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">For our current parse position, the <provider constructionstring="?">. <a href="#e693452ee04be8ac9a2ec42029e34183"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_xml_keys_finder.html#8bcd4405970b22da3e73e6b9a71aafab">currentKeyName</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">For our current parse position, the <key>? name. <a href="#8bcd4405970b22da3e73e6b9a71aafab"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_xml_keys_finder.html#99b2a4330f956fca42ddd4af328739f3">currentKeyType</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">For our current parse position, the <key><type>? type. <a href="#99b2a4330f956fca42ddd4af328739f3"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_xml_keys_finder.html#9a28e465572d3f95378037719c756787">currentKeyDoc</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">For our current parse position, the <key><doc>? documentation. <a href="#9a28e465572d3f95378037719c756787"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Implements a SAX parser to parse xml files with provider/key data. +<p> +This class is not exported in the public API. Traditional old-school context-based parsing logic here. <hr><h2>Member Function Documentation</h2> +<a class="anchor" name="fc43589dc22f5c60467f37db0d361200"></a><!-- doxytag: member="InfoXmlKeysFinder::canonicalizeType" ref="fc43589dc22f5c60467f37db0d361200" args="(const QString &type)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString InfoXmlKeysFinder::canonicalizeType </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>type</em> </td> + <td> ) </td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="1993a736923cbba62ddf2edac629f009"></a><!-- doxytag: member="InfoXmlKeysFinder::characters" ref="1993a736923cbba62ddf2edac629f009" args="(const QString &ch)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool InfoXmlKeysFinder::characters </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>ch</em> </td> + <td> ) </td> + <td><code> [virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Called for each bit of textual data. We trim spaces here. +<p> + +</div> +</div><p> +<a class="anchor" name="b39257db6f5769f63a465c051591a122"></a><!-- doxytag: member="InfoXmlKeysFinder::endElement" ref="b39257db6f5769f63a465c051591a122" args="(const QString &, const QString &, const QString &name)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool InfoXmlKeysFinder::endElement </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname">, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QString & </td> + <td class="paramname">, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>name</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Called for each </element> when we stop parsing it. +<p> + +</div> +</div><p> +<a class="anchor" name="4ff23bab883a5d48b621c5b806e2d4f3"></a><!-- doxytag: member="InfoXmlKeysFinder::getAttrValue" ref="4ff23bab883a5d48b621c5b806e2d4f3" args="(const QXmlAttributes &attrs, const QString &attrName)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString InfoXmlKeysFinder::getAttrValue </td> + <td>(</td> + <td class="paramtype">const QXmlAttributes & </td> + <td class="paramname"> <em>attrs</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>attrName</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +In the given <em>attrs</em> atribute list, find the one with <em>attrName</em> and return it's value. +<p> +Returns empty string if attribute not found. +</div> +</div><p> +<a class="anchor" name="35c50b557e9f74021ffa1ea5b7350d38"></a><!-- doxytag: member="InfoXmlKeysFinder::startDocument" ref="35c50b557e9f74021ffa1ea5b7350d38" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool InfoXmlKeysFinder::startDocument </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Called when parsing starts. +<p> + +</div> +</div><p> +<a class="anchor" name="d906f74a27d94e35e06ebd968e68fceb"></a><!-- doxytag: member="InfoXmlKeysFinder::startElement" ref="d906f74a27d94e35e06ebd968e68fceb" args="(const QString &, const QString &, const QString &name, const QXmlAttributes &attrs)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool InfoXmlKeysFinder::startElement </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname">, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QString & </td> + <td class="paramname">, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>name</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QXmlAttributes & </td> + <td class="paramname"> <em>attrs</em></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Called for each <element> when we start parsing it. +<p> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="98ea99f78671be0c78132ff23ffe9126"></a><!-- doxytag: member="InfoXmlKeysFinder::complexKeyType" ref="98ea99f78671be0c78132ff23ffe9126" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool <a class="el" href="class_info_xml_keys_finder.html#98ea99f78671be0c78132ff23ffe9126">InfoXmlKeysFinder::complexKeyType</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Are we in a sub-element of <type>... +<p> + +</div> +</div><p> +<a class="anchor" name="e693452ee04be8ac9a2ec42029e34183"></a><!-- doxytag: member="InfoXmlKeysFinder::currentConstructionString" ref="e693452ee04be8ac9a2ec42029e34183" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString <a class="el" href="class_info_xml_keys_finder.html#e693452ee04be8ac9a2ec42029e34183">InfoXmlKeysFinder::currentConstructionString</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +For our current parse position, the <provider constructionstring="?">. +<p> + +</div> +</div><p> +<a class="anchor" name="9a28e465572d3f95378037719c756787"></a><!-- doxytag: member="InfoXmlKeysFinder::currentKeyDoc" ref="9a28e465572d3f95378037719c756787" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString <a class="el" href="class_info_xml_keys_finder.html#9a28e465572d3f95378037719c756787">InfoXmlKeysFinder::currentKeyDoc</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +For our current parse position, the <key><doc>? documentation. +<p> + +</div> +</div><p> +<a class="anchor" name="8bcd4405970b22da3e73e6b9a71aafab"></a><!-- doxytag: member="InfoXmlKeysFinder::currentKeyName" ref="8bcd4405970b22da3e73e6b9a71aafab" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString <a class="el" href="class_info_xml_keys_finder.html#8bcd4405970b22da3e73e6b9a71aafab">InfoXmlKeysFinder::currentKeyName</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +For our current parse position, the <key>? name. +<p> + +</div> +</div><p> +<a class="anchor" name="99b2a4330f956fca42ddd4af328739f3"></a><!-- doxytag: member="InfoXmlKeysFinder::currentKeyType" ref="99b2a4330f956fca42ddd4af328739f3" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString <a class="el" href="class_info_xml_keys_finder.html#99b2a4330f956fca42ddd4af328739f3">InfoXmlKeysFinder::currentKeyType</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +For our current parse position, the <key><type>? type. +<p> + +</div> +</div><p> +<a class="anchor" name="3fdc07f367a5272707c7e421bdaf3277"></a><!-- doxytag: member="InfoXmlKeysFinder::currentPlugin" ref="3fdc07f367a5272707c7e421bdaf3277" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString <a class="el" href="class_info_xml_keys_finder.html#3fdc07f367a5272707c7e421bdaf3277">InfoXmlKeysFinder::currentPlugin</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +For our current parse position, the <provider plugin="?">. +<p> + +</div> +</div><p> +<a class="anchor" name="3570cbf10985654fdeb7f692d2fe20a2"></a><!-- doxytag: member="InfoXmlKeysFinder::inKey" ref="3570cbf10985654fdeb7f692d2fe20a2" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool <a class="el" href="class_info_xml_keys_finder.html#3570cbf10985654fdeb7f692d2fe20a2">InfoXmlKeysFinder::inKey</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Are we in the <key>... +<p> + +</div> +</div><p> +<a class="anchor" name="18059f98a714e7a62def98dfb770bc71"></a><!-- doxytag: member="InfoXmlKeysFinder::inKeyDoc" ref="18059f98a714e7a62def98dfb770bc71" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool <a class="el" href="class_info_xml_keys_finder.html#18059f98a714e7a62def98dfb770bc71">InfoXmlKeysFinder::inKeyDoc</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Are we in the <key><doc>... +<p> + +</div> +</div><p> +<a class="anchor" name="6660fb6f12489e739154df9976aa6c69"></a><!-- doxytag: member="InfoXmlKeysFinder::inKeyType" ref="6660fb6f12489e739154df9976aa6c69" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool <a class="el" href="class_info_xml_keys_finder.html#6660fb6f12489e739154df9976aa6c69">InfoXmlKeysFinder::inKeyType</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Are we in the <key><type>... +<p> + +</div> +</div><p> +<a class="anchor" name="03ba7b170ed64cc7ba9b81d84b870aa2"></a><!-- doxytag: member="InfoXmlKeysFinder::inProvider" ref="03ba7b170ed64cc7ba9b81d84b870aa2" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool <a class="el" href="class_info_xml_keys_finder.html#03ba7b170ed64cc7ba9b81d84b870aa2">InfoXmlKeysFinder::inProvider</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Are we in the <provider>... +<p> + +</div> +</div><p> +<a class="anchor" name="d19e4bb015ae0883147d659e03509145"></a><!-- doxytag: member="InfoXmlKeysFinder::keyDataHash" ref="d19e4bb015ae0883147d659e03509145" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QHash<QString, <a class="el" href="struct_info_key_data.html">InfoKeyData</a>> <a class="el" href="class_info_xml_keys_finder.html#d19e4bb015ae0883147d659e03509145">InfoXmlKeysFinder::keyDataHash</a> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +A hash containing keyname -> <a class="el" href="struct_info_key_data.html" title="Simple storage class that groups info about a given key.">InfoKeyData</a> mapping. This is parse output. +<p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="infoxmlkeysfinder_8h-source.html">infoxmlkeysfinder.h</a><li><a class="el" href="infoxmlkeysfinder_8cpp.html">infoxmlkeysfinder.cpp</a></ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Sep 30 10:24:18 2009 for libcontextsubscriber by +<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> |