diff options
Diffstat (limited to 'libcontextsubscriber/doc/html/provider_8h-source.html')
| -rw-r--r-- | libcontextsubscriber/doc/html/provider_8h-source.html | 125 |
1 files changed, 125 insertions, 0 deletions
diff --git a/libcontextsubscriber/doc/html/provider_8h-source.html b/libcontextsubscriber/doc/html/provider_8h-source.html new file mode 100644 index 00000000..9a09d236 --- /dev/null +++ b/libcontextsubscriber/doc/html/provider_8h-source.html @@ -0,0 +1,125 @@ +<!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: provider.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>provider.h</h1><a href="provider_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, 2009 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 PROVIDER_H</span> +<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define PROVIDER_H</span> +<a name="l00024"></a>00024 <span class="preprocessor"></span> +<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="queuedinvoker_8h.html">queuedinvoker.h</a>"</span> +<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="contextproviderinfo_8h.html">contextproviderinfo.h</a>"</span> +<a name="l00027"></a>00027 +<a name="l00028"></a>00028 <span class="preprocessor">#include <QObject></span> +<a name="l00029"></a>00029 <span class="preprocessor">#include <QDBusConnection></span> +<a name="l00030"></a>00030 <span class="preprocessor">#include <QSet></span> +<a name="l00031"></a>00031 <span class="preprocessor">#include <QMutex></span> +<a name="l00032"></a>00032 <span class="preprocessor">#include <time.h></span> +<a name="l00033"></a>00033 +<a name="l00034"></a>00034 <span class="keyword">class </span><a class="code" href="class_context_property_info.html" title="A class to introspect a context property details.">ContextPropertyInfo</a>; +<a name="l00035"></a>00035 +<a name="l00036"></a>00036 <span class="keyword">namespace </span>ContextSubscriber { +<a name="l00037"></a>00037 +<a name="l00038"></a>00038 <span class="keyword">class </span>PropertyHandle; +<a name="l00039"></a>00039 <span class="keyword">class </span><a class="code" href="class_subscriber_interface.html" title="Proxy class for using the DBus interface org.freedesktop.ContextKit.Subscriber asynchronously...">SubscriberInterface</a>; +<a name="l00040"></a>00040 <span class="keyword">class </span>DBusNameListener; +<a name="l00041"></a>00041 <span class="keyword">class </span>ManagerInterface; +<a name="l00042"></a>00042 <span class="keyword">class </span>IProviderPlugin; +<a name="l00043"></a>00043 +<a name="l00044"></a><a class="code" href="struct_context_subscriber_1_1_timed_value.html">00044</a> <span class="keyword">struct </span><a class="code" href="struct_context_subscriber_1_1_timed_value.html">TimedValue</a> +<a name="l00045"></a>00045 { +<a name="l00046"></a><a class="code" href="struct_context_subscriber_1_1_timed_value.html#960ea0587683d351152c932a8f34c035">00046</a> <span class="keyword">struct </span>timespec <a class="code" href="struct_context_subscriber_1_1_timed_value.html#960ea0587683d351152c932a8f34c035">time</a>; +<a name="l00047"></a><a class="code" href="struct_context_subscriber_1_1_timed_value.html#ec98d0cb5ab101f02685a62fa1e3c6d2">00047</a> QVariant <a class="code" href="struct_context_subscriber_1_1_timed_value.html#ec98d0cb5ab101f02685a62fa1e3c6d2">value</a>; +<a name="l00048"></a>00048 <a class="code" href="struct_context_subscriber_1_1_timed_value.html#37a5bb08705741e6256adc097018dec2">TimedValue</a>(<span class="keyword">const</span> QVariant &<a class="code" href="struct_context_subscriber_1_1_timed_value.html#ec98d0cb5ab101f02685a62fa1e3c6d2">value</a>); +<a name="l00049"></a>00049 <span class="comment">// future bool operator<(const TimedValue &other);</span> +<a name="l00050"></a>00050 }; +<a name="l00051"></a>00051 +<a name="l00052"></a><a class="code" href="class_context_subscriber_1_1_provider.html">00052</a> <span class="keyword">class </span><a class="code" href="class_context_subscriber_1_1_provider.html" title="Connects to a group of properties via the help of a plugin.">Provider</a> : <span class="keyword">public</span> <a class="code" href="class_context_subscriber_1_1_queued_invoker.html" title="A class that can invoke its own methods in a delayed way.">QueuedInvoker</a> +<a name="l00053"></a>00053 { +<a name="l00054"></a>00054 Q_OBJECT +<a name="l00055"></a>00055 +<a name="l00056"></a>00056 <span class="keyword">public</span>: +<a name="l00057"></a>00057 <span class="keyword">static</span> <a class="code" href="class_context_subscriber_1_1_provider.html" title="Connects to a group of properties via the help of a plugin.">Provider</a>* <a class="code" href="class_context_subscriber_1_1_provider.html#cf3f43a824c33ffaf349feeb9c34b5d0" title="Returns a singleton for the named plugin with the constructionString.">instance</a>(<span class="keyword">const</span> <a class="code" href="struct_context_provider_info.html">ContextProviderInfo</a>& <a class="code" href="class_context_subscriber_1_1_provider.html#6e8a91f8a673fb8f2f645212844eb421" title="Parameters used to initialize the plugin.">providerInfo</a>); +<a name="l00058"></a>00058 <span class="keywordtype">bool</span> <a class="code" href="class_context_subscriber_1_1_provider.html#063cf90bfd10f0bca4ed471f2c3a9c1e" title="Schedules a property to be subscribed to.">subscribe</a>(<span class="keyword">const</span> QString &key); +<a name="l00059"></a>00059 <span class="keywordtype">void</span> <a class="code" href="class_context_subscriber_1_1_provider.html#a6aa042d4a006eb0930d7805139e801f" title="Schedules a property to be unsubscribed from when the main loop is entered the next...">unsubscribe</a>(<span class="keyword">const</span> QString &key); +<a name="l00060"></a>00060 <a class="code" href="struct_context_subscriber_1_1_timed_value.html">TimedValue</a> <span class="keyword">get</span>(<span class="keyword">const</span> QString &key) <span class="keyword">const</span>; +<a name="l00061"></a>00061 +<a name="l00062"></a>00062 signals: +<a name="l00063"></a>00063 <span class="keywordtype">void</span> <a class="code" href="class_context_subscriber_1_1_provider.html#cdb674013818463a88ce1799885258be">subscribeFinished</a>(QString key); +<a name="l00064"></a>00064 <span class="keywordtype">void</span> <a class="code" href="class_context_subscriber_1_1_provider.html#6288252eecf25f879ecb7c1a507a9088">valueChanged</a>(QString key); +<a name="l00065"></a>00065 +<a name="l00066"></a>00066 <span class="keyword">private</span> slots: +<a name="l00067"></a>00067 <span class="keywordtype">void</span> <a class="code" href="class_context_subscriber_1_1_provider.html#c87916df512014e5048eda7ae9daf3b9" title="Updates pluginState to READY and requests subscription for the keys that should be...">onPluginReady</a>(); +<a name="l00068"></a>00068 <span class="keywordtype">void</span> <a class="code" href="class_context_subscriber_1_1_provider.html#0b9a9637b9bdd8a3989cfccb14c8a24b" title="Updates pluginState to FAILED and signals subscribeFinished for keys we are trying...">onPluginFailed</a>(QString error); +<a name="l00069"></a>00069 <span class="keywordtype">void</span> <a class="code" href="class_context_subscriber_1_1_provider.html#cbbadf63086f6b37ff9a9e8e64180032" title="Forwards the call to signalSubscribeFinished.">onPluginSubscribeFinished</a>(QString key); +<a name="l00070"></a>00070 <span class="keywordtype">void</span> <a class="code" href="class_context_subscriber_1_1_provider.html#d18a07fdfb76dfa71f15f4b3e1200793" title="Forwards the call to signalSubscribeFinished, after logging a warning.">onPluginSubscribeFailed</a>(QString failedKey, QString error); +<a name="l00071"></a>00071 <span class="keywordtype">void</span> <a class="code" href="class_context_subscriber_1_1_provider.html#c04c071faa737c9b7f029ef0125f6a1c" title="Forwards the newValue for key received from the plugin to the upper layers via HandleSignalRouter...">onPluginValueChanged</a>(QString key, QVariant newValue); +<a name="l00072"></a>00072 +<a name="l00073"></a>00073 <span class="keyword">private</span>: +<a name="l00074"></a><a class="code" href="class_context_subscriber_1_1_provider.html#18f291fc00e50055a02525f70e38a52b142be3c672ac9a6f3fe477b6eeb1acb1">00074</a> <span class="keyword">enum</span> <a class="code" href="class_context_subscriber_1_1_provider.html#18f291fc00e50055a02525f70e38a52b">PluginState</a> { <a class="code" href="class_context_subscriber_1_1_provider.html#18f291fc00e50055a02525f70e38a52b429fabee9e8f6a76d3903db54c76bd46">INITIALIZING</a>, <a class="code" href="class_context_subscriber_1_1_provider.html#18f291fc00e50055a02525f70e38a52b142be3c672ac9a6f3fe477b6eeb1acb1">READY</a>, <a class="code" href="class_context_subscriber_1_1_provider.html#18f291fc00e50055a02525f70e38a52b6c35b4588f19b72888a9fca0b911642f">FAILED</a> }; +<a name="l00075"></a>00075 <a class="code" href="class_context_subscriber_1_1_provider.html#e4221b5f1438404820abee8de2ed3daa" title="Stores the passed plugin name and construction paramater, then moves into the main...">Provider</a>(<span class="keyword">const</span> <a class="code" href="struct_context_provider_info.html">ContextProviderInfo</a>& providerInfo); +<a name="l00076"></a>00076 Q_INVOKABLE <span class="keywordtype">void</span> <a class="code" href="class_context_subscriber_1_1_provider.html#b78d5f8ff72bedb037f1f2b15cbda9b9" title="Executed when the main loop is entered and we have previously scheduled subscriptions...">handleSubscribes</a>(); +<a name="l00077"></a>00077 Q_INVOKABLE <span class="keywordtype">void</span> <a class="code" href="class_context_subscriber_1_1_provider.html#1e2136dc7c4ad62b020c7ed95914bb67" title="Decides which plugin to instantiate based on the plugin passed to the constructor...">constructPlugin</a>(); +<a name="l00078"></a>00078 <span class="keywordtype">void</span> <a class="code" href="class_context_subscriber_1_1_provider.html#3046efee2679aa33602deb4f27877eba" title="The plugin has finished subscribing to a key, signals this fact to the upper layer...">signalSubscribeFinished</a>(QString key); +<a name="l00079"></a>00079 +<a name="l00080"></a><a class="code" href="class_context_subscriber_1_1_provider.html#620db59b31c197b98ee64369fd46b30e">00080</a> <a class="code" href="class_context_subscriber_1_1_i_provider_plugin.html" title="Interface for provider plugins.">IProviderPlugin</a>* <a class="code" href="class_context_subscriber_1_1_provider.html#620db59b31c197b98ee64369fd46b30e" title="Plugin instance communicating with the concrete provider.">plugin</a>; +<a name="l00081"></a><a class="code" href="class_context_subscriber_1_1_provider.html#904cca899aba13b6d356fea73737169e">00081</a> <a class="code" href="class_context_subscriber_1_1_provider.html#18f291fc00e50055a02525f70e38a52b">PluginState</a> <a class="code" href="class_context_subscriber_1_1_provider.html#904cca899aba13b6d356fea73737169e">pluginState</a>; +<a name="l00082"></a><a class="code" href="class_context_subscriber_1_1_provider.html#6e8a91f8a673fb8f2f645212844eb421">00082</a> <a class="code" href="struct_context_provider_info.html">ContextProviderInfo</a> providerInfo; +<a name="l00083"></a>00083 +<a name="l00084"></a><a class="code" href="class_context_subscriber_1_1_provider.html#154fa6041cd471ac46c1038f312ffde6">00084</a> QMutex <a class="code" href="class_context_subscriber_1_1_provider.html#154fa6041cd471ac46c1038f312ffde6">subscribeLock</a>; +<a name="l00085"></a><a class="code" href="class_context_subscriber_1_1_provider.html#cbf130166861d576d906fc99da9b2d6d">00085</a> QSet<QString> <a class="code" href="class_context_subscriber_1_1_provider.html#cbf130166861d576d906fc99da9b2d6d" title="Keys pending for subscription.">toSubscribe</a>; +<a name="l00086"></a><a class="code" href="class_context_subscriber_1_1_provider.html#ee2cca89bff8d2bc65039a42cb32563c">00086</a> QSet<QString> <a class="code" href="class_context_subscriber_1_1_provider.html#ee2cca89bff8d2bc65039a42cb32563c" title="Keys pending for unsubscription.">toUnsubscribe</a>; +<a name="l00087"></a>00087 +<a name="l00088"></a>00088 <span class="comment">// FIXME: rename this to something which contains the word intention in it</span> +<a name="l00089"></a><a class="code" href="class_context_subscriber_1_1_provider.html#6b07417f7e024f8dac5b3b327383dbe9">00089</a> QSet<QString> <a class="code" href="class_context_subscriber_1_1_provider.html#6b07417f7e024f8dac5b3b327383dbe9" title="The keys that should be currently subscribed to.">subscribedKeys</a>; +<a name="l00090"></a>00090 +<a name="l00091"></a><a class="code" href="class_context_subscriber_1_1_provider.html#6e41ed2ec544fc16bd399d8fbcec46ed">00091</a> QMap<QString, TimedValue> <a class="code" href="class_context_subscriber_1_1_provider.html#6e41ed2ec544fc16bd399d8fbcec46ed" title="A cache of values already received from the plugin.">values</a>; +<a name="l00092"></a>00092 }; +<a name="l00093"></a>00093 +<a name="l00094"></a>00094 } <span class="comment">// end namespace</span> +<a name="l00095"></a>00095 +<a name="l00096"></a>00096 <span class="preprocessor">#endif</span> +</pre></div></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> |