← Back to branch summary

~ubuntu-branches/ubuntu/quantal/colord/quantal-proposed

« back to all changes in this revision

Viewing changes to doc/api/html/Sensor.html

  • Committer: Package Import Robot
  • Author(s): Sjoerd Simons
  • Date: 2011-10-25 16:21:20 UTC
  • mto: (2.1.1 sid) (1.1.2)
  • mto: This revision was merged to the branch mainline in revision 8.
  • Revision ID: package-import@ubuntu.com-20111025162120-0aypjqn1zx9n6vgf
Tags: upstream-0.1.13
Import upstream version 0.1.13

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/api/html/Sensor.html
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html>
3
 
<head>
4
 
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>org.freedesktop.ColorManager.Sensor</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7
 
<link rel="home" href="index.html" title="colord Reference Manual">
8
 
<link rel="up" href="ref-dbus.html" title="D-Bus API Reference">
9
 
<link rel="prev" href="Profile.html" title="org.freedesktop.ColorManager.Profile">
10
 
<link rel="next" href="libcolord.html" title="libcolord GObjects">
11
 
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
12
 
<link rel="stylesheet" href="style.css" type="text/css">
13
 
</head>
14
 
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
 
<tr valign="middle">
17
 
<td><a accesskey="p" href="Profile.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
 
<td><a accesskey="u" href="ref-dbus.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
 
<th width="100%" align="center">colord Reference Manual</th>
21
 
<td><a accesskey="n" href="libcolord.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
 
</tr>
23
 
<tr><td colspan="5" class="shortcuts">
24
 
<a href="#Sensor.synopsis" class="shortcut">Top</a>
25
 
                   | 
26
 
                  <a href="#Sensor.description" class="shortcut">Description</a>
27
 
                   | 
28
 
                  <a href="#Sensor.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
29
 
                   | 
30
 
                  <a href="#Sensor.properties" class="shortcut">Properties</a>
31
 
                   | 
32
 
                  <a href="#Sensor.signals" class="shortcut">Signals</a>
33
 
</td></tr>
34
 
</table>
35
 
<div class="refentry">
36
 
<a name="Sensor"></a><div class="titlepage"></div>
37
 
<div class="refnamediv"><table width="100%"><tr>
38
 
<td valign="top">
39
 
<h2><span class="refentrytitle">org.freedesktop.ColorManager.Sensor</span></h2>
40
 
<p>org.freedesktop.ColorManager.Sensor — Sensor interface</p>
41
 
</td>
42
 
<td valign="top" align="right"></td>
43
 
</tr></table></div>
44
 
<div class="refsynopsisdiv">
45
 
<h2>Methods</h2>
46
 
<pre class="synopsis"><a class="link" href="Sensor.html#Sensor.Lock">Lock</a>      ()
47
 
<a class="link" href="Sensor.html#Sensor.Unlock">Unlock</a>    ()
48
 
<a class="link" href="Sensor.html#Sensor.GetSample">GetSample</a> (in  's' capability,
49
 
           out 'd' sample_x,
50
 
           out 'd' sample_y,
51
 
           out 'd' sample_z)
52
 
</pre>
53
 
</div>
54
 
<div class="refsect1">
55
 
<a name="id509205"></a><h2>Signals</h2>
56
 
<pre class="synopsis"><a class="link" href="Sensor.html#Sensor::ButtonPressed">ButtonPressed</a> ()
57
 
</pre>
58
 
</div>
59
 
<div class="refsect1">
60
 
<a name="id509092"></a><h2>Implemented Interfaces</h2>
61
 
<p>
62
 
    Objects implementing org.freedesktop.ColorManager.Sensor also implements
63
 
    org.freedesktop.DBus.Introspectable,
64
 
    org.freedesktop.DBus.Properties
65
 
    </p>
66
 
</div>
67
 
<div class="refsect1">
68
 
<a name="id513769"></a><h2>Properties</h2>
69
 
<pre class="synopsis"><a class="link" href="Sensor.html#Sensor:Kind">'Kind'</a>         read      's'
70
 
<a class="link" href="Sensor.html#Sensor:State">'State'</a>        read      's'
71
 
<a class="link" href="Sensor.html#Sensor:Mode">'Mode'</a>         read      's'
72
 
<a class="link" href="Sensor.html#Sensor:Serial">'Serial'</a>       read      's'
73
 
<a class="link" href="Sensor.html#Sensor:Model">'Model'</a>        read      's'
74
 
<a class="link" href="Sensor.html#Sensor:Vendor">'Vendor'</a>       read      's'
75
 
<a class="link" href="Sensor.html#Sensor:Native">'Native'</a>       read      'b'
76
 
<a class="link" href="Sensor.html#Sensor:Locked">'Locked'</a>       read      'b'
77
 
<a class="link" href="Sensor.html#Sensor:Capabilities">'Capabilities'</a> read      'as'
78
 
</pre>
79
 
</div>
80
 
<div class="refsect1">
81
 
<a name="id515013"></a><h2>Description</h2>
82
 
<p>
83
 
      
84
 
        </p>
