diff options
Diffstat (limited to 'libcontextsubscriber/doc/html/infobackend_8h-source.html')
| -rw-r--r-- | libcontextsubscriber/doc/html/infobackend_8h-source.html | 119 |
1 files changed, 119 insertions, 0 deletions
diff --git a/libcontextsubscriber/doc/html/infobackend_8h-source.html b/libcontextsubscriber/doc/html/infobackend_8h-source.html new file mode 100644 index 00000000..d7af918f --- /dev/null +++ b/libcontextsubscriber/doc/html/infobackend_8h-source.html @@ -0,0 +1,119 @@ +<!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.h Source File</title> +<link href="tabs.css" rel="stylesheet" type="text/css"> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.5.8 --> +<div class="navigation" id="top"> + <div class="tabs"> + <ul> + <li><a href="index.html"><span>Main 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><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + </ul> + </div> + <div class="tabs"> + <ul> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>File Members</span></a></li> + </ul> + </div> +<h1>infobackend.h</h1><a href="infobackend_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> +<a name="l00002"></a>00002 <span class="comment"> * Copyright (C) 2008 Nokia Corporation.</span> +<a name="l00003"></a>00003 <span class="comment"> *</span> +<a name="l00004"></a>00004 <span class="comment"> * Contact: Marius Vollmer <marius.vollmer@nokia.com></span> +<a name="l00005"></a>00005 <span class="comment"> *</span> +<a name="l00006"></a>00006 <span class="comment"> * This library is free software; you can redistribute it and/or</span> +<a name="l00007"></a>00007 <span class="comment"> * modify it under the terms of the GNU Lesser General Public License</span> +<a name="l00008"></a>00008 <span class="comment"> * version 2.1 as published by the Free Software Foundation.</span> +<a name="l00009"></a>00009 <span class="comment"> *</span> +<a name="l00010"></a>00010 <span class="comment"> * This library is distributed in the hope that it will be useful, but</span> +<a name="l00011"></a>00011 <span class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</span> +<a name="l00012"></a>00012 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span> +<a name="l00013"></a>00013 <span class="comment"> * Lesser General Public License for more details.</span> +<a name="l00014"></a>00014 <span class="comment"> *</span> +<a name="l00015"></a>00015 <span class="comment"> * You should have received a copy of the GNU Lesser General Public</span> +<a name="l00016"></a>00016 <span class="comment"> * License along with this library; if not, write to the Free Software</span> +<a name="l00017"></a>00017 <span class="comment"> * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA</span> +<a name="l00018"></a>00018 <span class="comment"> * 02110-1301 USA</span> +<a name="l00019"></a>00019 <span class="comment"> *</span> +<a name="l00020"></a>00020 <span class="comment"> */</span> +<a name="l00021"></a>00021 +<a name="l00022"></a>00022 <span class="preprocessor">#ifndef INFOBACKEND_H</span> +<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define INFOBACKEND_H</span> +<a name="l00024"></a>00024 <span class="preprocessor"></span> +<a name="l00025"></a>00025 <span class="preprocessor">#include <QVariant></span> +<a name="l00026"></a>00026 <span class="preprocessor">#include <QStringList></span> +<a name="l00027"></a>00027 <span class="preprocessor">#include <QObject></span> +<a name="l00028"></a>00028 +<a name="l00029"></a><a class="code" href="class_info_backend.html">00029</a> <span class="keyword">class </span><a class="code" href="class_info_backend.html" title="An abstract (pure virtual) singleton class that represents the actual registry backend...">InfoBackend</a> : <span class="keyword">public</span> QObject +<a name="l00030"></a>00030 { +<a name="l00031"></a>00031 Q_OBJECT +<a name="l00032"></a>00032 +<a name="l00033"></a>00033 <span class="keyword">public</span>: +<a name="l00034"></a>00034 +<a name="l00035"></a>00035 <span class="keyword">static</span> <a class="code" href="class_info_backend.html" title="An abstract (pure virtual) singleton class that represents the actual registry backend...">InfoBackend</a>* <a class="code" href="class_info_backend.html#7c627815ff574b54ecd60191468fcc94" title="Returns the actual singleton instance, creates it on first access.">instance</a>(<span class="keyword">const</span> QString &backendName = <span class="stringliteral">""</span>); +<a name="l00036"></a>00036 +<a name="l00038"></a>00038 <span class="keyword">virtual</span> QString <a class="code" href="class_info_backend.html#fa40871167e96ccc256e33b79a628ed3" title="Returns the name of the backend, ie: &#39;xml&#39;.">name</a>() <span class="keyword">const</span> = 0; +<a name="l00039"></a>00039 +<a name="l00041"></a>00041 <span class="keyword">virtual</span> QStringList <a class="code" href="class_info_backend.html#b982301f28a9655255683ad66c8f0c95" title="Returns the list of all the keys in the registry.">listKeys</a>() <span class="keyword">const</span> = 0; +<a name="l00042"></a>00042 +<a name="l00045"></a>00045 <span class="keyword">virtual</span> QStringList <a class="code" href="class_info_backend.html#6c0b6cff216c74c960e1874838cdce18" title="Returns the list of all the keys in the registry provided by the given plugin.">listKeysForPlugin</a>(QString plugin) <span class="keyword">const</span> = 0; +<a name="l00046"></a>00046 +<a name="l00048"></a>00048 <span class="keyword">virtual</span> QStringList <a class="code" href="class_info_backend.html#493ee85a165bf228418fddc3cbb8182f" title="Returns a list of all the unique plugins in the database.">listPlugins</a>() <span class="keyword">const</span> = 0; +<a name="l00049"></a>00049 +<a name="l00051"></a>00051 <span class="keyword">virtual</span> QString <a class="code" href="class_info_backend.html#accf0ff06a36c5f8edaab3013eaf8315" title="Returns a type for the given key.">typeForKey</a>(QString key) <span class="keyword">const</span> = 0; +<a name="l00052"></a>00052 +<a name="l00054"></a>00054 <span class="keyword">virtual</span> QString <a class="code" href="class_info_backend.html#f90947cb65d219d1f703683a471f649d" title="Returns the documentation for the given key name.">docForKey</a>(QString key) <span class="keyword">const</span> = 0; +<a name="l00055"></a>00055 +<a name="l00057"></a>00057 <span class="keyword">virtual</span> QString <a class="code" href="class_info_backend.html#938e15b64e75dfbeebad49c58049ff30" title="Returns the constructor plugin name for the given key name.">pluginForKey</a>(QString key) <span class="keyword">const</span> = 0; +<a name="l00058"></a>00058 +<a name="l00060"></a>00060 <span class="keyword">virtual</span> QString <a class="code" href="class_info_backend.html#c17400d1938aefe60003970f9a227736" title="Returns the constructor plugin parameter for the given key name.">constructionStringForKey</a>(QString key) <span class="keyword">const</span> = 0; +<a name="l00061"></a>00061 +<a name="l00063"></a>00063 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_info_backend.html#2b1cff4b8da77ad9c6a449a082e4e8d3" title="Returns true if the given key exists.">keyExists</a>(QString key) <span class="keyword">const</span> = 0; +<a name="l00064"></a>00064 +<a name="l00067"></a>00067 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_info_backend.html#3815a2002ddbe61a310e410e3b0b18db" title="Returns true if the given key is provided (i.e., not a core property which nobody...">keyProvided</a>(QString key) <span class="keyword">const</span> = 0; +<a name="l00068"></a>00068 +<a name="l00069"></a>00069 signals: +<a name="l00071"></a>00071 <span class="keywordtype">void</span> <a class="code" href="class_info_backend.html#cdad993095c6538cd80cdd418a09fd63" title="Emitted when key list changes. ContextRegistryInfo listens on that.">keysChanged</a>(<span class="keyword">const</span> QStringList& currentKeys); +<a name="l00072"></a>00072 +<a name="l00074"></a>00074 <span class="keywordtype">void</span> <a class="code" href="class_info_backend.html#159354ed05ba53b30feb861362c97ecd" title="Emitted when new keys are added. ContextRegistryInfo listens on that.">keysAdded</a>(<span class="keyword">const</span> QStringList& newKeys); +<a name="l00075"></a>00075 +<a name="l00077"></a>00077 <span class="keywordtype">void</span> <a class="code" href="class_info_backend.html#abad9b345fa7dda6c4b3630a5afda245" title="Emitted when keys are removed. ContextRegistryInfo listens on that.">keysRemoved</a>(<span class="keyword">const</span> QStringList& removedKeys); +<a name="l00078"></a>00078 +<a name="l00080"></a>00080 <span class="keywordtype">void</span> <a class="code" href="class_info_backend.html#c6f96cc7bae1ef15a90a79d71d12f5d7" title="Emitted when key data changes. ContextPropertyInfo instances listen on that.">keyDataChanged</a>(<span class="keyword">const</span> QString& key); +<a name="l00081"></a>00081 +<a name="l00082"></a>00082 <span class="keyword">protected</span>: +<a name="l00083"></a>00083 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_info_backend.html#b0db0c312a540b4b6d49c434c8cf64bd" title="Called each time we have a signal connection. Increases the connect count.">connectNotify</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *signal); +<a name="l00084"></a>00084 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_info_backend.html#4800fc55302f0c049c11ce3a93a204d3" title="Called each time we have a signal disconnection. Decreases the connect count.">disconnectNotify</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *signal); +<a name="l00085"></a>00085 +<a name="l00086"></a>00086 <span class="keyword">private</span>: +<a name="l00087"></a><a class="code" href="class_info_backend.html#463dc4b191efca9c44035cb52798e0af">00087</a> <span class="keywordtype">int</span> <a class="code" href="class_info_backend.html#463dc4b191efca9c44035cb52798e0af" title="Number of connections to signals. Used to optimized signal emission when 0.">connectCount</a>; +<a name="l00088"></a>00088 +<a name="l00089"></a>00089 <a class="code" href="class_info_backend.html#4b9aafee7309b9e3a82eb3ca99ca173f" title="Constructs the object. The connectCount is 0 on start.">InfoBackend</a>(QObject *parent = 0); +<a name="l00090"></a>00090 +<a name="l00092"></a>00092 <a class="code" href="class_info_backend.html#4b9aafee7309b9e3a82eb3ca99ca173f" title="Constructs the object. The connectCount is 0 on start.">InfoBackend</a>(<span class="keyword">const</span> <a class="code" href="class_info_backend.html" title="An abstract (pure virtual) singleton class that represents the actual registry backend...">InfoBackend</a>&); +<a name="l00093"></a>00093 +<a name="l00094"></a>00094 <span class="keywordtype">void</span> <a class="code" href="class_info_backend.html#26dea7269e293f178ca7a855bd8085eb" title="Given the currentKeys list of keys and the oldKeys list of keys, emit a signal containing...">checkAndEmitKeysAdded</a>(<span class="keyword">const</span> QStringList &currentKeys, <span class="keyword">const</span> QStringList &oldKeys); +<a name="l00095"></a>00095 <span class="keywordtype">void</span> <a class="code" href="class_info_backend.html#2229c5a5b2c85b50746497bed16735c2" title="Given the currentKeys list of keys and the oldKeys list of keys, emit a signal containing...">checkAndEmitKeysRemoved</a>(<span class="keyword">const</span> QStringList &currentKeys, <span class="keyword">const</span> QStringList &oldKeys); +<a name="l00096"></a>00096 <span class="keywordtype">void</span> <a class="code" href="class_info_backend.html#5cbe66593a11b5df23ceeea4a7e1936f" title="Given the currentKeys list of keys and the oldKeys list of keys, emit a signal containing...">checkAndEmitKeysChanged</a>(<span class="keyword">const</span> QStringList &currentKeys, <span class="keyword">const</span> QStringList &oldKeys); +<a name="l00097"></a>00097 +<a name="l00099"></a>00099 <a class="code" href="class_info_backend.html" title="An abstract (pure virtual) singleton class that represents the actual registry backend...">InfoBackend</a>& <a class="code" href="class_info_backend.html#90791486e0755836a52ff3f59279dc95" title="Private operator. Do not use.">operator=</a>(<span class="keyword">const</span> <a class="code" href="class_info_backend.html" title="An abstract (pure virtual) singleton class that represents the actual registry backend...">InfoBackend</a>&); +<a name="l00100"></a>00100 +<a name="l00101"></a><a class="code" href="class_info_backend.html#f56386ab44960a7646b5a2585688c8d8">00101</a> <span class="keyword">static</span> <a class="code" href="class_info_backend.html" title="An abstract (pure virtual) singleton class that represents the actual registry backend...">InfoBackend</a>* <a class="code" href="class_info_backend.html#f56386ab44960a7646b5a2585688c8d8" title="Holds a pointer to the instance of the singelton.">backendInstance</a>; +<a name="l00102"></a>00102 <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_info_backend.html#e8204b17f82806015d23088f8c6776da" title="Called before the application is destroyed.">destroyInstance</a>(); +<a name="l00103"></a>00103 +<a name="l00104"></a><a class="code" href="class_info_backend.html#0fa89bc3c8483b7168bf136420b43fa4">00104</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_info_xml_backend.html" title="Implements the InfoBackend for reading data from a directory with xml files.">InfoXmlBackend</a>; +<a name="l00105"></a><a class="code" href="class_info_backend.html#84aa2becdb5d27499636a31d69e66683">00105</a> <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="class_info_cdb_backend.html" title="Implements the InfoBackend for reading data from a cdb database.">InfoCdbBackend</a>; +<a name="l00106"></a>00106 }; +<a name="l00107"></a>00107 +<a name="l00108"></a>00108 <span class="preprocessor">#endif // INFOBACKEND_H</span> +</pre></div></div> +<hr size="1"><address style="text-align: right;"><small>Generated on Mon Sep 21 16:36:34 2009 for libcontextsubscriber by +<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> |