diff options
Diffstat (limited to 'libcontextsubscriber/doc/html/class_info_backend.html')
| -rw-r--r-- | libcontextsubscriber/doc/html/class_info_backend.html | 778 |
1 files changed, 778 insertions, 0 deletions
diff --git a/libcontextsubscriber/doc/html/class_info_backend.html b/libcontextsubscriber/doc/html/class_info_backend.html new file mode 100644 index 00000000..f4a4bcf8 --- /dev/null +++ b/libcontextsubscriber/doc/html/class_info_backend.html @@ -0,0 +1,778 @@ +<!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: InfoBackend 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>InfoBackend Class Reference</h1><!-- doxytag: class="InfoBackend" -->An abstract (pure virtual) singleton class that represents the actual registry backend. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="infobackend_8h-source.html">infobackend.h</a>></code> +<p> + +<p> +<a href="class_info_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>Signals</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_backend.html#cdad993095c6538cd80cdd418a09fd63">keysChanged</a> (const QStringList &currentKeys)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Emitted when key list changes. <a class="el" href="class_context_registry_info.html" title="A class to introspect the registry contents.">ContextRegistryInfo</a> listens on that. <a href="#cdad993095c6538cd80cdd418a09fd63"></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_backend.html#159354ed05ba53b30feb861362c97ecd">keysAdded</a> (const QStringList &newKeys)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Emitted when new keys are added. <a class="el" href="class_context_registry_info.html" title="A class to introspect the registry contents.">ContextRegistryInfo</a> listens on that. <a href="#159354ed05ba53b30feb861362c97ecd"></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_backend.html#abad9b345fa7dda6c4b3630a5afda245">keysRemoved</a> (const QStringList &removedKeys)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Emitted when keys are removed. <a class="el" href="class_context_registry_info.html" title="A class to introspect the registry contents.">ContextRegistryInfo</a> listens on that. <a href="#abad9b345fa7dda6c4b3630a5afda245"></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_backend.html#c6f96cc7bae1ef15a90a79d71d12f5d7">keyDataChanged</a> (const QString &key)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Emitted when key data changes. <a class="el" href="class_context_property_info.html" title="A class to introspect a context property details.">ContextPropertyInfo</a> instances listen on that. <a href="#c6f96cc7bae1ef15a90a79d71d12f5d7"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Public Member Functions</h2></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_backend.html#fa40871167e96ccc256e33b79a628ed3">name</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the backend, ie: 'xml'. <a href="#fa40871167e96ccc256e33b79a628ed3"></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_backend.html#b982301f28a9655255683ad66c8f0c95">listKeys</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the list of all the keys in the registry. <a href="#b982301f28a9655255683ad66c8f0c95"></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_backend.html#6c0b6cff216c74c960e1874838cdce18">listKeysForPlugin</a> (QString plugin) const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the list of all the keys in the registry provided by the given <em>plugin</em>. <a href="#6c0b6cff216c74c960e1874838cdce18"></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_backend.html#493ee85a165bf228418fddc3cbb8182f">listPlugins</a> () const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a list of all the unique plugins in the database. <a href="#493ee85a165bf228418fddc3cbb8182f"></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_backend.html#accf0ff06a36c5f8edaab3013eaf8315">typeForKey</a> (QString key) const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a type for the given <em>key</em>. <a href="#accf0ff06a36c5f8edaab3013eaf8315"></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_backend.html#f90947cb65d219d1f703683a471f649d">docForKey</a> (QString key) const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the documentation for the given <em>key</em> name. <a href="#f90947cb65d219d1f703683a471f649d"></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_backend.html#938e15b64e75dfbeebad49c58049ff30">pluginForKey</a> (QString key) const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the constructor plugin name for the given <em>key</em> name. <a href="#938e15b64e75dfbeebad49c58049ff30"></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_backend.html#c17400d1938aefe60003970f9a227736">constructionStringForKey</a> (QString key) const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the constructor plugin parameter for the given <em>key</em> name. <a href="#c17400d1938aefe60003970f9a227736"></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_backend.html#2b1cff4b8da77ad9c6a449a082e4e8d3">keyExists</a> (QString key) const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the given key exists. <a href="#2b1cff4b8da77ad9c6a449a082e4e8d3"></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_backend.html#3815a2002ddbe61a310e410e3b0b18db">keyProvided</a> (QString key) const =0</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the given key is provided (i.e., not a core property which nobody provides currently). <a href="#3815a2002ddbe61a310e410e3b0b18db"></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 <a class="el" href="class_info_backend.html">InfoBackend</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#7c627815ff574b54ecd60191468fcc94">instance</a> (const QString &backendName="")</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the actual singleton instance, creates it on first access. <a href="#7c627815ff574b54ecd60191468fcc94"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#b0db0c312a540b4b6d49c434c8cf64bd">connectNotify</a> (const char *signal)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called each time we have a signal connection. Increases the connect count. <a href="#b0db0c312a540b4b6d49c434c8cf64bd"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#4800fc55302f0c049c11ce3a93a204d3">disconnectNotify</a> (const char *signal)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called each time we have a signal disconnection. Decreases the connect count. <a href="#4800fc55302f0c049c11ce3a93a204d3"></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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#4b9aafee7309b9e3a82eb3ca99ca173f">InfoBackend</a> (QObject *parent=0)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs the object. The <em>connectCount</em> is 0 on start. <a href="#4b9aafee7309b9e3a82eb3ca99ca173f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#9a4973dbc3ed8a08af2cc60e39d1e455">InfoBackend</a> (const <a class="el" href="class_info_backend.html">InfoBackend</a> &)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Private constructor. Do not use. <a href="#9a4973dbc3ed8a08af2cc60e39d1e455"></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_backend.html#26dea7269e293f178ca7a855bd8085eb">checkAndEmitKeysAdded</a> (const QStringList &currentKeys, const QStringList &oldKeys)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Given the <em>currentKeys</em> list of keys and the <em>oldKeys</em> list of keys, emit a signal containing the new keys (keys that are in <em>currentKeys</em> but are no in <em>oldKeys</em>). <a href="#26dea7269e293f178ca7a855bd8085eb"></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_backend.html#2229c5a5b2c85b50746497bed16735c2">checkAndEmitKeysRemoved</a> (const QStringList &currentKeys, const QStringList &oldKeys)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Given the <em>currentKeys</em> list of keys and the <em>oldKeys</em> list of keys, emit a signal containing the removed keys (keys that are in <em>oldKeys</em> but are no in <em>currentKeys</em>). <a href="#2229c5a5b2c85b50746497bed16735c2"></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_backend.html#5cbe66593a11b5df23ceeea4a7e1936f">checkAndEmitKeysChanged</a> (const QStringList &currentKeys, const QStringList &oldKeys)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Given the <em>currentKeys</em> list of keys and the <em>oldKeys</em> list of keys, emit a signal containing the union of those two lists. <a href="#5cbe66593a11b5df23ceeea4a7e1936f"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_info_backend.html">InfoBackend</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#90791486e0755836a52ff3f59279dc95">operator=</a> (const <a class="el" href="class_info_backend.html">InfoBackend</a> &)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Private operator. Do not use. <a href="#90791486e0755836a52ff3f59279dc95"></a><br></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 void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#e8204b17f82806015d23088f8c6776da">destroyInstance</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called before the application is destroyed. <a href="#e8204b17f82806015d23088f8c6776da"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#463dc4b191efca9c44035cb52798e0af">connectCount</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Number of connections to signals. Used to optimized signal emission when 0. <a href="#463dc4b191efca9c44035cb52798e0af"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Static Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="class_info_backend.html">InfoBackend</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#f56386ab44960a7646b5a2585688c8d8">backendInstance</a> = NULL</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds a pointer to the instance of the singelton. <a href="#f56386ab44960a7646b5a2585688c8d8"></a><br></td></tr> +<tr><td colspan="2"><br><h2>Friends</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#0fa89bc3c8483b7168bf136420b43fa4">InfoXmlBackend</a></td></tr> + +<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#84aa2becdb5d27499636a31d69e66683">InfoCdbBackend</a></td></tr> + +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +An abstract (pure virtual) singleton class that represents the actual registry backend. +<p> +This class is not exported in the public API. It provides a list methods that need to be implemented by a concrete registry backend implementation. The <a class="el" href="class_info_backend.html" title="An abstract (pure virtual) singleton class that represents the actual registry backend...">InfoBackend</a> instance is a singleton that is created on first access. This class (the instance of it) is used by <a class="el" href="class_context_registry_info.html" title="A class to introspect the registry contents.">ContextRegistryInfo</a> and <a class="el" href="class_context_property_info.html" title="A class to introspect a context property details.">ContextPropertyInfo</a> classes. <hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="4b9aafee7309b9e3a82eb3ca99ca173f"></a><!-- doxytag: member="InfoBackend::InfoBackend" ref="4b9aafee7309b9e3a82eb3ca99ca173f" args="(QObject *parent=0)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">InfoBackend::InfoBackend </td> + <td>(</td> + <td class="paramtype">QObject * </td> + <td class="paramname"> <em>parent</em> = <code>0</code> </td> + <td> ) </td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Constructs the object. The <em>connectCount</em> is 0 on start. +<p> + +</div> +</div><p> +<a class="anchor" name="9a4973dbc3ed8a08af2cc60e39d1e455"></a><!-- doxytag: member="InfoBackend::InfoBackend" ref="9a4973dbc3ed8a08af2cc60e39d1e455" args="(const InfoBackend &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">InfoBackend::InfoBackend </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="class_info_backend.html">InfoBackend</a> & </td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Private constructor. Do not use. +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="26dea7269e293f178ca7a855bd8085eb"></a><!-- doxytag: member="InfoBackend::checkAndEmitKeysAdded" ref="26dea7269e293f178ca7a855bd8085eb" args="(const QStringList &currentKeys, const QStringList &oldKeys)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void InfoBackend::checkAndEmitKeysAdded </td> + <td>(</td> + <td class="paramtype">const QStringList & </td> + <td class="paramname"> <em>currentKeys</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QStringList & </td> + <td class="paramname"> <em>oldKeys</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> +Given the <em>currentKeys</em> list of keys and the <em>oldKeys</em> list of keys, emit a signal containing the new keys (keys that are in <em>currentKeys</em> but are no in <em>oldKeys</em>). +<p> + +</div> +</div><p> +<a class="anchor" name="5cbe66593a11b5df23ceeea4a7e1936f"></a><!-- doxytag: member="InfoBackend::checkAndEmitKeysChanged" ref="5cbe66593a11b5df23ceeea4a7e1936f" args="(const QStringList &currentKeys, const QStringList &oldKeys)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void InfoBackend::checkAndEmitKeysChanged </td> + <td>(</td> + <td class="paramtype">const QStringList & </td> + <td class="paramname"> <em>currentKeys</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QStringList & </td> + <td class="paramname"> <em>oldKeys</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> +Given the <em>currentKeys</em> list of keys and the <em>oldKeys</em> list of keys, emit a signal containing the union of those two lists. +<p> + +</div> +</div><p> +<a class="anchor" name="2229c5a5b2c85b50746497bed16735c2"></a><!-- doxytag: member="InfoBackend::checkAndEmitKeysRemoved" ref="2229c5a5b2c85b50746497bed16735c2" args="(const QStringList &currentKeys, const QStringList &oldKeys)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void InfoBackend::checkAndEmitKeysRemoved </td> + <td>(</td> + <td class="paramtype">const QStringList & </td> + <td class="paramname"> <em>currentKeys</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QStringList & </td> + <td class="paramname"> <em>oldKeys</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> +Given the <em>currentKeys</em> list of keys and the <em>oldKeys</em> list of keys, emit a signal containing the removed keys (keys that are in <em>oldKeys</em> but are no in <em>currentKeys</em>). +<p> + +</div> +</div><p> +<a class="anchor" name="b0db0c312a540b4b6d49c434c8cf64bd"></a><!-- doxytag: member="InfoBackend::connectNotify" ref="b0db0c312a540b4b6d49c434c8cf64bd" args="(const char *signal)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void InfoBackend::connectNotify </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>signal</em> </td> + <td> ) </td> + <td><code> [protected, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Called each time we have a signal connection. Increases the connect count. +<p> + +</div> +</div><p> +<a class="anchor" name="c17400d1938aefe60003970f9a227736"></a><!-- doxytag: member="InfoBackend::constructionStringForKey" ref="c17400d1938aefe60003970f9a227736" args="(QString key) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual QString InfoBackend::constructionStringForKey </td> + <td>(</td> + <td class="paramtype">QString </td> + <td class="paramname"> <em>key</em> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the constructor plugin parameter for the given <em>key</em> name. +<p> + +<p>Implemented in <a class="el" href="class_info_cdb_backend.html#ffcf2aa0a5414bc19c2afc9a7fcffdb7">InfoCdbBackend</a>, and <a class="el" href="class_info_xml_backend.html#e57d73cd8bfd7e39e21369bfa2d955dc">InfoXmlBackend</a>.</p> + +</div> +</div><p> +<a class="anchor" name="e8204b17f82806015d23088f8c6776da"></a><!-- doxytag: member="InfoBackend::destroyInstance" ref="e8204b17f82806015d23088f8c6776da" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void InfoBackend::destroyInstance </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [static, private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Called before the application is destroyed. +<p> +Deletes the backend instance. This is to ensure that the QFileSystemWatcher in backends gets deleted before the application terminates (otherwise weird issues follow). +</div> +</div><p> +<a class="anchor" name="4800fc55302f0c049c11ce3a93a204d3"></a><!-- doxytag: member="InfoBackend::disconnectNotify" ref="4800fc55302f0c049c11ce3a93a204d3" args="(const char *signal)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void InfoBackend::disconnectNotify </td> + <td>(</td> + <td class="paramtype">const char * </td> + <td class="paramname"> <em>signal</em> </td> + <td> ) </td> + <td><code> [protected, virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Called each time we have a signal disconnection. Decreases the connect count. +<p> + +</div> +</div><p> +<a class="anchor" name="f90947cb65d219d1f703683a471f649d"></a><!-- doxytag: member="InfoBackend::docForKey" ref="f90947cb65d219d1f703683a471f649d" args="(QString key) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual QString InfoBackend::docForKey </td> + <td>(</td> + <td class="paramtype">QString </td> + <td class="paramname"> <em>key</em> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the documentation for the given <em>key</em> name. +<p> + +<p>Implemented in <a class="el" href="class_info_cdb_backend.html#96b65379f588dc602406449012a9ceae">InfoCdbBackend</a>, and <a class="el" href="class_info_xml_backend.html#3b0753cd69c99c2fe188e7fd912a072a">InfoXmlBackend</a>.</p> + +</div> +</div><p> +<a class="anchor" name="7c627815ff574b54ecd60191468fcc94"></a><!-- doxytag: member="InfoBackend::instance" ref="7c627815ff574b54ecd60191468fcc94" args="(const QString &backendName="")" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_info_backend.html">InfoBackend</a> * InfoBackend::instance </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>backendName</em> = <code>""</code> </td> + <td> ) </td> + <td><code> [static]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the actual singleton instance, creates it on first access. +<p> +Mutex-protected. <a class="el" href="class_context_registry_info.html" title="A class to introspect the registry contents.">ContextRegistryInfo</a> and <a class="el" href="class_context_property_info.html" title="A class to introspect a context property details.">ContextPropertyInfo</a> use this method to access the backend. The optional <em>backendName</em> specifies the backend to force, ie: 'xml' or 'cdb'. +</div> +</div><p> +<a class="anchor" name="c6f96cc7bae1ef15a90a79d71d12f5d7"></a><!-- doxytag: member="InfoBackend::keyDataChanged" ref="c6f96cc7bae1ef15a90a79d71d12f5d7" args="(const QString &key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void InfoBackend::keyDataChanged </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>key</em> </td> + <td> ) </td> + <td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Emitted when key data changes. <a class="el" href="class_context_property_info.html" title="A class to introspect a context property details.">ContextPropertyInfo</a> instances listen on that. +<p> + +</div> +</div><p> +<a class="anchor" name="2b1cff4b8da77ad9c6a449a082e4e8d3"></a><!-- doxytag: member="InfoBackend::keyExists" ref="2b1cff4b8da77ad9c6a449a082e4e8d3" args="(QString key) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool InfoBackend::keyExists </td> + <td>(</td> + <td class="paramtype">QString </td> + <td class="paramname"> <em>key</em> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns true if the given key exists. +<p> + +<p>Implemented in <a class="el" href="class_info_cdb_backend.html#eb98f15206d742114f0110a09b56c2b3">InfoCdbBackend</a>, and <a class="el" href="class_info_xml_backend.html#420f60c8530678652e8512ee5087505a">InfoXmlBackend</a>.</p> + +</div> +</div><p> +<a class="anchor" name="3815a2002ddbe61a310e410e3b0b18db"></a><!-- doxytag: member="InfoBackend::keyProvided" ref="3815a2002ddbe61a310e410e3b0b18db" args="(QString key) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool InfoBackend::keyProvided </td> + <td>(</td> + <td class="paramtype">QString </td> + <td class="paramname"> <em>key</em> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns true if the given key is provided (i.e., not a core property which nobody provides currently). +<p> + +<p>Implemented in <a class="el" href="class_info_cdb_backend.html#52a737499e9eae97d4a6fdd2d00f3f4f">InfoCdbBackend</a>, and <a class="el" href="class_info_xml_backend.html#489cbfb1dd6c35f2200f00898f16a80b">InfoXmlBackend</a>.</p> + +</div> +</div><p> +<a class="anchor" name="159354ed05ba53b30feb861362c97ecd"></a><!-- doxytag: member="InfoBackend::keysAdded" ref="159354ed05ba53b30feb861362c97ecd" args="(const QStringList &newKeys)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void InfoBackend::keysAdded </td> + <td>(</td> + <td class="paramtype">const QStringList & </td> + <td class="paramname"> <em>newKeys</em> </td> + <td> ) </td> + <td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Emitted when new keys are added. <a class="el" href="class_context_registry_info.html" title="A class to introspect the registry contents.">ContextRegistryInfo</a> listens on that. +<p> + +</div> +</div><p> +<a class="anchor" name="cdad993095c6538cd80cdd418a09fd63"></a><!-- doxytag: member="InfoBackend::keysChanged" ref="cdad993095c6538cd80cdd418a09fd63" args="(const QStringList &currentKeys)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void InfoBackend::keysChanged </td> + <td>(</td> + <td class="paramtype">const QStringList & </td> + <td class="paramname"> <em>currentKeys</em> </td> + <td> ) </td> + <td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Emitted when key list changes. <a class="el" href="class_context_registry_info.html" title="A class to introspect the registry contents.">ContextRegistryInfo</a> listens on that. +<p> + +</div> +</div><p> +<a class="anchor" name="abad9b345fa7dda6c4b3630a5afda245"></a><!-- doxytag: member="InfoBackend::keysRemoved" ref="abad9b345fa7dda6c4b3630a5afda245" args="(const QStringList &removedKeys)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void InfoBackend::keysRemoved </td> + <td>(</td> + <td class="paramtype">const QStringList & </td> + <td class="paramname"> <em>removedKeys</em> </td> + <td> ) </td> + <td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Emitted when keys are removed. <a class="el" href="class_context_registry_info.html" title="A class to introspect the registry contents.">ContextRegistryInfo</a> listens on that. +<p> + +</div> +</div><p> +<a class="anchor" name="b982301f28a9655255683ad66c8f0c95"></a><!-- doxytag: member="InfoBackend::listKeys" ref="b982301f28a9655255683ad66c8f0c95" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual QStringList InfoBackend::listKeys </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the list of all the keys in the registry. +<p> + +<p>Implemented in <a class="el" href="class_info_cdb_backend.html#16a29a2335e21a73b8317d23eadb3069">InfoCdbBackend</a>, and <a class="el" href="class_info_xml_backend.html#74d2b52119a26ca60203ecf86721e38c">InfoXmlBackend</a>.</p> + +</div> +</div><p> +<a class="anchor" name="6c0b6cff216c74c960e1874838cdce18"></a><!-- doxytag: member="InfoBackend::listKeysForPlugin" ref="6c0b6cff216c74c960e1874838cdce18" args="(QString plugin) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual QStringList InfoBackend::listKeysForPlugin </td> + <td>(</td> + <td class="paramtype">QString </td> + <td class="paramname"> <em>plugin</em> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the list of all the keys in the registry provided by the given <em>plugin</em>. +<p> + +<p>Implemented in <a class="el" href="class_info_cdb_backend.html#883490a5fe0d8cdcad199a5ceaaf0d63">InfoCdbBackend</a>, and <a class="el" href="class_info_xml_backend.html#bbc6af5d0b8d3f84892aacec96d81115">InfoXmlBackend</a>.</p> + +</div> +</div><p> +<a class="anchor" name="493ee85a165bf228418fddc3cbb8182f"></a><!-- doxytag: member="InfoBackend::listPlugins" ref="493ee85a165bf228418fddc3cbb8182f" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual QStringList InfoBackend::listPlugins </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns a list of all the unique plugins in the database. +<p> + +<p>Implemented in <a class="el" href="class_info_cdb_backend.html#61d7ea28dc908c0ebb24e4bcacc469ab">InfoCdbBackend</a>, and <a class="el" href="class_info_xml_backend.html#e7d37fb8deb9b6a091a581518961c8f9">InfoXmlBackend</a>.</p> + +</div> +</div><p> +<a class="anchor" name="fa40871167e96ccc256e33b79a628ed3"></a><!-- doxytag: member="InfoBackend::name" ref="fa40871167e96ccc256e33b79a628ed3" args="() const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual QString InfoBackend::name </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the name of the backend, ie: 'xml'. +<p> + +<p>Implemented in <a class="el" href="class_info_cdb_backend.html#98707e9504d1719000fec1d31de01174">InfoCdbBackend</a>, and <a class="el" href="class_info_xml_backend.html#83ac8d65786de855c402b426222ab72b">InfoXmlBackend</a>.</p> + +</div> +</div><p> +<a class="anchor" name="90791486e0755836a52ff3f59279dc95"></a><!-- doxytag: member="InfoBackend::operator=" ref="90791486e0755836a52ff3f59279dc95" args="(const InfoBackend &)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_info_backend.html">InfoBackend</a>& InfoBackend::operator= </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="class_info_backend.html">InfoBackend</a> & </td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [private]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Private operator. Do not use. +<p> + +</div> +</div><p> +<a class="anchor" name="938e15b64e75dfbeebad49c58049ff30"></a><!-- doxytag: member="InfoBackend::pluginForKey" ref="938e15b64e75dfbeebad49c58049ff30" args="(QString key) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual QString InfoBackend::pluginForKey </td> + <td>(</td> + <td class="paramtype">QString </td> + <td class="paramname"> <em>key</em> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the constructor plugin name for the given <em>key</em> name. +<p> + +<p>Implemented in <a class="el" href="class_info_cdb_backend.html#8dd0f21473bbd9bf96bcb5698455f98a">InfoCdbBackend</a>, and <a class="el" href="class_info_xml_backend.html#b17ce57cefbde9ce03cb9c8fb7b24233">InfoXmlBackend</a>.</p> + +</div> +</div><p> +<a class="anchor" name="accf0ff06a36c5f8edaab3013eaf8315"></a><!-- doxytag: member="InfoBackend::typeForKey" ref="accf0ff06a36c5f8edaab3013eaf8315" args="(QString key) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual QString InfoBackend::typeForKey </td> + <td>(</td> + <td class="paramtype">QString </td> + <td class="paramname"> <em>key</em> </td> + <td> ) </td> + <td> const<code> [pure virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns a type for the given <em>key</em>. +<p> + +<p>Implemented in <a class="el" href="class_info_cdb_backend.html#ca1274681b8a808f1827d08b44f71319">InfoCdbBackend</a>, and <a class="el" href="class_info_xml_backend.html#184e0e51db9b59a05cb8267206064e58">InfoXmlBackend</a>.</p> + +</div> +</div><p> +<hr><h2>Friends And Related Function Documentation</h2> +<a class="anchor" name="84aa2becdb5d27499636a31d69e66683"></a><!-- doxytag: member="InfoBackend::InfoCdbBackend" ref="84aa2becdb5d27499636a31d69e66683" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">friend class <a class="el" href="class_info_cdb_backend.html">InfoCdbBackend</a><code> [friend]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<a class="anchor" name="0fa89bc3c8483b7168bf136420b43fa4"></a><!-- doxytag: member="InfoBackend::InfoXmlBackend" ref="0fa89bc3c8483b7168bf136420b43fa4" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">friend class <a class="el" href="class_info_xml_backend.html">InfoXmlBackend</a><code> [friend]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> + +</div> +</div><p> +<hr><h2>Member Data Documentation</h2> +<a class="anchor" name="f56386ab44960a7646b5a2585688c8d8"></a><!-- doxytag: member="InfoBackend::backendInstance" ref="f56386ab44960a7646b5a2585688c8d8" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="class_info_backend.html">InfoBackend</a> * <a class="el" href="class_info_backend.html#f56386ab44960a7646b5a2585688c8d8">InfoBackend::backendInstance</a> = NULL<code> [static, private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Holds a pointer to the instance of the singelton. +<p> + +</div> +</div><p> +<a class="anchor" name="463dc4b191efca9c44035cb52798e0af"></a><!-- doxytag: member="InfoBackend::connectCount" ref="463dc4b191efca9c44035cb52798e0af" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="class_info_backend.html#463dc4b191efca9c44035cb52798e0af">InfoBackend::connectCount</a><code> [private]</code> </td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Number of connections to signals. Used to optimized signal emission when 0. +<p> + +</div> +</div><p> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="infobackend_8h-source.html">infobackend.h</a><li><a class="el" href="infobackend_8cpp.html">infobackend.cpp</a><li><a class="el" href="mocs_8cpp.html">mocs.cpp</a></ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Sep 21 16:36:35 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> |