85
 
<p>
86
 
          The interface used for quering color sensors.
87
 
        </p>
88
 
<p>
89
 
      
90
 
    </p>
91
 
</div>
92
 
<div class="refsect1">
93
 
<a name="id536714"></a><h2>Details</h2>
94
 
<div class="refsect2">
95
 
<a name="id536722"></a><h3>
96
 
<a name="Sensor.Lock"></a>Lock ()</h3>
97
 
<pre class="programlisting">Lock ()</pre>
98
 
</div>
99
 
<p>
100
 
            Locks the sensor for use by an application.
101
 
          </p>
102
 
<p>
103
 
            If the current holder of the lock quits without calling
104
 
            <code class="literal">Unlock</code> then it is automatically removed.
105
 
          </p>
106
 
<div class="variablelist"><table border="0">
107
 
<col align="left" valign="top">
108
 
<tbody></tbody>
109
 
</table></div>
110
 
<hr>
111
 
<div class="refsect2">
112
 
<a name="id536761"></a><h3>
113
 
<a name="Sensor.Unlock"></a>Unlock ()</h3>
114
 
<pre class="programlisting">Unlock ()</pre>
115
 
</div>
116
 
<p>
117
 
            Unlocks the sensor for use by other applications.
118
 
          </p>
119
 
<div class="variablelist"><table border="0">
120
 
<col align="left" valign="top">
121
 
<tbody></tbody>
122
 
</table></div>
123
 
<hr>
124
 
<div class="refsect2">
125
 
<a name="id514538"></a><h3>
126
 
<a name="Sensor.GetSample"></a>GetSample ()</h3>
127
 
<pre class="programlisting">GetSample (in  's' capability,
128
 
           out 'd' sample_x,
129
 
           out 'd' sample_y,
130
 
           out 'd' sample_z)</pre>
131
 
</div>
132
 
<p>
133
 
            Gets a color sample using the sensor.
134
 
          </p>
135
 
<div class="variablelist"><table border="0">
136
 
<col align="left" valign="top">
137
 
<tbody>
138
 
<tr>
139
 
<td><p><span class="term"><em class="parameter"><code>capability</code></em>:</span></p></td>
140
 
<td>
141
 
            <p>
142
 
              The capability we are using, e.g. <code class="literal">crt</code>,
143
 
              <code class="literal">ambient</code>, <code class="literal">lcd</code> or
144
 
              <code class="literal">projector</code>.
145
 
            </p>
146
 
          </td>
147
 
</tr>
148
 
<tr>
149
 
<td><p><span class="term"><em class="parameter"><code>sample_x</code></em>:</span></p></td>
150
 
<td>
151
 
            <p>
152
 
              The X value, or <code class="literal">-1.0</code> for an error.
153
 
            </p>
154
 
            <p>
155
 
              For the capability of <code class="literal">ambient</code> this is
156
 
              the brightness in Lux.
157
 
            </p>
158
 
          </td>
159
 
</tr>
160
 
<tr>
161
 
<td><p><span class="term"><em class="parameter"><code>sample_y</code></em>:</span></p></td>
162
 
<td>
163
 
            <p>
164
 
              The Y value, or <code class="literal">-1.0</code> for an error.
165
 
            </p>
166
 
          </td>
167
 
</tr>
168
 
<tr>
169
 
<td><p><span class="term"><em class="parameter"><code>sample_z</code></em>:</span></p></td>
170
 
<td>
171
 
            <p>
172
 
              The Z value, or <code class="literal">-1.0</code> for an error.
173
 
            </p>
174
 
          </td>
175
 
</tr>
176
 
</tbody>
177
 
</table></div>
178
 
</div>
179
 
<div class="refsect1">
180
 
<a name="id463521"></a><h2>Signal Details</h2>
181
 
<div class="refsect2">
182
 
<a name="id463529"></a><h3>
183
 
<a name="Sensor::ButtonPressed"></a>The ButtonPressed signal</h3>
184
 
<pre class="programlisting">ButtonPressed ()</pre>
185
 
</div>
186
 
<p>
187
 
            A button on the sensor has been pressed.
188
 
          </p>
189
 
<div class="variablelist"><table border="0">
190
 
<col align="left" valign="top">
191
 
<tbody></tbody>
192
 
</table></div>
193
 
</div>
194
 
<div class="refsect1">
195
 
<a name="id463561"></a><h2>Property Details</h2>
196
 
<div class="refsect2">
197
 
<a name="id463569"></a><h3>
198
 
<a name="Sensor:Kind"></a>The "Kind" property</h3>
199
 
<pre class="programlisting">'Kind'  read      's'
200
 
</pre>
201
 
</div>
202
 
<p>
203
 
            The kind of the sensor, e.g. <code class="literal">colormunki</code>
204
 
          </p>
205
 
<div class="variablelist"><table border="0">
206
 
<col align="left" valign="top">
207
 
<tbody></tbody>
208
 
</table></div>
209
 
<hr>
210
 
<div class="refsect2">
211
 
<a name="id542866"></a><h3>
212
 
