diff options
Diffstat (limited to 'libcontextprovider/doc/html/class_context_provider_1_1_property.html')
| -rw-r--r-- | libcontextprovider/doc/html/class_context_provider_1_1_property.html | 323 |
1 files changed, 323 insertions, 0 deletions
diff --git a/libcontextprovider/doc/html/class_context_provider_1_1_property.html b/libcontextprovider/doc/html/class_context_provider_1_1_property.html new file mode 100644 index 00000000..cead0568 --- /dev/null +++ b/libcontextprovider/doc/html/class_context_provider_1_1_property.html @@ -0,0 +1,323 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> +<title>libcontextprovider: ContextProvider::Property 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 class="navpath"><a class="el" href="namespace_context_provider.html">ContextProvider</a>::<a class="el" href="class_context_provider_1_1_property.html">Property</a> + </div> +</div> +<div class="contents"> +<h1>ContextProvider::Property Class Reference</h1><!-- doxytag: class="ContextProvider::Property" -->A <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 represents a context property, i.e., a key-value pair. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="property_8h-source.html">ContextProvider</a>></code> +<p> + +<p> +<a href="class_context_provider_1_1_property-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_context_provider_1_1_property.html#edb511bfc215c2933193d5685c574943">firstSubscriberAppeared</a> (const QString &key)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">This is emitted when the first subscriber appears for this <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>. <a href="#edb511bfc215c2933193d5685c574943"></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_context_provider_1_1_property.html#586f7dff49a3c4536acc289c314586ee">lastSubscriberDisappeared</a> (const QString &key)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">This is emitted when the last subscriber disappears for this <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>. <a href="#586f7dff49a3c4536acc289c314586ee"></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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_provider_1_1_property.html#8b66e2cb81aca7f0162a51bb0e9c93f5">Property</a> (<a class="el" href="class_context_provider_1_1_service.html">Service</a> &service, const QString &key, QObject *parent=0)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a <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 <em>service</em> for the key <em>k</em>. <a href="#8b66e2cb81aca7f0162a51bb0e9c93f5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_provider_1_1_property.html#62299c267b73e990a03faf3113445f9e">Property</a> (const QString &key, QObject *parent=0)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a <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 the default service for the key <em>k</em>. <a href="#62299c267b73e990a03faf3113445f9e"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_provider_1_1_property.html#3c5fbb4b6f0ce1f779c2bfa6190ed8d2">~Property</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#3c5fbb4b6f0ce1f779c2bfa6190ed8d2"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_provider_1_1_property.html#b88d712808775617a9839523c537afcb">key</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the key this <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> represents. <a href="#b88d712808775617a9839523c537afcb"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_provider_1_1_property.html#cd83fed5c066aa375148738744e5b3e3">isSet</a> () const </td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the key is set (it's value is determined). <a href="#cd83fed5c066aa375148738744e5b3e3"></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_context_provider_1_1_property.html#44c5ff15b11d53d2a44bc77cacb41314">setValue</a> (const QVariant &v)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the property value to QVariant <em>v</em>. <a href="#44c5ff15b11d53d2a44bc77cacb41314"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">QVariant </td><td class="memItemRight" valign="bottom"><a class="el" href="class_context_provider_1_1_property.html#f05d9adb2b2ee2a5d66e6a9875ccd167">value</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current value of the property. <a href="#f05d9adb2b2ee2a5d66e6a9875ccd167"></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_context_provider_1_1_property.html#a65dc7374559b7a7d86034b8c9ef9807">unsetValue</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Unsets the value. <a href="#a65dc7374559b7a7d86034b8c9ef9807"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +A <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 represents a context property, i.e., a key-value pair. +<p> +Each <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 is associated with a <a class="el" href="class_context_provider_1_1_service.html" title="A Service object is a proxy representing a service on D-Bus that implements the ContextKit...">Service</a> object at construction time. <hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="8b66e2cb81aca7f0162a51bb0e9c93f5"></a><!-- doxytag: member="ContextProvider::Property::Property" ref="8b66e2cb81aca7f0162a51bb0e9c93f5" args="(Service &service, const QString &key, QObject *parent=0)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ContextProvider::Property::Property </td> + <td>(</td> + <td class="paramtype"><a class="el" href="class_context_provider_1_1_service.html">Service</a> & </td> + <td class="paramname"> <em>service</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>key</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">QObject * </td> + <td class="paramname"> <em>parent</em> = <code>0</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [explicit]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Create a <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 <em>service</em> for the key <em>k</em>. +<p> + +</div> +</div><p> +<a class="anchor" name="62299c267b73e990a03faf3113445f9e"></a><!-- doxytag: member="ContextProvider::Property::Property" ref="62299c267b73e990a03faf3113445f9e" args="(const QString &key, QObject *parent=0)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ContextProvider::Property::Property </td> + <td>(</td> + <td class="paramtype">const QString & </td> + <td class="paramname"> <em>k</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">QObject * </td> + <td class="paramname"> <em>parent</em> = <code>0</code></td><td> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td><td><code> [explicit]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Create a <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 the default service for the key <em>k</em>. +<p> +The default service can be set with <a class="el" href="class_context_provider_1_1_service.html#385b58aef7878b6e33a3989d139f9a4a" title="Sets the Service object as the default one to use when constructing Property objects...">Service::setAsDefault()</a>. +</div> +</div><p> +<a class="anchor" name="3c5fbb4b6f0ce1f779c2bfa6190ed8d2"></a><!-- doxytag: member="ContextProvider::Property::~Property" ref="3c5fbb4b6f0ce1f779c2bfa6190ed8d2" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">ContextProvider::Property::~Property </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td><code> [virtual]</code></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Destructor. +<p> + +</div> +</div><p> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="edb511bfc215c2933193d5685c574943"></a><!-- doxytag: member="ContextProvider::Property::firstSubscriberAppeared" ref="edb511bfc215c2933193d5685c574943" args="(const QString &key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextProvider::Property::firstSubscriberAppeared </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> +This is emitted when the first subscriber appears for this <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>. +<p> +It can be used e.g. to start the actual process of harvesting the data needed for this <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>. +</div> +</div><p> +<a class="anchor" name="cd83fed5c066aa375148738744e5b3e3"></a><!-- doxytag: member="ContextProvider::Property::isSet" ref="cd83fed5c066aa375148738744e5b3e3" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">bool ContextProvider::Property::isSet </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns true if the key is set (it's value is determined). +<p> + +</div> +</div><p> +<a class="anchor" name="b88d712808775617a9839523c537afcb"></a><!-- doxytag: member="ContextProvider::Property::key" ref="b88d712808775617a9839523c537afcb" args="() const " --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QString ContextProvider::Property::key </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td> const</td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the name of the key this <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> represents. +<p> + +</div> +</div><p> +<a class="anchor" name="586f7dff49a3c4536acc289c314586ee"></a><!-- doxytag: member="ContextProvider::Property::lastSubscriberDisappeared" ref="586f7dff49a3c4536acc289c314586ee" args="(const QString &key)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextProvider::Property::lastSubscriberDisappeared </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> +This is emitted when the last subscriber disappears for this <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>. +<p> +It can be used e.g. to stop the process of harvesting the data needed for this <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> (and save resources). +</div> +</div><p> +<a class="anchor" name="44c5ff15b11d53d2a44bc77cacb41314"></a><!-- doxytag: member="ContextProvider::Property::setValue" ref="44c5ff15b11d53d2a44bc77cacb41314" args="(const QVariant &v)" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextProvider::Property::setValue </td> + <td>(</td> + <td class="paramtype">const QVariant & </td> + <td class="paramname"> <em>v</em> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Sets the property value to QVariant <em>v</em>. +<p> + +</div> +</div><p> +<a class="anchor" name="a65dc7374559b7a7d86034b8c9ef9807"></a><!-- doxytag: member="ContextProvider::Property::unsetValue" ref="a65dc7374559b7a7d86034b8c9ef9807" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void ContextProvider::Property::unsetValue </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Unsets the value. +<p> +This is equivalent to setting it to a null QVariant. +</div> +</div><p> +<a class="anchor" name="f05d9adb2b2ee2a5d66e6a9875ccd167"></a><!-- doxytag: member="ContextProvider::Property::value" ref="f05d9adb2b2ee2a5d66e6a9875ccd167" args="()" --> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">QVariant ContextProvider::Property::value </td> + <td>(</td> + <td class="paramname"> </td> + <td> ) </td> + <td></td> + </tr> + </table> +</div> +<div class="memdoc"> + +<p> +Returns the current value of the property. +<p> +The returned QVariant is invalid if the key value is undetermined or 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> is invalid. +</div> +</div><p> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="property_8h-source.html">property.h</a><li><a class="el" href="property_8cpp.html">property.cpp</a></ul> +</div> +<hr size="1"><address style="text-align: right;"><small>Generated on Wed Sep 30 10:23:55 2009 for libcontextprovider 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> |