libcontextsubscriber/doc/html/contextproperty_8h-source.html


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

<!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: contextproperty.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&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><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&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
    </ul>
  </div>
<h1>contextproperty.h</h1><a href="contextproperty_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 &lt;marius.vollmer@nokia.com&gt;</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 CONTEXTPROPERTY_H</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define CONTEXTPROPERTY_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include &lt;QObject&gt;</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include &lt;QVariant&gt;</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include &lt;QString&gt;</span>
<a name="l00028"></a>00028 
<a name="l00029"></a>00029 <span class="keyword">class </span><a class="code" href="struct_context_property_private.html" title="The private parts of the ContextProperty class.">ContextPropertyPrivate</a>;
<a name="l00030"></a>00030 <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="l00031"></a>00031 
<a name="l00032"></a><a class="code" href="class_context_property.html">00032</a> <span class="keyword">class </span><a class="code" href="class_context_property.html" title="The ContextProperty class allows access to keys and their values.">ContextProperty</a> : <span class="keyword">public</span> QObject
<a name="l00033"></a>00033 {
<a name="l00034"></a>00034     Q_OBJECT
<a name="l00035"></a>00035 
<a name="l00036"></a>00036 <span class="keyword">public</span>:
<a name="l00037"></a>00037     <span class="keyword">explicit</span> <a class="code" href="class_context_property.html#79283034949fe9cf79106b7ea221439a" title="Constructs a new ContextProperty for key and subscribes to it.">ContextProperty</a>(<span class="keyword">const</span> QString &amp;<a class="code" href="class_context_property.html#fc2a01b6895b75e73a049e9143a16a22" title="Returns the key.">key</a>, QObject *parent = 0);
<a name="l00038"></a>00038 
<a name="l00039"></a>00039     <span class="keyword">virtual</span> <a class="code" href="class_context_property.html#ddc93c0539a8ffd2c2c9439e5ccd8628" title="Unsubscribes from the ContextProperty and destroys it.">~ContextProperty</a>();
<a name="l00040"></a>00040 
<a name="l00041"></a>00041     QString <a class="code" href="class_context_property.html#fc2a01b6895b75e73a049e9143a16a22" title="Returns the key.">key</a>() <span class="keyword">const</span>;
<a name="l00042"></a>00042     QVariant <a class="code" href="class_context_property.html#4c295fefdf793557472959f9e2f3e18c" title="Returns the current value.">value</a>(<span class="keyword">const</span> QVariant &amp;def) <span class="keyword">const</span>;
<a name="l00043"></a>00043     QVariant <a class="code" href="class_context_property.html#4c295fefdf793557472959f9e2f3e18c" title="Returns the current value.">value</a>() <span class="keyword">const</span>;
<a name="l00044"></a>00044 
<a name="l00045"></a>00045     <span class="keyword">const</span> <a class="code" href="class_context_property_info.html" title="A class to introspect a context property details.">ContextPropertyInfo</a>* <a class="code" href="class_context_property.html#f5d07cd67b0c7a94d0912900e2729cbb" title="Returns the metadata about this property, please refer to Introspection for details...">info</a>() <span class="keyword">const</span>;
<a name="l00046"></a>00046 
<a name="l00047"></a>00047     <span class="keywordtype">void</span> <a class="code" href="class_context_property.html#5e6f52ce5ba6e7d07240ce84c2cc7326" title="Starts subscribtion to the context property, if it isn&amp;#39;t subscribed already.">subscribe</a> () <span class="keyword">const</span>;
<a name="l00048"></a>00048     <span class="keywordtype">void</span> <a class="code" href="class_context_property.html#fa0ef21efe3c1c5d2b5936cda8feb350" title="Unsubscribes from the context property, if it is currently subscribed.">unsubscribe</a> () <span class="keyword">const</span>;
<a name="l00049"></a>00049 
<a name="l00050"></a>00050     <span class="keywordtype">void</span> <a class="code" href="class_context_property.html#8377eacd97cfccf349b7167f33414888" title="Suspends the execution of the current thread until subcription is complete for this...">waitForSubscription</a> () <span class="keyword">const</span>;
<a name="l00051"></a>00051 
<a name="l00052"></a>00052     <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_context_property.html#8654f1a0b2e6e3e58d6fc2830a5fbb8b" title="Sets all of the ContextProperty instances immune to &amp;#39;external commanding&amp;#39;...">ignoreCommander</a>();
<a name="l00053"></a>00053     <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code" href="class_context_property.html#47a70ecc83ea7b819728a3430d860100" title="Enables or disables all of the ContextProperty instances&amp;#39; type-check feature...">setTypeCheck</a>(<span class="keywordtype">bool</span> typeCheck);
<a name="l00054"></a>00054 
<a name="l00055"></a>00055 signals:
<a name="l00056"></a>00056     <span class="keywordtype">void</span> <a class="code" href="class_context_property.html#dee3726fee9fbbcb92c7fb3ba2e04c49" title="Emitted whenever the value of the property changes and the property is subscribed...">valueChanged</a>(); 
<a name="l00057"></a>00057 
<a name="l00058"></a>00058 <span class="keyword">private</span>:
<a name="l00059"></a><a class="code" href="class_context_property.html#de52af7df11f1b01893f99aef56ecd10">00059</a>     <a class="code" href="struct_context_property_private.html" title="The private parts of the ContextProperty class.">ContextPropertyPrivate</a> *<a class="code" href="class_context_property.html#de52af7df11f1b01893f99aef56ecd10">priv</a>;
<a name="l00060"></a>00060 };
<a name="l00061"></a>00061 
<a name="l00062"></a>00062 <span class="preprocessor">#endif</span>
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Wed Sep 30 10:24:18 2009 for libcontextsubscriber by&nbsp;
<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>