← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/api/html/Profile.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/Profile.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.Profile</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="Device.html" title="org.freedesktop.ColorManager.Device">
10
 
<link rel="next" href="Sensor.html" title="org.freedesktop.ColorManager.Sensor">
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="Device.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="Sensor.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="#Profile.synopsis" class="shortcut">Top</a>
25
 
                   | 
26
 
                  <a href="#Profile.description" class="shortcut">Description</a>
27
 
                   | 
28
 
                  <a href="#Profile.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
29
 
                   | 
30
 
                  <a href="#Profile.properties" class="shortcut">Properties</a>
31
 
                   | 
32
 
                  <a href="#Profile.signals" class="shortcut">Signals</a>
33
 
</td></tr>
34
 
</table>
35
 
<div class="refentry">
36
 
<a name="Profile"></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.Profile</span></h2>
40
 
<p>org.freedesktop.ColorManager.Profile — Profile 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="Profile.html#Profile.SetProperty">SetProperty</a>       (in  's' property_name,
47
 
                   in  's' property_value)
48
 
<a class="link" href="Profile.html#Profile.InstallSystemWide">InstallSystemWide</a> ()
49
 
</pre>
50
 
</div>
51
 
<div class="refsect1">
52
 
<a name="id541563"></a><h2>Signals</h2>
53
 
<pre class="synopsis"><a class="link" href="Profile.html#Profile::Changed">Changed</a> ()
54
 
</pre>
55
 
</div>
56
 
<div class="refsect1">
57
 
<a name="id541388"></a><h2>Implemented Interfaces</h2>
58
 
<p>
59
 
    Objects implementing org.freedesktop.ColorManager.Profile also implements
60
 
    org.freedesktop.DBus.Introspectable,
61
 
    org.freedesktop.DBus.Properties
62
 
    </p>
63
 
</div>
64
 
<div class="refsect1">
65
 
<a name="id513359"></a><h2>Properties</h2>
66
 
<pre class="synopsis"><a class="link" href="Profile.html#Profile:ProfileId">'ProfileId'</a>    read      's'
67
 
<a class="link" href="Profile.html#Profile:Title">'Title'</a>        read      's'
68
 
<a class="link" href="Profile.html#Profile:Metadata">'Metadata'</a>     read      'a{ss}'
69
 
<a class="link" href="Profile.html#Profile:Qualifier">'Qualifier'</a>    read      's'
70
 
<a class="link" href="Profile.html#Profile:Format">'Format'</a>       read      's'
71
 
<a class="link" href="Profile.html#Profile:Kind">'Kind'</a>         read      's'
72
 
<a class="link" href="Profile.html#Profile:Colorspace">'Colorspace'</a>   read      's'
73
 
<a class="link" href="Profile.html#Profile:HasVcgt">'HasVcgt'</a>      read      'b'
74
 
<a class="link" href="Profile.html#Profile:IsSystemWide">'IsSystemWide'</a> read      'b'
75
 
<a class="link" href="Profile.html#Profile:Filename">'Filename'</a>     read      's'
76
 
<a class="link" href="Profile.html#Profile:Created">'Created'</a>      read      'x'
77
 
<a class="link" href="Profile.html#Profile:Scope">'Scope'</a>        read      's'
78
 
</pre>
79
 
</div>
80
 
<div class="refsect1">
81
 
<a name="id513672"></a><h2>Description</h2>
82
 
<p>
83
 
      
84
 
        </p>
85
 
<p>
86
 
          The interface used for quering color profiles.
87
 
        </p>
88
 
<p>
89
 
      
90
 
    </p>
91
 
</div>
92
 
<div class="refsect1">
93
 
<a name="id523862"></a><h2>Details</h2>
94
 
<div class="refsect2">
95
 
<a name="id523870"></a><h3>
96
 
<a name="Profile.SetProperty"></a>SetProperty ()</h3>
97
 
<pre class="programlisting">SetProperty (in  's' property_name,
98
 
             in  's' property_value)</pre>
99
 
</div>
100
 
<p>
101
 
            Sets a property on the object.
102
 
          </p>
103
 
<div class="variablelist"><table border="0">
104
 
<col align="left" valign="top">
105
 
<tbody>
106
 
<tr>
107
 
<td><p><span class="term"><em class="parameter"><code>property_name</code></em>:</span></p></td>
108
 
<td>
109
 
            <p>
110
 
              The property name, e.g. <code class="literal">Filename</code>,
111
 
              or <code class="literal">Qualifier</code>.
112
 
            </p>
113
 
          </td>
114
 
</tr>
115
 
<tr>
116
 
