summaryrefslogtreecommitdiff
path: root/src/org.freedesktop.ColorManager.Device.xml
blob: 7024bdc5034ba07bd91f5cfcaf1b5d3a8ae1802b (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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
<!DOCTYPE node PUBLIC
'-//freedesktop//DTD D-BUS Object Introspection 1.0//EN'
'http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd'>
<node>
  <interface name='org.freedesktop.ColorManager.Device'>
    <doc:doc>
      <doc:description>
        <doc:para>
          The interface used for quering color parameters for a specific device.
        </doc:para>
      </doc:description>
    </doc:doc>

    <!--***********************************************************-->
    <property name='Created' type='t' access='read'>
      <doc:doc>
        <doc:description>
          <doc:para>
            The date the device was created.
          </doc:para>
        </doc:description>
      </doc:doc>
    </property>

    <!--***********************************************************-->
    <property name='Modified' type='t' access='read'>
      <doc:doc>
        <doc:description>
          <doc:para>
            The date the device was last modified, which in this
            instance means having a profile added or removed, or a
            different profile set as default.
          </doc:para>
        </doc:description>
      </doc:doc>
    </property>

    <!--***********************************************************-->
    <property name='Model' type='s' access='read'>
      <doc:doc>
        <doc:description>
          <doc:para>
            The device model string.
          </doc:para>
        </doc:description>
      </doc:doc>
    </property>

    <!--***********************************************************-->
    <property name='Serial' type='s' access='read'>
      <doc:doc>
        <doc:description>
          <doc:para>
            The device serial string.
          </doc:para>
        </doc:description>
      </doc:doc>
    </property>

    <!--***********************************************************-->
    <property name='Vendor' type='s' access='read'>
      <doc:doc>
        <doc:description>
          <doc:para>
            The device vendor string.
          </doc:para>
        </doc:description>
      </doc:doc>
    </property>

    <!--***********************************************************-->
    <property name='Colorspace' type='s' access='read'>
      <doc:doc>
        <doc:description>
          <doc:para>
            The device supported colorspace string, e.g. <doc:tt>RGB</doc:tt>.
          </doc:para>
        </doc:description>
      </doc:doc>
    </property>

    <!--***********************************************************-->
    <property name='Kind' type='s' access='read'>
      <doc:doc>
        <doc:description>
          <doc:para>
            The device kind, e.g. <doc:tt>scanner</doc:tt>,
            <doc:tt>display</doc:tt>, <doc:tt>printer</doc:tt> or
            <doc:tt>camera</doc:tt>
          </doc:para>
        </doc:description>
      </doc:doc>
    </property>

    <!--***********************************************************-->
    <property name='DeviceId' type='s' access='read'>
      <doc:doc>
        <doc:description>
          <doc:para>
            The device id string.
          </doc:para>
        </doc:description>
      </doc:doc>
    </property>

    <!--***********************************************************-->
    <property name='Profiles' type='ao' access='read'>
      <doc:doc>
        <doc:description>
          <doc:para>
            The profile paths accosiated with this device.
          </doc:para>
        </doc:description>
      </doc:doc>
    </property>

    <!--***********************************************************-->
    <property name='Mode' type='s' access='read'>
      <doc:doc>
        <doc:description>
          <doc:para>
            The mode of the device, e.g. <doc:tt>virtual</doc:tt>,
            <doc:tt>physical</doc:tt> or <doc:tt>unknown</doc:tt>.
          </doc:para>
          <doc:para>
            Virtual devices are not tied to a specific item of hardware
            and can represent abstract devices such as "Boots Photo Lab".
          </doc:para>
          <doc:para>
            Physical devices correspond to a connected device that
            cannot be removed by client software.
          </doc:para>
        </doc:description>
      </doc:doc>
    </property>

    <!--***********************************************************-->
    <method name='SetProperty'>
      <annotation name='org.freedesktop.DBus.GLib.Async' value=''/>
      <doc:doc>
        <doc:description>
          <doc:para>
            Sets a property on the object.
          </doc:para>
        </doc:description>
      </doc:doc>
      <arg type='s' name='property_name' direction='in'>
        <doc:doc>
          <doc:summary>
            <doc:para>
              The property name, e.g. <doc:tt>Model</doc:tt>.
            </doc:para>
          </doc:summary>
        </doc:doc>
      </arg>
      <arg type='s' name='property_value' direction='in'>
        <doc:doc>
          <doc:summary>
            <doc:para>
              The property value, e.g. <doc:tt>RGB.Plain.</doc:tt>.
            </doc:para>
          </doc:summary>
        </doc:doc>
      </arg>
    </method>

    <!-- ************************************************************ -->
    <signal name='Changed'>
      <doc:doc>
        <doc:description>
          <doc:para>
            Some value on the interface has changed.
          </doc:para>
        </doc:description>
      </doc:doc>
    </signal>

    <!--***********************************************************-->
    <method name='AddProfile'>
      <annotation name='org.freedesktop.DBus.GLib.Async' value=''/>
      <doc:doc>
        <doc:description>
          <doc:para>
            Adds a profile to the device. The profile must have been
            previously created.
          </doc:para>
          <doc:para>
            This method also stores the device to profile mapping in a
            persistent datadase, so that if the device and profile
            happen to both exist in the future, the profiles are
            auto-added to the device.
          </doc:para>
        </doc:description>
      </doc:doc>
      <arg type='o' name='object_path' direction='in'>
        <doc:doc>
          <doc:summary>
            <doc:para>
              The profile path to add.
            </doc:para>
          </doc:summary>
        </doc:doc>
      </arg>
    </method>

    <!--***********************************************************-->
    <method name='RemoveProfile'>
      <annotation name='org.freedesktop.DBus.GLib.Async' value=''/>
      <doc:doc>
        <doc:description>
          <doc:para>
            Removes a profile for a device.
          </doc:para>
          <doc:para>
            This method also removes the device to profile mapping from
            a persistent datadase, so that if the device and profile
            happen to both exist in the future, the profiles are
            no longer auto-added to the device.
          </doc:para>
        </doc:description>
      </doc:doc>
      <arg type='o' name='object_path' direction='in'>
        <doc:doc>
          <doc:summary>
            <doc:para>
              The profile ID that has already been added to the device.
            </doc:para>
          </doc:summary>
        </doc:doc>
      </arg>
    </method>

    <!--***********************************************************-->
    <method name='MakeProfileDefault'>
      <annotation name='org.freedesktop.DBus.GLib.Async' value=''/>
      <doc:doc>
        <doc:description>
          <doc:para>
            Sets the default profile for a device.
          </doc:para>
        </doc:description>
      </doc:doc>
      <arg type='s' name='profile_id' direction='in'>
        <doc:doc>
          <doc:summary>
            <doc:para>
              The profile ID that has already been added to the device.
            </doc:para>
          </doc:summary>
        </doc:doc>
      </arg>
    </method>

    <!--***********************************************************-->
    <method name='GetProfileForQualifier'>
      <annotation name='org.freedesktop.DBus.GLib.Async' value=''/>
      <doc:doc>
        <doc:description>
          <doc:para>
            Gets a single profile object path for a qualifier.
            The search term can contain '*' and '?' wildcards.
          </doc:para>
        </doc:description>
      </doc:doc>
      <arg type='s' name='search_term' direction='in'>
        <doc:doc>
          <doc:summary>
            <doc:para>
              The search term, e.g. <doc:tt>RGB.*.300dpi</doc:tt>
            </doc:para>
          </doc:summary>
        </doc:doc>
      </arg>
      <arg type='o' name='object_path' direction='out'>
        <doc:doc>
          <doc:summary>
            <doc:para>
              The profile path for the search term.
            </doc:para>
          </doc:summary>
        </doc:doc>
      </arg>
    </method>

    <!--***********************************************************-->
    <method name='ProfilingInhibit'>
      <annotation name='org.freedesktop.DBus.GLib.Async' value=''/>
      <doc:doc>
        <doc:description>
          <doc:para>
            Adds an inhibit on all profiles for this device. This means
            that any calls to <doc:tt>GetProfileForQualifier</doc:tt>
            will always match no profiles.
          </doc:para>
          <doc:para>
            This method will be used when creating profiles for devices,
            where the session color manager wants to be very sure that
            no profiles are being applied wen displaying color samples
            or printing color swatches.
          </doc:para>
          <doc:para>
            If the calling program exits without calling
            <doc:tt>ProfilingUninhibit</doc:tt> then the inhibit is
            automatically removed.
          </doc:para>
        </doc:description>
      </doc:doc>
    </method>

    <!--***********************************************************-->
    <method name='ProfilingUninhibit'>
      <annotation name='org.freedesktop.DBus.GLib.Async' value=''/>
      <doc:doc>
        <doc:description>
          <doc:para>
            Removes an inhibit on the device.
            This method should be used when profiling has finished and
            normal device matching behaviour should resume.
          </doc:para>
        </doc:description>
      </doc:doc>
    </method>

  </interface>
</node>