aboutsummaryrefslogtreecommitdiff
path: root/libcontextprovider/doc/html/class_context_provider_1_1_property_adaptor.html
blob: e63e4e256dded11eff160963f42ea811d262a92d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
<!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>libcontextprovider: ContextProvider::PropertyAdaptor 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&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;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&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespace_context_provider.html">ContextProvider</a>::<a class="el" href="class_context_provider_1_1_property_adaptor.html">PropertyAdaptor</a>
  </div>
</div>
<div class="contents">
<h1>ContextProvider::PropertyAdaptor Class Reference</h1><!-- doxytag: class="ContextProvider::PropertyAdaptor" -->
<p>A DBus adaptor for implementing the org.maemo.contextkit.Property.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="propertyadaptor_8h_source.html">propertyadaptor.h</a>&gt;</code></p>

<p><a href="class_context_provider_1_1_property_adaptor-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Slots</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_provider_1_1_property_adaptor.html#a57254ec356721efde35aa72e36f436c9">Subscribe</a> (const QDBusMessage &amp;msg, QVariantList &amp;values, quint64 &amp;timestamp)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Implementation of the D-Bus method Subscribe.  <a href="#a57254ec356721efde35aa72e36f436c9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_provider_1_1_property_adaptor.html#a0a08d426bbede951c3b45795d6885ab8">Unsubscribe</a> (const QDBusMessage &amp;msg)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Implementation of the D-Bus method Unsubscribe.  <a href="#a0a08d426bbede951c3b45795d6885ab8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_provider_1_1_property_adaptor.html#ae868927e2b3ade9758f5ab50604d7cb9">Get</a> (QVariantList &amp;values, quint64 &amp;timestamp)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Implementation of the D-Bus method Get.  <a href="#ae868927e2b3ade9758f5ab50604d7cb9"></a><br/></td></tr>
<tr><td colspan="2"><h2>Signals</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_provider_1_1_property_adaptor.html#a17f8b6df91329f49291971bdb4397013">ValueChanged</a> (const QVariantList &amp;values, const quint64 &amp;timestamp)</td></tr>
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_provider_1_1_property_adaptor.html#ab97e6529a6949024d0339e907d7835f8">PropertyAdaptor</a> (<a class="el" href="class_context_provider_1_1_property_private.html">PropertyPrivate</a> *property, QDBusConnection *connection)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#ab97e6529a6949024d0339e907d7835f8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_provider_1_1_property_adaptor.html#a660abb2ad421b5f70db4c6a41e8728cf">objectPath</a> () const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Object path where the corresponding <a class="el" href="class_context_provider_1_1_property_private.html" title="The private implementation of Property.">PropertyPrivate</a> object should be registered at.  <a href="#a660abb2ad421b5f70db4c6a41e8728cf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_provider_1_1_property_adaptor.html#af6f3ed4cf800ee36f5fef5231ad49d01">forgetClients</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Called when the service is stopped and will disappear from D-Bus.  <a href="#af6f3ed4cf800ee36f5fef5231ad49d01"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A DBus adaptor for implementing the org.maemo.contextkit.Property. </p>
<p><a class="el" href="class_context_provider_1_1_property_adaptor.html" title="A DBus adaptor for implementing the org.maemo.contextkit.Property.">PropertyAdaptor</a> represents the <a class="el" href="class_context_provider_1_1_property.html" title="A Property object represents a context property, i.e., a key-value pair.">Property</a> object on D-Bus. It also keeps track of its clients and sets the <a class="el" href="class_context_provider_1_1_property_private.html" title="The private implementation of Property.">PropertyPrivate</a> to subscribed or unsubscribed accordingly.</p>
<p><a class="el" href="class_context_provider_1_1_property_adaptor.html" title="A DBus adaptor for implementing the org.maemo.contextkit.Property.">PropertyAdaptor</a> also listens to values sent by other providers on D-Bus and notifies the <a class="el" href="class_context_provider_1_1_property_private.html" title="The private implementation of Property.">PropertyPrivate</a> about them. </p>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ab97e6529a6949024d0339e907d7835f8"></a><!-- doxytag: member="ContextProvider::PropertyAdaptor::PropertyAdaptor" ref="ab97e6529a6949024d0339e907d7835f8" args="(PropertyPrivate *property, QDBusConnection *connection)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ContextProvider::PropertyAdaptor::PropertyAdaptor </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="class_context_provider_1_1_property_private.html">PropertyPrivate</a> *&nbsp;</td>
          <td class="paramname"> <em>propertyPrivate</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">QDBusConnection *&nbsp;</td>
          <td class="paramname"> <em>conn</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Constructor. </p>