<td><p><span class="term"><em class="parameter"><code>property_value</code></em>:</span></p></td>
117
 
<td>
118
 
            <p>
119
 
              The property value, e.g. <code class="literal">RGB.Plain.</code>.
120
 
            </p>
121
 
          </td>
122
 
</tr>
123
 
</tbody>
124
 
</table></div>
125
 
<hr>
126
 
<div class="refsect2">
127
 
<a name="id524497"></a><h3>
128
 
<a name="Profile.InstallSystemWide"></a>InstallSystemWide ()</h3>
129
 
<pre class="programlisting">InstallSystemWide ()</pre>
130
 
</div>
131
 
<p>
132
 
            Copies the profile system-wide so it can be used by all
133
 
            users on the system or when no users are logged-in.
134
 
          </p>
135
 
<div class="variablelist"><table border="0">
136
 
<col align="left" valign="top">
137
 
<tbody></tbody>
138
 
</table></div>
139
 
</div>
140
 
<div class="refsect1">
141
 
<a name="id524531"></a><h2>Signal Details</h2>
142
 
<div class="refsect2">
143
 
<a name="id507159"></a><h3>
144
 
<a name="Profile::Changed"></a>The Changed signal</h3>
145
 
<pre class="programlisting">Changed ()</pre>
146
 
</div>
147
 
<p>
148
 
            Some value on the interface has changed.
149
 
          </p>
150
 
<div class="variablelist"><table border="0">
151
 
<col align="left" valign="top">
152
 
<tbody></tbody>
153
 
</table></div>
154
 
</div>
155
 
<div class="refsect1">
156
 
<a name="id507191"></a><h2>Property Details</h2>
157
 
<div class="refsect2">
158
 
<a name="id507199"></a><h3>
159
 
<a name="Profile:ProfileId"></a>The "ProfileId" property</h3>
160
 
<pre class="programlisting">'ProfileId'  read      's'
161
 
</pre>
162
 
</div>
163
 
<p>
164
 
            The identification hash of the profile.
165
 
          </p>
166
 
<div class="variablelist"><table border="0">
167
 
<col align="left" valign="top">
168
 
<tbody></tbody>
169
 
</table></div>
170
 
<hr>
171
 
<div class="refsect2">
172
 
<a name="id507229"></a><h3>
173
 
<a name="Profile:Title"></a>The "Title" property</h3>
174
 
<pre class="programlisting">'Title'  read      's'
175
 
</pre>
176
 
</div>
177
 
<p>
178
 
            The printable title for the profile.
179
 
          </p>
180
 
<div class="variablelist"><table border="0">
181
 
<col align="left" valign="top">
182
 
<tbody></tbody>
183
 
</table></div>
184
 
<hr>
185
 
<div class="refsect2">
186
 
<a name="id507259"></a><h3>
187
 
<a name="Profile:Metadata"></a>The "Metadata" property</h3>
188
 
<pre class="programlisting">'Metadata'  read      'a{ss}'
189
 
</pre>
190
 
</div>
191
 
<p>
192
 
            The metadata for the profile, which may include optional
193
 
            keys like <code class="literal">EDID_md5</code> and
194
 
            <code class="literal">EDID_manufacturer</code> that are set by several
195
 
            CMS frameworks.
196
 
          </p>
197
 
<div class="variablelist"><table border="0">
198
 
<col align="left" valign="top">
199
 
<tbody></tbody>
200
 
</table></div>
201
 
<hr>
202
 
<div class="refsect2">
203
 
<a name="id505934"></a><h3>
204
 
<a name="Profile:Qualifier"></a>The "Qualifier" property</h3>
205
 
<pre class="programlisting">'Qualifier'  read      's'
206
 
</pre>
207
 
</div>
208
 
<p>
209
 
            The qualifier for the profile.
210
 
            A qualifier is used as a way to select a profile for a device.
211
 
            This might be something free text like
212
 
            <code class="literal">High quality studio</code>doc:tt&gt; or something more
213
 
            programmable like <code class="literal">RGB.Plain.300dpi</code>.
214
 
          </p>
215
 
<div class="variablelist"><table border="0">
216
 
<col align="left" valign="top">
217
 
<tbody></tbody>
218
 
</table></div>
219
 
<hr>
220
 
<div class="refsect2">
221
 
<a name="id505978"></a><h3>
222
 
<a name="Profile:Format"></a>The "Format" property</h3>
223
 
<pre class="programlisting">'Format'  read      's'
224
 
</pre>
225
 
</div>
226
 
<p>
227
 
            The qualifier format for the profile.
228
 
          </p>
229
 
<div class="variablelist"><table border="0">
230
 
<col align="left" valign="top">
231
 
