diff options
Diffstat (limited to 'libcontextsubscriber/doc/html/class_info_backend.html')
| -rw-r--r-- | libcontextsubscriber/doc/html/class_info_backend.html | 686 |
1 files changed, 686 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..a7f6130a --- /dev/null +++ b/libcontextsubscriber/doc/html/class_info_backend.html @@ -0,0 +1,686 @@ +<!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: 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.6.1 --> +<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" --> +<p>An abstract (pure virtual) singleton class that represents the actual registry backend. +<a href="#_details">More...</a></p> + +<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></p> +<table border="0" cellpadding="0" cellspacing="0"> +<tr><td colspan="2"><h2>Signals</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#acdad993095c6538cd80cdd418a09fd63">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="#acdad993095c6538cd80cdd418a09fd63"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#a159354ed05ba53b30feb861362c97ecd">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="#a159354ed05ba53b30feb861362c97ecd"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#aabad9b345fa7dda6c4b3630a5afda245">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="#aabad9b345fa7dda6c4b3630a5afda245"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#a3962e7c993113bf00ac4fa983109aa52">keyChanged</a> (const QString &key)</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Emitted when key data/info 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="#a3962e7c993113bf00ac4fa983109aa52"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#aebe6133efbd7ee2a8c70afe44cdb06e4">listChanged</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Emitted when the 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="#aebe6133efbd7ee2a8c70afe44cdb06e4"></a><br/></td></tr> +<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#afa40871167e96ccc256e33b79a628ed3">name</a> () const =0</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the backend, ie: 'xml'. <a href="#afa40871167e96ccc256e33b79a628ed3"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#ab982301f28a9655255683ad66c8f0c95">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="#ab982301f28a9655255683ad66c8f0c95"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_context_type_info.html">ContextTypeInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#a96772d269c583b286607aad334efba94">typeInfoForKey</a> (QString key) const =0</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the type information for the given <em>key</em>. <a href="#a96772d269c583b286607aad334efba94"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#af90947cb65d219d1f703683a471f649d">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="#af90947cb65d219d1f703683a471f649d"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#a4ff58350a0f16796b0704353f554d303">keyDeclared</a> (QString key) const =0</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the given key exists. <a href="#a4ff58350a0f16796b0704353f554d303"></a><br/></td></tr> +<tr><td class="memItemLeft" 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_backend.html#a29733f7d3ba8bf62a932eae5b851d2f8">providersForKey</a> (QString key) const =0</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a list of providers for the given key. <a href="#a29733f7d3ba8bf62a932eae5b851d2f8"></a><br/></td></tr> +<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" 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#a7c627815ff574b54ecd60191468fcc94">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="#a7c627815ff574b54ecd60191468fcc94"></a><br/></td></tr> +<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#ab0db0c312a540b4b6d49c434c8cf64bd">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="#ab0db0c312a540b4b6d49c434c8cf64bd"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#a4800fc55302f0c049c11ce3a93a204d3">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="#a4800fc55302f0c049c11ce3a93a204d3"></a><br/></td></tr> +<tr><td colspan="2"><h2>Private Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#a4b9aafee7309b9e3a82eb3ca99ca173f">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="#a4b9aafee7309b9e3a82eb3ca99ca173f"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#a9a4973dbc3ed8a08af2cc60e39d1e455">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="#a9a4973dbc3ed8a08af2cc60e39d1e455"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#a26dea7269e293f178ca7a855bd8085eb">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="#a26dea7269e293f178ca7a855bd8085eb"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#a2229c5a5b2c85b50746497bed16735c2">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="#a2229c5a5b2c85b50746497bed16735c2"></a><br/></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#ad770d30f718c8110a6e14371293829b9">checkAndEmitKeyChanged</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 keyChanged signal containing the union of those two lists. <a href="#ad770d30f718c8110a6e14371293829b9"></a><br/></td></tr> +<tr><td class="memItemLeft" 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#a90791486e0755836a52ff3f59279dc95">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="#a90791486e0755836a52ff3f59279dc95"></a><br/></td></tr> +<tr><td colspan="2"><h2>Static Private Member Functions</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#ae8204b17f82806015d23088f8c6776da">destroyInstance</a> ()</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Called before the application is destroyed. <a href="#ae8204b17f82806015d23088f8c6776da"></a><br/></td></tr> +<tr><td colspan="2"><h2>Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#a463dc4b191efca9c44035cb52798e0af">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="#a463dc4b191efca9c44035cb52798e0af"></a><br/></td></tr> +<tr><td colspan="2"><h2>Static Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" 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#af56386ab44960a7646b5a2585688c8d8">backendInstance</a> = NULL</td></tr> +<tr><td class="mdescLeft"> </td><td class="mdescRight">Holds a pointer to the instance of the singelton. <a href="#af56386ab44960a7646b5a2585688c8d8"></a><br/></td></tr> +<tr><td colspan="2"><h2>Friends</h2></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#a0fa89bc3c8483b7168bf136420b43fa4">InfoXmlBackend</a></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#a84aa2becdb5d27499636a31d69e66683">InfoCdbBackend</a></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#a53ddc2857121c7ec9f2e1205ea05802f">InfoTestBackend</a></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#a905a056999dd60bfa46a1cc023ee9066">InfoXmlBackendUnitTest</a></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#ad3b9d468ea4d158bc8f3a258ab5d72be">InfoCdbBackendUnitTest</a></td></tr> +<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="class_info_backend.html#a9b2a7e8cfb6a2cfcb8c31f86a1a35aa6">InfoBackendUnitTest</a></td></tr> +</table> +<hr/><a name="_details"></a><h2>Detailed Description</h2> +<p>An abstract (pure virtual) singleton class that represents the actual registry backend. </p> +<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. </p> +<hr/><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" id="a4b9aafee7309b9e3a82eb3ca99ca173f"></a><!-- doxytag: member="InfoBackend::InfoBackend" ref="a4b9aafee7309b9e3a82eb3ca99ca173f" 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> +<a class="anchor" id="a9a4973dbc3ed8a08af2cc60e39d1e455"></a><!-- doxytag: member="InfoBackend::InfoBackend" ref="a9a4973dbc3ed8a08af2cc60e39d1e455" 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> +<hr/><h2>Member Function Documentation</h2> +<a class="anchor" id="ad770d30f718c8110a6e14371293829b9"></a><!-- doxytag: member="InfoBackend::checkAndEmitKeyChanged" ref="ad770d30f718c8110a6e14371293829b9" args="(const QStringList &currentKeys, const QStringList &oldKeys)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void InfoBackend::checkAndEmitKeyChanged </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 keyChanged signal containing the union of those two lists. </p> + +</div> +</div> +<a class="anchor" id="a26dea7269e293f178ca7a855bd8085eb"></a><!-- doxytag: member="InfoBackend::checkAndEmitKeysAdded" ref="a26dea7269e293f178ca7a855bd8085eb" 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> +<p>To be removed in future. </p> + +</div> +</div> +<a class="anchor" id="a2229c5a5b2c85b50746497bed16735c2"></a><!-- doxytag: member="InfoBackend::checkAndEmitKeysRemoved" ref="a2229c5a5b2c85b50746497bed16735c2" 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> +<p>To be removed in future. </p> + +</div> +</div> +<a class="anchor" id="ab0db0c312a540b4b6d49c434c8cf64bd"></a><!-- doxytag: member="InfoBackend::connectNotify" ref="ab0db0c312a540b4b6d49c434c8cf64bd" 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> +<a class="anchor" id="ae8204b17f82806015d23088f8c6776da"></a><!-- doxytag: member="InfoBackend::destroyInstance" ref="ae8204b17f82806015d23088f8c6776da" 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> +<p>Deletes the backend instance. This is to ensure that the QFileSystemWatcher in backends gets deleted before the application terminates (otherwise weird issues follow). </p> + +</div> +</div> +<a class="anchor" id="a4800fc55302f0c049c11ce3a93a204d3"></a><!-- doxytag: member="InfoBackend::disconnectNotify" ref="a4800fc55302f0c049c11ce3a93a204d3" 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> +<a class="anchor" id="af90947cb65d219d1f703683a471f649d"></a><!-- doxytag: member="InfoBackend::docForKey" ref="af90947cb65d219d1f703683a471f649d" 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#a96b65379f588dc602406449012a9ceae">InfoCdbBackend</a>, and <a class="el" href="class_info_xml_backend.html#a3b0753cd69c99c2fe188e7fd912a072a">InfoXmlBackend</a>.</p> + +</div> +</div> +<a class="anchor" id="a7c627815ff574b54ecd60191468fcc94"></a><!-- doxytag: member="InfoBackend::instance" ref="a7c627815ff574b54ecd60191468fcc94" 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> +<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'. </p> + +</div> +</div> +<a class="anchor" id="a3962e7c993113bf00ac4fa983109aa52"></a><!-- doxytag: member="InfoBackend::keyChanged" ref="a3962e7c993113bf00ac4fa983109aa52" args="(const QString &key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void InfoBackend::keyChanged </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/info 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> +<a class="anchor" id="a4ff58350a0f16796b0704353f554d303"></a><!-- doxytag: member="InfoBackend::keyDeclared" ref="a4ff58350a0f16796b0704353f554d303" args="(QString key) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual bool InfoBackend::keyDeclared </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#a79ee60153f6d7113ee7c454495ed3d87">InfoCdbBackend</a>, and <a class="el" href="class_info_xml_backend.html#a34f0f40564466e150f433aced83af71a">InfoXmlBackend</a>.</p> + +</div> +</div> +<a class="anchor" id="a159354ed05ba53b30feb861362c97ecd"></a><!-- doxytag: member="InfoBackend::keysAdded" ref="a159354ed05ba53b30feb861362c97ecd" 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> +<a class="anchor" id="acdad993095c6538cd80cdd418a09fd63"></a><!-- doxytag: member="InfoBackend::keysChanged" ref="acdad993095c6538cd80cdd418a09fd63" 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> +<a class="anchor" id="aabad9b345fa7dda6c4b3630a5afda245"></a><!-- doxytag: member="InfoBackend::keysRemoved" ref="aabad9b345fa7dda6c4b3630a5afda245" 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> +<a class="anchor" id="aebe6133efbd7ee2a8c70afe44cdb06e4"></a><!-- doxytag: member="InfoBackend::listChanged" ref="aebe6133efbd7ee2a8c70afe44cdb06e4" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void InfoBackend::listChanged </td> + <td>(</td> + <td class="paramname"></td> + <td> ) </td> + <td><code> [signal]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p>Emitted when the 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> +<a class="anchor" id="ab982301f28a9655255683ad66c8f0c95"></a><!-- doxytag: member="InfoBackend::listKeys" ref="ab982301f28a9655255683ad66c8f0c95" 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#a16a29a2335e21a73b8317d23eadb3069">InfoCdbBackend</a>, and <a class="el" href="class_info_xml_backend.html#a74d2b52119a26ca60203ecf86721e38c">InfoXmlBackend</a>.</p> + +</div> +</div> +<a class="anchor" id="afa40871167e96ccc256e33b79a628ed3"></a><!-- doxytag: member="InfoBackend::name" ref="afa40871167e96ccc256e33b79a628ed3" 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#a98707e9504d1719000fec1d31de01174">InfoCdbBackend</a>, and <a class="el" href="class_info_xml_backend.html#a83ac8d65786de855c402b426222ab72b">InfoXmlBackend</a>.</p> + +</div> +</div> +<a class="anchor" id="a90791486e0755836a52ff3f59279dc95"></a><!-- doxytag: member="InfoBackend::operator=" ref="a90791486e0755836a52ff3f59279dc95" 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> +<a class="anchor" id="a29733f7d3ba8bf62a932eae5b851d2f8"></a><!-- doxytag: member="InfoBackend::providersForKey" ref="a29733f7d3ba8bf62a932eae5b851d2f8" args="(QString key) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual const QList<<a class="el" href="struct_context_provider_info.html">ContextProviderInfo</a>> InfoBackend::providersForKey </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 list of providers for the given key. </p> + +<p>Implemented in <a class="el" href="class_info_cdb_backend.html#ac28d61755c842e1226fbd4e44f69a040">InfoCdbBackend</a>, and <a class="el" href="class_info_xml_backend.html#af72852cc9ec862658d2be1d59be536c0">InfoXmlBackend</a>.</p> + +</div> +</div> +<a class="anchor" id="a96772d269c583b286607aad334efba94"></a><!-- doxytag: member="InfoBackend::typeInfoForKey" ref="a96772d269c583b286607aad334efba94" args="(QString key) const =0" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">virtual <a class="el" href="class_context_type_info.html">ContextTypeInfo</a> InfoBackend::typeInfoForKey </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 type information for the given <em>key</em>. </p> + +<p>Implemented in <a class="el" href="class_info_cdb_backend.html#af81a9d1966feeae616445587e4b18de4">InfoCdbBackend</a>, and <a class="el" href="class_info_xml_backend.html#ae2ffd838ca91a653ea2f18cfa35c8799">InfoXmlBackend</a>.</p> + +</div> +</div> +<hr/><h2>Friends And Related Function Documentation</h2> +<a class="anchor" id="a9b2a7e8cfb6a2cfcb8c31f86a1a35aa6"></a><!-- doxytag: member="InfoBackend::InfoBackendUnitTest" ref="a9b2a7e8cfb6a2cfcb8c31f86a1a35aa6" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">friend class InfoBackendUnitTest<code> [friend]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a84aa2becdb5d27499636a31d69e66683"></a><!-- doxytag: member="InfoBackend::InfoCdbBackend" ref="a84aa2becdb5d27499636a31d69e66683" 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"> + +</div> +</div> +<a class="anchor" id="ad3b9d468ea4d158bc8f3a258ab5d72be"></a><!-- doxytag: member="InfoBackend::InfoCdbBackendUnitTest" ref="ad3b9d468ea4d158bc8f3a258ab5d72be" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">friend class InfoCdbBackendUnitTest<code> [friend]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a53ddc2857121c7ec9f2e1205ea05802f"></a><!-- doxytag: member="InfoBackend::InfoTestBackend" ref="a53ddc2857121c7ec9f2e1205ea05802f" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">friend class InfoTestBackend<code> [friend]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +</div> +</div> +<a class="anchor" id="a0fa89bc3c8483b7168bf136420b43fa4"></a><!-- doxytag: member="InfoBackend::InfoXmlBackend" ref="a0fa89bc3c8483b7168bf136420b43fa4" 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"> + +</div> +</div> +<a class="anchor" id="a905a056999dd60bfa46a1cc023ee9066"></a><!-- doxytag: member="InfoBackend::InfoXmlBackendUnitTest" ref="a905a056999dd60bfa46a1cc023ee9066" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">friend class InfoXmlBackendUnitTest<code> [friend]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +</div> +</div> +<hr/><h2>Member Data Documentation</h2> +<a class="anchor" id="af56386ab44960a7646b5a2585688c8d8"></a><!-- doxytag: member="InfoBackend::backendInstance" ref="af56386ab44960a7646b5a2585688c8d8" 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#af56386ab44960a7646b5a2585688c8d8">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> +<a class="anchor" id="a463dc4b191efca9c44035cb52798e0af"></a><!-- doxytag: member="InfoBackend::connectCount" ref="a463dc4b191efca9c44035cb52798e0af" args="" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">int <a class="el" href="class_info_backend.html#a463dc4b191efca9c44035cb52798e0af">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> +<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> +<li><a class="el" href="infobackend_8cpp.html">infobackend.cpp</a></li> +<li><a class="el" href="mocs_8cpp.html">mocs.cpp</a></li> +</ul> +</div> +<hr size="1"/><address style="text-align: right;"><small>Generated on Fri Nov 27 10:23:11 2009 for libcontextsubscriber by +<a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> +</body> +</html> |