diff options
Diffstat (limited to 'libcontextsubscriber/doc/html/class_info_cdb_backend.html')
| -rw-r--r-- | libcontextsubscriber/doc/html/class_info_cdb_backend.html | 445 |
1 files changed, 445 insertions, 0 deletions
diff --git a/libcontextsubscriber/doc/html/class_info_cdb_backend.html b/libcontextsubscriber/doc/html/class_info_cdb_backend.html new file mode 100644 index 00000000..0f967415 --- /dev/null +++ b/libcontextsubscriber/doc/html/class_info_cdb_backend.html @@ -0,0 +1,445 @@ +<!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 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>InfoCdbBackend Class Reference</h1><!-- doxytag: class="InfoCdbBackend" --><!-- doxytag: inherits="InfoBackend" -->Implements the <a class="el" href="class_info_backend.html" title="An abstract (pure virtual) singleton class that represents the actual registry backend...">InfoBackend</a> for reading data from a cdb database. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="infocdbbackend_8h-source.html">infocdbbackend.h</a>></code> +<p> + +<p> +<a href="class_info_cdb_backend-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_cdb_backend.html#8e31c8ded7f1620ab626d17f23bf3042">InfoCdbBackend</a> (QObject *parent=0)</td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_cdb_backend.html#98707e9504d1719000fec1d31de01174">name</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns 'cdb'. <a href="#98707e9504d1719000fec1d31de01174"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_cdb_backend.html#16a29a2335e21a73b8317d23eadb3069">listKeys</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the list of all the keys in the registry. <a href="#16a29a2335e21a73b8317d23eadb3069"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_cdb_backend.html#ca1274681b8a808f1827d08b44f71319">typeForKey</a> (QString key) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a type for the given <em>key</em>. <a href="#ca1274681b8a808f1827d08b44f71319"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_cdb_backend.html#96b65379f588dc602406449012a9ceae">docForKey</a> (QString key) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the documentation for the given <em>key</em> name. <a href="#96b65379f588dc602406449012a9ceae"></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_cdb_backend.html#79ee60153f6d7113ee7c454495ed3d87">keyDeclared</a> (QString key) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the given key exists. <a href="#79ee60153f6d7113ee7c454495ed3d87"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const QList<br class="typebreak"> +< <a class="el" href="struct_context_provider_info.html">ContextProviderInfo</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_cdb_backend.html#c28d61755c842e1226fbd4e44f69a040">providersForKey</a> (QString key) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a list of providers for the given key. <a href="#c28d61755c842e1226fbd4e44f69a040"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_cdb_backend.html#2ec440b4df1e409e6cf74f5fd514fb6c">databaseDirectory</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the full path to the database directory. <a href="#2ec440b4df1e409e6cf74f5fd514fb6c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_cdb_backend.html#1a31a6076fc78a72e0bc00135d110fa2">databasePath</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the full path to the database. <a href="#1a31a6076fc78a72e0bc00135d110fa2"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_cdb_backend.html#99e18dd002d2fdf388914721eb53599f">databaseExists</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the database file is present. <a href="#99e18dd002d2fdf388914721eb53599f"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Private Slots</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_cdb_backend.html#809ba5fe86160dd85c3221b91f480a8d">onDatabaseFileChanged</a> (const QString &path)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called when the database changes. <a href="#809ba5fe86160dd85c3221b91f480a8d"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_cdb_backend.html#9a95be7eb4456ff22f28a37fd5eb1945">onDatabaseDirectoryChanged</a> (const QString &path)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called when the directory with cache.db chanes. <a href="#9a95be7eb4456ff22f28a37fd5eb1945"></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">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_cdb_backend.html#f9a982a33f464a0579357fbc53e3305c">watch</a> ()</td></tr> + +<tr><td colspan="2"><br><h2>Static Private Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_cdb_backend.html#8d422f8e80ad4feb74620c6dd793cefd">variantListToStringList</a> (const QVariantList &l)</td></tr> + +<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">QFileSystemWatcher </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_cdb_backend.html#b3f82f73e8f0c453716cfe0142b19d45">watcher</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">A watched object obsering the database file. Delivers synced notifications. <a href="#b3f82f73e8f0c453716cfe0142b19d45"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_c_d_b_reader.html">CDBReader</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_cdb_backend.html#c58abb26efac881051ae758d57aa3738">reader</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The cdb reader object used to access the cdb database. <a href="#c58abb26efac881051ae758d57aa3738"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Implements the <a class="el" href="class_info_backend.html" title="An abstract (pure virtual) singleton class that represents the actual registry backend...">InfoBackend</a> for reading data from a cdb database. +<p> +This class is not exported in the public API. It does not cache any data to optimize the memory consumption. It's assumed that most data is anyways cached (as needed) in the <a class="el" href="class_context_property_info.html" title="A class to introspect a context property details.">ContextPropertyInfo</a> and the cdb key-based access (no enumetation) is fast anyways. It observers the <code>cache.cdb</code> with a file system watcher. <hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="8e31c8ded7f1620ab626d17f23bf3042"></a><!-- doxytag: member="InfoCdbBackend::InfoCdbBackend" ref="8e31c8ded7f1620ab626d17f23bf3042" args="(QObject *parent=0)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">InfoCdbBackend::InfoCdbBackend </td> + <td>(</td> + <td class="paramtype">QObject * </td> + <td class="paramname"> <em>parent</em> = <code>0</code> </td> + <td> ) </td> + <td><code> [explicit]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="2ec440b4df1e409e6cf74f5fd514fb6c"></a><!-- doxytag: member="InfoCdbBackend::databaseDirectory" ref="2ec440b4df1e409e6cf74f5fd514fb6c" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString InfoCdbBackend::databaseDirectory </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the full path to the database directory. +<p> +Takes the <code>CONTEXT_PROVIDERS</code> env variable into account. +</div> +</div><p> +<a class="anchor" name="99e18dd002d2fdf388914721eb53599f"></a><!-- doxytag: member="InfoCdbBackend::databaseExists" ref="99e18dd002d2fdf388914721eb53599f" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool InfoCdbBackend::databaseExists </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns true if the database file is present. +<p> + +</div> +</div><p> +<a class="anchor" name="1a31a6076fc78a72e0bc00135d110fa2"></a><!-- doxytag: member="InfoCdbBackend::databasePath" ref="1a31a6076fc78a72e0bc00135d110fa2" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString InfoCdbBackend::databasePath </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the full path to the database. +<p> +Takes the <code>CONTEXT_PROVIDERS</code> env variable into account. +</div> +</div><p> +<a class="anchor" name="96b65379f588dc602406449012a9ceae"></a><!-- doxytag: member="InfoCdbBackend::docForKey" ref="96b65379f588dc602406449012a9ceae" args="(QString key) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString InfoCdbBackend::docForKey </td> + <td>(</td> + <td class="paramtype">QString </td> + <td class="paramname"> <em>key</em> </td> + <td> ) </td> + <td> const<code> [virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the documentation for the given <em>key</em> name. +<p> + +<p>Implements <a class="el" href="class_info_backend.html#f90947cb65d219d1f703683a471f649d">InfoBackend</a>.</p> + +</div> +</div><p> +<a class="anchor" name="79ee60153f6d7113ee7c454495ed3d87"></a><!-- doxytag: member="InfoCdbBackend::keyDeclared" ref="79ee60153f6d7113ee7c454495ed3d87" args="(QString key) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool InfoCdbBackend::keyDeclared </td> + <td>(</td> + <td class="paramtype">QString </td> + <td class="paramname"> <em>key</em> </td> + <td> ) </td> + <td> const<code> [virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns true if the given key exists. +<p> + +<p>Implements <a class="el" href="class_info_backend.html#4ff58350a0f16796b0704353f554d303">InfoBackend</a>.</p> + +</div> +</div><p> +<a class="anchor" name="16a29a2335e21a73b8317d23eadb3069"></a><!-- doxytag: member="InfoCdbBackend::listKeys" ref="16a29a2335e21a73b8317d23eadb3069" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QStringList InfoCdbBackend::listKeys </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the list of all the keys in the registry. +<p> + +<p>Implements <a class="el" href="class_info_backend.html#b982301f28a9655255683ad66c8f0c95">InfoBackend</a>.</p> + +</div> +</div><p> +<a class="anchor" name="98707e9504d1719000fec1d31de01174"></a><!-- doxytag: member="InfoCdbBackend::name" ref="98707e9504d1719000fec1d31de01174" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString InfoCdbBackend::name </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns 'cdb'. +<p> + +<p>Implements <a class="el" href="class_info_backend.html#fa40871167e96ccc256e33b79a628ed3">InfoBackend</a>.</p> + +</div> +</div><p> +<a class="anchor" name="9a95be7eb4456ff22f28a37fd5eb1945"></a><!-- doxytag: member="InfoCdbBackend::onDatabaseDirectoryChanged" ref="9a95be7eb4456ff22f28a37fd5eb1945" args="(const QString &path)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void InfoCdbBackend::onDatabaseDirectoryChanged </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>path</em> </td> + <td> ) </td> + <td><code> [private, slot]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Called when the directory with cache.db chanes. +<p> +We start to observe this directory only when we don't have the cache.db in the first place. +</div> +</div><p> +<a class="anchor" name="809ba5fe86160dd85c3221b91f480a8d"></a><!-- doxytag: member="InfoCdbBackend::onDatabaseFileChanged" ref="809ba5fe86160dd85c3221b91f480a8d" args="(const QString &path)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void InfoCdbBackend::onDatabaseFileChanged </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>path</em> </td> + <td> ) </td> + <td><code> [private, slot]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Called when the database changes. +<p> +Reopens the database and emits the change signals. If database does not exist it bails out but keeps observing. +</div> +</div><p> +<a class="anchor" name="c28d61755c842e1226fbd4e44f69a040"></a><!-- doxytag: member="InfoCdbBackend::providersForKey" ref="c28d61755c842e1226fbd4e44f69a040" args="(QString key) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">const QList< <a class="el" href="struct_context_provider_info.html">ContextProviderInfo</a> > InfoCdbBackend::providersForKey </td> + <td>(</td> + <td class="paramtype">QString </td> + <td class="paramname"> <em>key</em> </td> + <td> ) </td> + <td> const<code> [virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns a list of providers for the given key. +<p> + +<p>Implements <a class="el" href="class_info_backend.html#29733f7d3ba8bf62a932eae5b851d2f8">InfoBackend</a>.</p> + +</div> +</div><p> +<a class="anchor" name="ca1274681b8a808f1827d08b44f71319"></a><!-- doxytag: member="InfoCdbBackend::typeForKey" ref="ca1274681b8a808f1827d08b44f71319" args="(QString key) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString InfoCdbBackend::typeForKey </td> + <td>(</td> + <td class="paramtype">QString </td> + <td class="paramname"> <em>key</em> </td> + <td> ) </td> + <td> const<code> [virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns a type for the given <em>key</em>. +<p> + +<p>Implements <a class="el" href="class_info_backend.html#accf0ff06a36c5f8edaab3013eaf8315">InfoBackend</a>.</p> + +</div> +</div><p> +<a class="anchor" name="8d422f8e80ad4feb74620c6dd793cefd"></a><!-- doxytag: member="InfoCdbBackend::variantListToStringList" ref="8d422f8e80ad4feb74620c6dd793cefd" args="(const QVariantList &l)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QStringList InfoCdbBackend::variantListToStringList </td> + <td>(</td> + <td class="paramtype">const QVariantList & </td> + <td class="paramname"> <em>l</em> </td> + <td> ) </td> + <td><code> [static, private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="f9a982a33f464a0579357fbc53e3305c"></a><!-- doxytag: member="InfoCdbBackend::watch" ref="f9a982a33f464a0579357fbc53e3305c" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void InfoCdbBackend::watch </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="c58abb26efac881051ae758d57aa3738"></a><!-- doxytag: member="InfoCdbBackend::reader" ref="c58abb26efac881051ae758d57aa3738" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_c_d_b_reader.html">CDBReader</a> <a class="el" href="class_info_cdb_backend.html#c58abb26efac881051ae758d57aa3738">InfoCdbBackend::reader</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +The cdb reader object used to access the cdb database. +<p> + +</div> +</div><p> +<a class="anchor" name="b3f82f73e8f0c453716cfe0142b19d45"></a><!-- doxytag: member="InfoCdbBackend::watcher" ref="b3f82f73e8f0c453716cfe0142b19d45" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QFileSystemWatcher <a class="el" href="class_info_cdb_backend.html#b3f82f73e8f0c453716cfe0142b19d45">InfoCdbBackend::watcher</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +A watched object obsering the database file. Delivers synced notifications. +<p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="infocdbbackend_8h-source.html">infocdbbackend.h</a><li><a class="el" href="infocdbbackend_8cpp.html">infocdbbackend.cpp</a></ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Fri Oct 23 08:59:23 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> |