<tbody></tbody>
232
 
</table></div>
233
 
<hr>
234
 
<div class="refsect2">
235
 
<a name="id506009"></a><h3>
236
 
<a name="Profile:Kind"></a>The "Kind" property</h3>
237
 
<pre class="programlisting">'Kind'  read      's'
238
 
</pre>
239
 
</div>
240
 
<p>
241
 
            The profile kind, e.g. <code class="literal">colorspace-conversion</code>,
242
 
            <code class="literal">abstract</code> or <code class="literal">display-device</code>.
243
 
          </p>
244
 
<div class="variablelist"><table border="0">
245
 
<col align="left" valign="top">
246
 
<tbody></tbody>
247
 
</table></div>
248
 
<hr>
249
 
<div class="refsect2">
250
 
<a name="id506057"></a><h3>
251
 
<a name="Profile:Colorspace"></a>The "Colorspace" property</h3>
252
 
<pre class="programlisting">'Colorspace'  read      's'
253
 
</pre>
254
 
</div>
255
 
<p>
256
 
            The profile colorspace, e.g. <code class="literal">rgb</code>.
257
 
          </p>
258
 
<div class="variablelist"><table border="0">
259
 
<col align="left" valign="top">
260
 
<tbody></tbody>
261
 
</table></div>
262
 
<hr>
263
 
<div class="refsect2">
264
 
<a name="id506094"></a><h3>
265
 
<a name="Profile:HasVcgt"></a>The "HasVcgt" property</h3>
266
 
<pre class="programlisting">'HasVcgt'  read      'b'
267
 
</pre>
268
 
</div>
269
 
<p>
270
 
            If the profile has a VCGT entry.
271
 
          </p>
272
 
<div class="variablelist"><table border="0">
273
 
<col align="left" valign="top">
274
 
<tbody></tbody>
275
 
</table></div>
276
 
<hr>
277
 
<div class="refsect2">
278
 
<a name="id506125"></a><h3>
279
 
<a name="Profile:IsSystemWide"></a>The "IsSystemWide" property</h3>
280
 
<pre class="programlisting">'IsSystemWide'  read      'b'
281
 
</pre>
282
 
</div>
283
 
<p>
284
 
            If the profile is installed system wide and available
285
 
            for all users.
286
 
          </p>
287
 
<div class="variablelist"><table border="0">
288
 
<col align="left" valign="top">
289
 
<tbody></tbody>
290
 
</table></div>
291
 
<hr>
292
 
<div class="refsect2">
293
 
<a name="id506157"></a><h3>
294
 
<a name="Profile:Filename"></a>The "Filename" property</h3>
295
 
<pre class="programlisting">'Filename'  read      's'
296
 
</pre>
297
 
</div>
298
 
<p>
299
 
            The profile filename, if one exists.
300
 
          </p>
301
 
<div class="variablelist"><table border="0">
302
 
<col align="left" valign="top">
303
 
<tbody></tbody>
304
 
</table></div>
305
 
<hr>
306
 
<div class="refsect2">
307
 
<a name="id506188"></a><h3>
308
 
<a name="Profile:Created"></a>The "Created" property</h3>
309
 
<pre class="programlisting">'Created'  read      'x'
310
 
</pre>
311
 
</div>
312
 
<p>
313
 
            The date and time the profile was created in UNIX time.
314
 
          </p>
315
 
<p>
316
 
            NOTE: this is NOT the time the meta-profile was created,
317
 
            or added to colord, nor the disk timestamp for the profile
318
 
            filename.
319
 
            This is the encoded date and time inside the ICC filename.
320
 
          </p>
321
 
<div class="variablelist"><table border="0">
322
 
<col align="left" valign="top">
323
 
<tbody></tbody>
324
 
</table></div>
325
 
<hr>
326
 
<div class="refsect2">
327
 
<a name="id506224"></a><h3>
328
 
<a name="Profile:Scope"></a>The "Scope" property</h3>
329
 
<pre class="programlisting">'Scope'  read      's'
330
 
</pre>
331
 
</div>
332
 
<p>
333
 
            The scope of the device, e.g. <code class="literal">normal</code>,
334
 
            <code class="literal">temp</code> or <code class="literal">disk</code>.
335
 
          </p>
336
 
<div class="variablelist"><table border="0">
337
 
<col align="left" valign="top">
338
 
<tbody></tbody>
339
 
</table></div>
340
 
</div>
341
 
</div>
342
 
<div class="footer">
343
 
<hr>
344
 
          Generated by GTK-Doc V1.17</div>
345
 
</body>
346
 
</html>
 
 
b'\\ No newline at end of file'