diff options
Diffstat (limited to 'libcontextsubscriber/doc/html/class_c_d_b_reader.html')
| -rw-r--r-- | libcontextsubscriber/doc/html/class_c_d_b_reader.html | 333 |
1 files changed, 333 insertions, 0 deletions
diff --git a/libcontextsubscriber/doc/html/class_c_d_b_reader.html b/libcontextsubscriber/doc/html/class_c_d_b_reader.html new file mode 100644 index 00000000..4a18af59 --- /dev/null +++ b/libcontextsubscriber/doc/html/class_c_d_b_reader.html @@ -0,0 +1,333 @@ +<!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: CDBReader 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>CDBReader Class Reference</h1><!-- doxytag: class="CDBReader" -->A wrapper class to read data from a tiny-cdb database. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="cdbreader_8h-source.html">cdbreader.h</a>></code> +<p> + +<p> +<a href="class_c_d_b_reader-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_c_d_b_reader.html#da59740e3d69efc32db88cdb4514dcfa">CDBReader</a> (const QString &dbpath, QObject *parent=0)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new <a class="el" href="class_c_d_b_reader.html" title="A wrapper class to read data from a tiny-cdb database.">CDBReader</a> reading from cdb database at <em>dbpath</em>. <a href="#da59740e3d69efc32db88cdb4514dcfa"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_reader.html#bd17716f2bcfc205ddf9ab47b5005a8a">~CDBReader</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroys the object automatically closing the database and file. <a href="#bd17716f2bcfc205ddf9ab47b5005a8a"></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_c_d_b_reader.html#4a6881b3b4fd14c2badcdbbfc1a5741c">close</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Closes the reader and the underlying file on the filesystem. <a href="#4a6881b3b4fd14c2badcdbbfc1a5741c"></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_c_d_b_reader.html#32774adde1a5edcf80e2ccd981d93eb5">reopen</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Reopens the reader for reading. <a href="#32774adde1a5edcf80e2ccd981d93eb5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">QVariantList </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_reader.html#0ad9d8670836cc8ce12a2f364495aa5c">valuesForKey</a> (const QString &key) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns all values associated with the given key from the database. <a href="#0ad9d8670836cc8ce12a2f364495aa5c"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">QVariant </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_reader.html#65d872621906917c9f72bcfebf24343b">valueForKey</a> (const QString &key) const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a value for the given <em>key</em>. <a href="#65d872621906917c9f72bcfebf24343b"></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_c_d_b_reader.html#05e7a3925a61aea6a0375c05f16cc142">isReadable</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current state of the reader. <a href="#05e7a3925a61aea6a0375c05f16cc142"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_reader.html#5a5b29f1d6c958ea4384f7e9680d0d3e">fileDescriptor</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the file descriptor used by the reader. <a href="#5a5b29f1d6c958ea4384f7e9680d0d3e"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_reader.html#e38694ac8ddcf3f290616e28c163bfd5">path</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Path pointing to the database. <a href="#e38694ac8ddcf3f290616e28c163bfd5"></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_c_d_b_reader.html#2724a80b3ddfb3a30e6af954d162403f">cdb</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Cdb library object used for reading. <a href="#2724a80b3ddfb3a30e6af954d162403f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_d_b_reader.html#95f1693de1549bf12e299a18f678178c">fd</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">A file descriptor to the database. <a href="#95f1693de1549bf12e299a18f678178c"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +A wrapper class to read data from a tiny-cdb database. +<p> +This class is not a part of the public API. The reader operates on string-qvariant pairs: can read a qvariant value for a string key or a list of qvariant values for a string key. The reader automatically closes the underlying filesystem resource on destruction but can be also closed manually.<p> +Reading from a closed reader will return empty strings. <hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="da59740e3d69efc32db88cdb4514dcfa"></a><!-- doxytag: member="CDBReader::CDBReader" ref="da59740e3d69efc32db88cdb4514dcfa" args="(const QString &dbpath, QObject *parent=0)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">CDBReader::CDBReader </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>dbpath</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">QObject * </td> + <td class="paramname"> <em>parent</em> = <code>0</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [explicit]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Constructs a new <a class="el" href="class_c_d_b_reader.html" title="A wrapper class to read data from a tiny-cdb database.">CDBReader</a> reading from cdb database at <em>dbpath</em>. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>dbpath</em> </td><td>Path to the database. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="bd17716f2bcfc205ddf9ab47b5005a8a"></a><!-- doxytag: member="CDBReader::~CDBReader" ref="bd17716f2bcfc205ddf9ab47b5005a8a" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">CDBReader::~CDBReader </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Destroys the object automatically closing the database and file. +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="4a6881b3b4fd14c2badcdbbfc1a5741c"></a><!-- doxytag: member="CDBReader::close" ref="4a6881b3b4fd14c2badcdbbfc1a5741c" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void CDBReader::close </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Closes the reader and the underlying file on the filesystem. +<p> + +</div> +</div><p> +<a class="anchor" name="5a5b29f1d6c958ea4384f7e9680d0d3e"></a><!-- doxytag: member="CDBReader::fileDescriptor" ref="5a5b29f1d6c958ea4384f7e9680d0d3e" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int CDBReader::fileDescriptor </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the file descriptor used by the reader. +<p> +Returns 0 when the reader is closed. +</div> +</div><p> +<a class="anchor" name="05e7a3925a61aea6a0375c05f16cc142"></a><!-- doxytag: member="CDBReader::isReadable" ref="05e7a3925a61aea6a0375c05f16cc142" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool CDBReader::isReadable </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the current state of the reader. +<p> +Reader is not readable if it was created with a path that doesn't exist or if it was closed. +</div> +</div><p> +<a class="anchor" name="32774adde1a5edcf80e2ccd981d93eb5"></a><!-- doxytag: member="CDBReader::reopen" ref="32774adde1a5edcf80e2ccd981d93eb5" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void CDBReader::reopen </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Reopens the reader for reading. +<p> +It will first close the current reader if it's open. +</div> +</div><p> +<a class="anchor" name="65d872621906917c9f72bcfebf24343b"></a><!-- doxytag: member="CDBReader::valueForKey" ref="65d872621906917c9f72bcfebf24343b" args="(const QString &key) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QVariant CDBReader::valueForKey </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>key</em> </td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns a value for the given <em>key</em>. +<p> +First value is returned if there are many values for one key. <dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>The key name in the database. </td></tr> + </table> +</dl> + +</div> +</div><p> +<a class="anchor" name="0ad9d8670836cc8ce12a2f364495aa5c"></a><!-- doxytag: member="CDBReader::valuesForKey" ref="0ad9d8670836cc8ce12a2f364495aa5c" args="(const QString &key) const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QVariantList CDBReader::valuesForKey </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>key</em> </td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns all values associated with the given key from the database. +<p> +<dl compact><dt><b>Parameters:</b></dt><dd> + <table border="0" cellspacing="2" cellpadding="0"> + <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>The key name in the database. </td></tr> + </table> +</dl> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="2724a80b3ddfb3a30e6af954d162403f"></a><!-- doxytag: member="CDBReader::cdb" ref="2724a80b3ddfb3a30e6af954d162403f" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void* <a class="el" href="class_c_d_b_reader.html#2724a80b3ddfb3a30e6af954d162403f">CDBReader::cdb</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Cdb library object used for reading. +<p> + +</div> +</div><p> +<a class="anchor" name="95f1693de1549bf12e299a18f678178c"></a><!-- doxytag: member="CDBReader::fd" ref="95f1693de1549bf12e299a18f678178c" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="class_c_d_b_reader.html#95f1693de1549bf12e299a18f678178c">CDBReader::fd</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +A file descriptor to the database. +<p> + +</div> +</div><p> +<a class="anchor" name="e38694ac8ddcf3f290616e28c163bfd5"></a><!-- doxytag: member="CDBReader::path" ref="e38694ac8ddcf3f290616e28c163bfd5" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString <a class="el" href="class_c_d_b_reader.html#e38694ac8ddcf3f290616e28c163bfd5">CDBReader::path</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Path pointing to the database. +<p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="cdbreader_8h-source.html">cdbreader.h</a><li><a class="el" href="cdbreader_8cpp.html">cdbreader.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> |