aboutsummaryrefslogtreecommitdiff
path: root/libcontextsubscriber/doc/html/infoxmlbackend_8h_source.html
diff options
context:
space:
mode:
Diffstat (limited to 'libcontextsubscriber/doc/html/infoxmlbackend_8h_source.html')
-rw-r--r--libcontextsubscriber/doc/html/infoxmlbackend_8h_source.html100
1 files changed, 100 insertions, 0 deletions
diff --git a/libcontextsubscriber/doc/html/infoxmlbackend_8h_source.html b/libcontextsubscriber/doc/html/infoxmlbackend_8h_source.html
new file mode 100644
index 00000000..30f577f9
--- /dev/null
+++ b/libcontextsubscriber/doc/html/infoxmlbackend_8h_source.html
@@ -0,0 +1,100 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<title>libcontextsubscriber: infoxmlbackend.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.6.1 -->
+<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>infoxmlbackend.h</h1><a href="infoxmlbackend_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) 2008 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 INFOXMLBACKEND_H</span>
+<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define INFOXMLBACKEND_H</span>
+<a name="l00024"></a>00024 <span class="preprocessor"></span>
+<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;QStringList&gt;</span>
+<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;QObject&gt;</span>
+<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;QFileInfo&gt;</span>
+<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;QString&gt;</span>
+<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;QHash&gt;</span>
+<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;QFileSystemWatcher&gt;</span>
+<a name="l00031"></a>00031 <span class="preprocessor">#include &quot;<a class="code" href="infobackend_8h.html">infobackend.h</a>&quot;</span>
+<a name="l00032"></a>00032 <span class="preprocessor">#include &quot;<a class="code" href="infokeydata_8h.html">infokeydata.h</a>&quot;</span>
+<a name="l00033"></a>00033 <span class="preprocessor">#include &quot;<a class="code" href="contextproviderinfo_8h.html">contextproviderinfo.h</a>&quot;</span>
+<a name="l00034"></a>00034 <span class="preprocessor">#include &quot;<a class="code" href="assoctree_8h.html">assoctree.h</a>&quot;</span>
+<a name="l00035"></a>00035
+<a name="l00036"></a><a class="code" href="class_info_xml_backend.html">00036</a> <span class="keyword">class </span><a class="code" href="class_info_xml_backend.html" title="Implements the InfoBackend for reading data from a directory with xml files.">InfoXmlBackend</a> : <span class="keyword">public</span> <a class="code" href="class_info_backend.html" title="An abstract (pure virtual) singleton class that represents the actual registry backend...">InfoBackend</a>
+<a name="l00037"></a>00037 {
+<a name="l00038"></a>00038 Q_OBJECT
+<a name="l00039"></a>00039
+<a name="l00040"></a>00040 <span class="keyword">public</span>:
+<a name="l00041"></a>00041 <span class="keyword">explicit</span> <a class="code" href="class_info_xml_backend.html#a85f5bb72b4841d7012ff63bd7627f2d0">InfoXmlBackend</a>(QObject *parent = 0);
+<a name="l00042"></a>00042
+<a name="l00043"></a>00043 <span class="keyword">virtual</span> QString <a class="code" href="class_info_xml_backend.html#a83ac8d65786de855c402b426222ab72b" title="Returns &amp;#39;xml&amp;#39;.">name</a>() <span class="keyword">const</span>;
+<a name="l00044"></a>00044 <span class="keyword">virtual</span> QStringList <a class="code" href="class_info_xml_backend.html#a74d2b52119a26ca60203ecf86721e38c" title="Returns the list of all the keys in the registry.">listKeys</a>() <span class="keyword">const</span>;
+<a name="l00045"></a>00045 <span class="keyword">virtual</span> QString <a class="code" href="class_info_xml_backend.html#a3b0753cd69c99c2fe188e7fd912a072a" title="Returns the documentation for the given key name.">docForKey</a>(QString key) <span class="keyword">const</span>;
+<a name="l00046"></a>00046 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_info_xml_backend.html#a34f0f40564466e150f433aced83af71a" title="Returns true if the given key exists.">keyDeclared</a>(QString key) <span class="keyword">const</span>;
+<a name="l00047"></a>00047 <span class="keyword">virtual</span> <span class="keyword">const</span> QList&lt;ContextProviderInfo&gt; <a class="code" href="class_info_xml_backend.html#af72852cc9ec862658d2be1d59be536c0" title="Returns a list of providers for the given key.">providersForKey</a>(QString key) <span class="keyword">const</span>;
+<a name="l00048"></a>00048 <span class="keyword">virtual</span> <a class="code" href="class_context_type_info.html">ContextTypeInfo</a> <a class="code" href="class_info_xml_backend.html#ae2ffd838ca91a653ea2f18cfa35c8799" title="Returns the type information for the given key.">typeInfoForKey</a>(QString key) <span class="keyword">const</span>;
+<a name="l00049"></a>00049
+<a name="l00050"></a>00050 <span class="keyword">static</span> QString <a class="code" href="class_info_xml_backend.html#aeba0f378c01b6740c53ea977c10947b0" title="Returns the full path to the registry directory.">registryPath</a>();
+<a name="l00051"></a>00051 <span class="keyword">static</span> QString <a class="code" href="class_info_xml_backend.html#ae919a19ac7fc38f60048b900d49c41d5" title="Returns the full path to the core property declaration file.">coreDeclPath</a>();
+<a name="l00052"></a>00052
+<a name="l00053"></a>00053 <span class="keyword">private</span> slots:
+<a name="l00054"></a>00054 <span class="keywordtype">void</span> <a class="code" href="class_info_xml_backend.html#aedf432bc14783ab4e9f2858a088e0643" title="Called when the registry directory changed (ie.">onDirectoryChanged</a>(<span class="keyword">const</span> QString &amp;path);
+<a name="l00055"></a>00055 <span class="keywordtype">void</span> <a class="code" href="class_info_xml_backend.html#ab2155f5c965bc1249987f6ae942d004b" title="Called when one of the parsed XML files changed.">onFileChanged</a>(<span class="keyword">const</span> QString &amp;path);
+<a name="l00056"></a>00056
+<a name="l00057"></a>00057 <span class="keyword">private</span>:
+<a name="l00058"></a><a class="code" href="class_info_xml_backend.html#a6ed00727580f66f06f33ecdb2a7581e7">00058</a> QFileSystemWatcher <a class="code" href="class_info_xml_backend.html#a6ed00727580f66f06f33ecdb2a7581e7" title="A watched object obsering the database file. Delivers synced notifications.">watcher</a>;
+<a name="l00059"></a><a class="code" href="class_info_xml_backend.html#a60f512bdb81310502e5d80c2b738d513">00059</a> QHash &lt;QString, InfoKeyData&gt; <a class="code" href="class_info_xml_backend.html#a60f512bdb81310502e5d80c2b738d513" title="This hash contains the full state of registry in memory.">keyDataHash</a>;
+<a name="l00060"></a><a class="code" href="class_info_xml_backend.html#a6bc7baa201268651c5203c8ddf9f1eef">00060</a> QHash &lt;QString, QList&lt;ContextProviderInfo&gt; &gt; <a class="code" href="class_info_xml_backend.html#a6bc7baa201268651c5203c8ddf9f1eef" title="This hash contains providers for keys.">keyProvidersHash</a>;
+<a name="l00061"></a><a class="code" href="class_info_xml_backend.html#ac61fad8518de174500caaaa278bf1672">00061</a> <span class="keywordtype">int</span> <a class="code" href="class_info_xml_backend.html#ac61fad8518de174500caaaa278bf1672" title="The number of xml files we parsed in last registry update.">countOfFilesInLastParse</a>;
+<a name="l00062"></a>00062
+<a name="l00063"></a>00063 <span class="keywordtype">void</span> <a class="code" href="class_info_xml_backend.html#a1407eccac5cb06f88fc6014d4ee25f48" title="Clears all the stored data about the registry and parses it all over again.">regenerateKeyDataList</a>();
+<a name="l00064"></a>00064 <span class="keywordtype">void</span> <a class="code" href="class_info_xml_backend.html#ab5d85a566993462042838c786700f7f8" title="Parses a given path file and adds it&amp;#39;s contents to the hash.">readKeyDataFromXml</a>(<span class="keyword">const</span> QString &amp;path);
+<a name="l00065"></a>00065 <span class="keywordtype">void</span> <a class="code" href="class_info_xml_backend.html#a59c6595edec886fd70a451102196ea5c" title="Parse the given QVariant tree which is supposed to be a key tree.">parseKey</a>(<span class="keyword">const</span> <a class="code" href="class_assoc_tree.html">AssocTree</a> &amp;keyTree, <span class="keyword">const</span> <a class="code" href="class_assoc_tree.html">AssocTree</a> &amp;providerTree);
+<a name="l00066"></a>00066 };
+<a name="l00067"></a>00067
+<a name="l00068"></a>00068 <span class="preprocessor">#endif // INFOXMLBACKEND_H</span>
+</pre></div></div>
+<hr size="1"/><address style="text-align: right;"><small>Generated on Fri Nov 27 10:23:11 2009 for libcontextsubscriber by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
+</body>
+</html>