<a name="Sensor:State"></a>The "State" property</h3>
213
 
<pre class="programlisting">'State'  read      's'
214
 
</pre>
215
 
</div>
216
 
<p>
217
 
            The state of the sensor, e.g. <code class="literal">starting</code>,
218
 
            <code class="literal">idle</code> or <code class="literal">measuring</code>.
219
 
          </p>
220
 
<div class="variablelist"><table border="0">
221
 
<col align="left" valign="top">
222
 
<tbody></tbody>
223
 
</table></div>
224
 
<hr>
225
 
<div class="refsect2">
226
 
<a name="id542915"></a><h3>
227
 
<a name="Sensor:Mode"></a>The "Mode" property</h3>
228
 
<pre class="programlisting">'Mode'  read      's'
229
 
</pre>
230
 
</div>
231
 
<p>
232
 
            The operating mode of the sensor, e.g. <code class="literal">ambient</code>,
233
 
            <code class="literal">printer</code> or <code class="literal">unknown</code>.
234
 
          </p>
235
 
<p>
236
 
            On some devices, a sensor has to be set to a specific
237
 
            position before a reading can be taken.
238
 
            This property should be set to the current device mode.
239
 
          </p>
240
 
<div class="variablelist"><table border="0">
241
 
<col align="left" valign="top">
242
 
<tbody></tbody>
243
 
</table></div>
244
 
<hr>
245
 
<div class="refsect2">
246
 
<a name="id542968"></a><h3>
247
 
<a name="Sensor:Serial"></a>The "Serial" property</h3>
248
 
<pre class="programlisting">'Serial'  read      's'
249
 
</pre>
250
 
</div>
251
 
<p>
252
 
            The sensor serial number, e.g. <code class="literal">012345678a</code>.
253
 
          </p>
254
 
<div class="variablelist"><table border="0">
255
 
<col align="left" valign="top">
256
 
<tbody></tbody>
257
 
</table></div>
258
 
<hr>
259
 
<div class="refsect2">
260
 
<a name="id543004"></a><h3>
261
 
<a name="Sensor:Model"></a>The "Model" property</h3>
262
 
<pre class="programlisting">'Model'  read      's'
263
 
</pre>
264
 
</div>
265
 
<p>
266
 
            The sensor model, e.g. <code class="literal">ColorMunki</code>.
267
 
          </p>
268
 
<div class="variablelist"><table border="0">
269
 
<col align="left" valign="top">
270
 
<tbody></tbody>
271
 
</table></div>
272
 
<hr>
273
 
<div class="refsect2">
274
 
<a name="id543041"></a><h3>
275
 
<a name="Sensor:Vendor"></a>The "Vendor" property</h3>
276
 
<pre class="programlisting">'Vendor'  read      's'
277
 
</pre>
278
 
</div>
279
 
<p>
280
 
            The sensor vendor, e.g. <code class="literal">XRite</code>.
281
 
          </p>
282
 
<div class="variablelist"><table border="0">
283
 
<col align="left" valign="top">
284
 
<tbody></tbody>
285
 
</table></div>
286
 
<hr>
287
 
<div class="refsect2">
288
 
<a name="id543078"></a><h3>
289
 
<a name="Sensor:Native"></a>The "Native" property</h3>
290
 
<pre class="programlisting">'Native'  read      'b'
291
 
</pre>
292
 
</div>
293
 
<p>
294
 
            If the sensor is supported with a native driver, which does
295
 
            not require additional tools such as argyllcms.
296
 
          </p>
297
 
<div class="variablelist"><table border="0">
298
 
<col align="left" valign="top">
299
 
<tbody></tbody>
300
 
</table></div>
301
 
<hr>
302
 
<div class="refsect2">
303
 
<a name="id543110"></a><h3>
304
 
<a name="Sensor:Locked"></a>The "Locked" property</h3>
305
 
<pre class="programlisting">'Locked'  read      'b'
306
 
</pre>
307
 
</div>
308
 
<p>
309
 
            If the sensor is locked for use by colord.
310
 
          </p>
311
 
<div class="variablelist"><table border="0">
312
 
<col align="left" valign="top">
313
 
<tbody></tbody>
314
 
</table></div>
315
 
<hr>
316
 
<div class="refsect2">
317
 
<a name="id543140"></a><h3>
318
 
<a name="Sensor:Capabilities"></a>The "Capabilities" property</h3>
319
 
<pre class="programlisting">'Capabilities'  read      'as'
320
 
</pre>
321
 
</div>
322
 
<p>
323
 
            The capabilities of the sensor, e.g <code class="literal">['display',
324
 
            'printer', 'projector', 'spot']</code>.
325
 
          </p>
326
 
<div class="variablelist"><table border="0">
327
 
<col align="left" valign="top">
328
 
<tbody></tbody>
329
 
</table></div>
330
 
</div>
331
 
</div>
332
 
<div class="footer">
333
 
<hr>
334
 
          Generated by GTK-Doc V1.17</div>
335
 
</body>
336
 
</html>
 
 
b'\\ No newline at end of file'