aboutsummaryrefslogtreecommitdiff
path: root/libcontextsubscriber/doc/html/infocdbbackend_8h-source.html
blob: eb29a07cee4fcce71f5d824b216dc3e2b1ecfc77 (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
<!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: infocdbbackend.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>infocdbbackend.h</h1><a href="infocdbbackend_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 INFOCDBBACKEND_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define INFOCDBBACKEND_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;QString&gt;</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;QFileSystemWatcher&gt;</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="cdbreader_8h.html">cdbreader.h</a>"</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="infobackend_8h.html">infobackend.h</a>"</span>
<a name="l00031"></a>00031 
<a name="l00032"></a><a class="code" href="class_info_cdb_backend.html">00032</a> <span class="keyword">class </span><a class="code" href="class_info_cdb_backend.html" title="Implements the InfoBackend for reading data from a cdb database.">InfoCdbBackend</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="l00033"></a>00033 {
<a name="l00034"></a>00034     Q_OBJECT
<a name="l00035"></a>00035 
<a name="l00036"></a>00036 <span class="keyword">public</span>:
<a name="l00037"></a>00037     <span class="keyword">explicit</span> <a class="code" href="class_info_cdb_backend.html#8e31c8ded7f1620ab626d17f23bf3042">InfoCdbBackend</a>(QObject *parent = 0);
<a name="l00038"></a>00038 
<a name="l00039"></a>00039     <span class="keyword">virtual</span> QString <a class="code" href="class_info_cdb_backend.html#98707e9504d1719000fec1d31de01174" title="Returns &amp;#39;cdb&amp;#39;.">name</a>() <span class="keyword">const</span>;
<a name="l00040"></a>00040     <span class="keyword">virtual</span> QStringList <a class="code" href="class_info_cdb_backend.html#16a29a2335e21a73b8317d23eadb3069" title="Returns the list of all the keys in the registry.">listKeys</a>() <span class="keyword">const</span>;
<a name="l00041"></a>00041     <span class="keyword">virtual</span> QStringList <a class="code" href="class_info_cdb_backend.html#883490a5fe0d8cdcad199a5ceaaf0d63" title="Returns the list of all the keys in the registry provided by the given plugin.">listKeysForPlugin</a>(QString plugin) <span class="keyword">const</span>;
<a name="l00042"></a>00042     <span class="keyword">virtual</span> QStringList <a class="code" href="class_info_cdb_backend.html#61d7ea28dc908c0ebb24e4bcacc469ab" title="Returns a list of all the unique plugins in the database.">listPlugins</a>() <span class="keyword">const</span>;
<a name="l00043"></a>00043     <span class="keyword">virtual</span> QString <a class="code" href="class_info_cdb_backend.html#ca1274681b8a808f1827d08b44f71319" title="Returns a type for the given key.">typeForKey</a>(QString key) <span class="keyword">const</span>;
<a name="l00044"></a>00044     <span class="keyword">virtual</span> QString <a class="code" href="class_info_cdb_backend.html#96b65379f588dc602406449012a9ceae" title="Returns the documentation for the given key name.">docForKey</a>(QString key) <span class="keyword">const</span>;
<a name="l00045"></a>00045     <span class="keyword">virtual</span> QString <a class="code" href="class_info_cdb_backend.html#8dd0f21473bbd9bf96bcb5698455f98a" title="Returns the constructor plugin name for the given key name.">pluginForKey</a>(QString key) <span class="keyword">const</span>;
<a name="l00046"></a>00046     <span class="keyword">virtual</span> QString <a class="code" href="class_info_cdb_backend.html#ffcf2aa0a5414bc19c2afc9a7fcffdb7" title="Returns the constructor plugin parameter for the given key name.">constructionStringForKey</a>(QString key) <span class="keyword">const</span>;
<a name="l00047"></a>00047     <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_info_cdb_backend.html#eb98f15206d742114f0110a09b56c2b3" title="Returns true if the given key exists.">keyExists</a>(QString key) <span class="keyword">const</span>;
<a name="l00048"></a>00048     <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_info_cdb_backend.html#52a737499e9eae97d4a6fdd2d00f3f4f" title="Returns true if the given key is provided (i.e., not a core property which nobody...">keyProvided</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_cdb_backend.html#2ec440b4df1e409e6cf74f5fd514fb6c" title="Returns the full path to the database directory.">databaseDirectory</a>();
<a name="l00051"></a>00051     <span class="keyword">static</span> QString <a class="code" href="class_info_cdb_backend.html#1a31a6076fc78a72e0bc00135d110fa2" title="Returns the full path to the database.">databasePath</a>();
<a name="l00052"></a>00052     <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code" href="class_info_cdb_backend.html#99e18dd002d2fdf388914721eb53599f" title="Returns true if the database file is present.">databaseExists</a>();
<a name="l00053"></a>00053 
<a name="l00054"></a>00054 <span class="keyword">private</span>:
<a name="l00055"></a><a class="code" href="class_info_cdb_backend.html#b3f82f73e8f0c453716cfe0142b19d45">00055</a>     QFileSystemWatcher <a class="code" href="class_info_cdb_backend.html#b3f82f73e8f0c453716cfe0142b19d45" title="A watched object obsering the database file. Delivers synced notifications.">watcher</a>; 
<a name="l00056"></a><a class="code" href="class_info_cdb_backend.html#c58abb26efac881051ae758d57aa3738">00056</a>     <a class="code" href="class_c_d_b_reader.html" title="A wrapper class to read data from a tiny-cdb database.">CDBReader</a> <a class="code" href="class_info_cdb_backend.html#c58abb26efac881051ae758d57aa3738" title="The cdb reader object used to access the cdb database.">reader</a>; 
<a name="l00057"></a>00057     <span class="keywordtype">void</span> <a class="code" href="class_info_cdb_backend.html#2b796a0ed33353fa81095f2491ee9dbc" title="Depending on our readability status, watch either path or the directory.">watchPathOrDirectory</a>();
<a name="l00058"></a>00058     <span class="keywordtype">void</span> <a class="code" href="class_info_cdb_backend.html#afec5ed1d442ba7e8f45a71206323916" title="Start watching the database direcory for changes.">watchDirectory</a>();
<a name="l00059"></a>00059     <span class="keywordtype">void</span> <a class="code" href="class_info_cdb_backend.html#6e5ae4857e5baa8d732d6b030b370c05" title="Start watching the database file for changes.">watchPath</a>();
<a name="l00060"></a>00060     <span class="keyword">static</span> QStringList <a class="code" href="class_info_cdb_backend.html#8d422f8e80ad4feb74620c6dd793cefd">variantListToStringList</a>(<span class="keyword">const</span> QVariantList &amp;l);
<a name="l00061"></a>00061 
<a name="l00062"></a>00062 <span class="keyword">private</span> slots:
<a name="l00063"></a>00063     <span class="keywordtype">void</span> <a class="code" href="class_info_cdb_backend.html#809ba5fe86160dd85c3221b91f480a8d" title="Called when the database changes.">onDatabaseFileChanged</a>(<span class="keyword">const</span> QString &amp;path);
<a name="l00064"></a>00064     <span class="keywordtype">void</span> <a class="code" href="class_info_cdb_backend.html#9a95be7eb4456ff22f28a37fd5eb1945" title="Called when the directory with cache.db chanes.">onDatabaseDirectoryChanged</a>(<span class="keyword">const</span> QString &amp;path);
<a name="l00065"></a>00065 };
<a name="l00066"></a>00066 
<a name="l00067"></a>00067 <span class="preprocessor">#endif // INFOCDBBACKEND_H</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Mon Sep 21 16:36:34 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>