<p>Creates new adaptor for the given manager with the given dbus connection. The connection <em>conn</em> is not retained. </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="af6f3ed4cf800ee36f5fef5231ad49d01"></a><!-- doxytag: member="ContextProvider::PropertyAdaptor::forgetClients" ref="af6f3ed4cf800ee36f5fef5231ad49d01" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ContextProvider::PropertyAdaptor::forgetClients </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Called when the service is stopped and will disappear from D-Bus. </p>
<p>If it appears again, the clients will resubscribe, and it shouldn't be a MultipleSubscribe error. Thus, we need to forget the clients when the service is stopped. </p>

</div>
</div>
<a class="anchor" id="ae868927e2b3ade9758f5ab50604d7cb9"></a><!-- doxytag: member="ContextProvider::PropertyAdaptor::Get" ref="ae868927e2b3ade9758f5ab50604d7cb9" args="(QVariantList &amp;values, quint64 &amp;timestamp)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ContextProvider::PropertyAdaptor::Get </td>
          <td>(</td>
          <td class="paramtype">QVariantList &amp;&nbsp;</td>
          <td class="paramname"> <em>values</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">quint64 &amp;&nbsp;</td>
          <td class="paramname"> <em>timestamp</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [slot]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Implementation of the D-Bus method Get. </p>

</div>
</div>
<a class="anchor" id="a660abb2ad421b5f70db4c6a41e8728cf"></a><!-- doxytag: member="ContextProvider::PropertyAdaptor::objectPath" ref="a660abb2ad421b5f70db4c6a41e8728cf" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">QString ContextProvider::PropertyAdaptor::objectPath </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Object path where the corresponding <a class="el" href="class_context_provider_1_1_property_private.html" title="The private implementation of Property.">PropertyPrivate</a> object should be registered at. </p>
<p>For a core propertiy Property.Name (not starting with /), the path is /org/maemo/contextkit/Property/Name. For a non-core property /com/my/property, the object path is /com/my/property. </p>

</div>
</div>
<a class="anchor" id="a57254ec356721efde35aa72e36f436c9"></a><!-- doxytag: member="ContextProvider::PropertyAdaptor::Subscribe" ref="a57254ec356721efde35aa72e36f436c9" args="(const QDBusMessage &amp;msg, QVariantList &amp;values, quint64 &amp;timestamp)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ContextProvider::PropertyAdaptor::Subscribe </td>
          <td>(</td>
          <td class="paramtype">const QDBusMessage &amp;&nbsp;</td>
          <td class="paramname"> <em>msg</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">QVariantList &amp;&nbsp;</td>
          <td class="paramname"> <em>values</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">quint64 &amp;&nbsp;</td>
          <td class="paramname"> <em>timestamp</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [slot]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Implementation of the D-Bus method Subscribe. </p>

</div>
</div>
<a class="anchor" id="a0a08d426bbede951c3b45795d6885ab8"></a><!-- doxytag: member="ContextProvider::PropertyAdaptor::Unsubscribe" ref="a0a08d426bbede951c3b45795d6885ab8" args="(const QDBusMessage &amp;msg)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ContextProvider::PropertyAdaptor::Unsubscribe </td>
          <td>(</td>
          <td class="paramtype">const QDBusMessage &amp;&nbsp;</td>
          <td class="paramname"> <em>msg</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [slot]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Implementation of the D-Bus method Unsubscribe. </p>

</div>
</div>
<a class="anchor" id="a17f8b6df91329f49291971bdb4397013"></a><!-- doxytag: member="ContextProvider::PropertyAdaptor::ValueChanged" ref="a17f8b6df91329f49291971bdb4397013" args="(const QVariantList &amp;values, const quint64 &amp;timestamp)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ContextProvider::PropertyAdaptor::ValueChanged </td>
          <td>(</td>
          <td class="paramtype">const QVariantList &amp;&nbsp;</td>
          <td class="paramname"> <em>values</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const quint64 &amp;&nbsp;</td>
          <td class="paramname"> <em>timestamp</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [signal]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="propertyadaptor_8h_source.html">propertyadaptor.h</a></li>
<li><a class="el" href="propertyadaptor_8cpp.html">propertyadaptor.cpp</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated on Thu Dec 10 16:51:46 2009 for libcontextprovider by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address>
</body>
</html>