Debian Codegraph @

src/org.freedesktop.ColorManager.xml

raw
1 <!DOCTYPE node PUBLIC
2 "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
3 "https://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
4 <node name="/" xmlns:doc="https://www.freedesktop.org/dbus/1.0/doc.dtd">
5 <interface name='org.freedesktop.ColorManager'>
6 <doc:doc>
7 <doc:description>
8 <doc:para>
9 The interface used for querying color parameters for the system.
10 </doc:para>
11 </doc:description>
12 </doc:doc>
13
14 <!--***********************************************************-->
15 <property name='DaemonVersion' type='s' access='read'>
16 <doc:doc>
17 <doc:description>
18 <doc:para>
19 The daemon version.
20 </doc:para>
21 </doc:description>
22 </doc:doc>
23 </property>
24
25 <!--***********************************************************-->
26 <property name='SystemVendor' type='s' access='read'>
27 <doc:doc>
28 <doc:description>
29 <doc:para>
30 The system vendor.
31 </doc:para>
32 </doc:description>
33 </doc:doc>
34 </property>
35
36 <!--***********************************************************-->
37 <property name='SystemModel' type='s' access='read'>
38 <doc:doc>
39 <doc:description>
40 <doc:para>
41 The system model.
42 </doc:para>
43 </doc:description>
44 </doc:doc>
45 </property>
46
47 <!--***********************************************************-->
48 <method name='GetDevices'>
49 <doc:doc>
50 <doc:description>
51 <doc:para>
52 Gets a list of all the devices which have assigned color profiles.
53 </doc:para>
54 </doc:description>
55 </doc:doc>
56 <arg type='ao' name='devices' direction='out'>
57 <doc:doc>
58 <doc:summary>
59 <doc:para>
60 An array of device paths, e.g. <doc:tt>['/org/freedesktop/ColorManager/device/xrandr_ibm_france_ltn154p2_l05']</doc:tt>.
61 </doc:para>
62 </doc:summary>
63 </doc:doc>
64 </arg>
65 </method>
66
67 <!--***********************************************************-->
68 <method name='GetDevicesByKind'>
69 <doc:doc>
70 <doc:description>
71 <doc:para>
72 Gets a list of all the devices which have assigned color profiles.
73 </doc:para>
74 </doc:description>
75 </doc:doc>
76 <arg type='s' name='kind' direction='in'>
77 <doc:doc>
78 <doc:summary>
79 <doc:para>
80 A device kind, e.g. <doc:tt>scanner</doc:tt>, <doc:tt>display</doc:tt>,
81 <doc:tt>printer</doc:tt> or <doc:tt>camera</doc:tt>.
82 </doc:para>
83 </doc:summary>
84 </doc:doc>
85 </arg>
86 <arg type='ao' name='devices' direction='out'>
87 <doc:doc>
88 <doc:summary>
89 <doc:para>
90 An array of device paths, e.g. <doc:tt>['/org/freedesktop/ColorManager/device/xrandr_ibm_france_ltn154p2_l05']</doc:tt>.
91 </doc:para>
92 </doc:summary>
93 </doc:doc>
94 </arg>
95 </method>
96
97 <!--***********************************************************-->
98 <method name='FindDeviceById'>
99 <doc:doc>
100 <doc:description>
101 <doc:para>
102 Gets a device path for the device ID.
103 This method is required as device ID's may have to be mangled
104 to conform with the DBus path specification.
105 For instance, a device ID of "cups$34:dev' would have a object
106 path of "/org/freedesktop/ColorManager/cups_34_dev".
107 </doc:para>
108 </doc:description>
109 </doc:doc>
110 <arg type='s' name='device_id' direction='in'>
111 <doc:doc>
112 <doc:summary>
113 <doc:para>
114 A device ID.
115 </doc:para>
116 </doc:summary>
117 </doc:doc>
118 </arg>
119 <arg type='o' name='object_path' direction='out'>
120 <doc:doc>
121 <doc:summary>
122 <doc:para>
123 A device path.
124 </doc:para>
125 </doc:summary>
126 </doc:doc>
127 </arg>
128 </method>
129
130 <!--***********************************************************-->
131 <method name='FindSensorById'>
132 <doc:doc>
133 <doc:description>
134 <doc:para>
135 Gets a sensor path for the sensor ID.
136 </doc:para>
137 </doc:description>
138 </doc:doc>
139 <arg type='s' name='sensor_id' direction='in'>
140 <doc:doc>
141 <doc:summary>
142 <doc:para>
143 A sensor ID.
144 </doc:para>
145 </doc:summary>
146 </doc:doc>
147 </arg>
148 <arg type='o' name='object_path' direction='out'>
149 <doc:doc>
150 <doc:summary>
151 <doc:para>
152 A sensor path.
153 </doc:para>
154 </doc:summary>
155 </doc:doc>
156 </arg>
157 </method>
158
159 <!--***********************************************************-->
160 <method name='FindDeviceByProperty'>
161 <doc:doc>
162 <doc:description>
163 <doc:para>
164 Gets a device path for the device with the specified property.
165 </doc:para>
166 </doc:description>
167 </doc:doc>
168 <arg type='s' name='key' direction='in'>
169 <doc:doc>
170 <doc:summary>
171 <doc:para>
172 A property key, e.g. <doc:tt>XRANDR_name</doc:tt>.
173 </doc:para>
174 </doc:summary>
175 </doc:doc>
176 </arg>
177 <arg type='s' name='value' direction='in'>
178 <doc:doc>
179 <doc:summary>
180 <doc:para>
181 A property value, e.g. <doc:tt>lvds</doc:tt>.
182 </doc:para>
183 </doc:summary>
184 </doc:doc>
185 </arg>
186 <arg type='o' name='object_path' direction='out'>
187 <doc:doc>
188 <doc:summary>
189 <doc:para>
190 A device path.
191 </doc:para>
192 </doc:summary>
193 </doc:doc>
194 </arg>
195 </method>
196
197 <!--***********************************************************-->
198 <method name='FindProfileById'>
199 <doc:doc>
200 <doc:description>
201 <doc:para>
202 Gets a profile path for the profile ID.
203 </doc:para>
204 </doc:description>
205 </doc:doc>
206 <arg type='s' name='profile_id' direction='in'>
207 <doc:doc>
208 <doc:summary>
209 <doc:para>
210 A profile ID.
211 </doc:para>
212 </doc:summary>
213 </doc:doc>
214 </arg>
215 <arg type='o' name='object_path' direction='out'>
216 <doc:doc>
217 <doc:summary>
218 <doc:para>
219 A profile path.
220 </doc:para>
221 </doc:summary>
222 </doc:doc>
223 </arg>
224 </method>
225
226 <!--***********************************************************-->
227 <method name='FindProfileByProperty'>
228 <doc:doc>
229 <doc:description>
230 <doc:para>
231 Gets a profile path for the profile with the specified property.
232 </doc:para>
233 </doc:description>
234 </doc:doc>
235 <arg type='s' name='key' direction='in'>
236 <doc:doc>
237 <doc:summary>
238 <doc:para>
239 A property key, e.g. <doc:tt>FILE_checksum</doc:tt>.
240 </doc:para>
241 </doc:summary>
242 </doc:doc>
243 </arg>
244 <arg type='s' name='value' direction='in'>
245 <doc:doc>
246 <doc:summary>
247 <doc:para>
248 A property value, e.g. <doc:tt>5b3855e8630c9d8a48177cc70680da93</doc:tt>.
249 </doc:para>
250 </doc:summary>
251 </doc:doc>
252 </arg>
253 <arg type='o' name='object_path' direction='out'>
254 <doc:doc>
255 <doc:summary>
256 <doc:para>
257 A profile path.
258 </doc:para>
259 </doc:summary>
260 </doc:doc>
261 </arg>
262 </method>
263
264 <!--***********************************************************-->
265 <method name='FindProfileByFilename'>
266 <doc:doc>
267 <doc:description>
268 <doc:para>
269 Gets a profile path for the profile filename, either a fully-qualified
270 filename with path or just the basename of the profile.
271 </doc:para>
272 </doc:description>
273 </doc:doc>
274 <arg type='s' name='filename' direction='in'>
275 <doc:doc>
276 <doc:summary>
277 <doc:para>
278 A profile filename.
279 </doc:para>
280 </doc:summary>
281 </doc:doc>
282 </arg>
283 <arg type='o' name='object_path' direction='out'>
284 <doc:doc>
285 <doc:summary>
286 <doc:para>
287 A profile path.
288 </doc:para>
289 </doc:summary>
290 </doc:doc>
291 </arg>
292 </method>
293
294 <!--***********************************************************-->
295 <method name='GetStandardSpace'>
296 <doc:doc>
297 <doc:description>
298 <doc:para>
299 Gets a profile path for a defined profile space.
300 The defined space is set from the profile metadata,
301 specifically in the <doc:tt>STANDARD_space</doc:tt> entry.
302 </doc:para>
303 <doc:para>
304 NOTE: only system wide profiles are able to define
305 themselves as standard spaces.
306 </doc:para>
307 </doc:description>
308 </doc:doc>
309 <arg type='s' name='standard_space' direction='in'>
310 <doc:doc>
311 <doc:summary>
312 <doc:para>
313 A profile space, e.g. <doc:tt>srgb</doc:tt> or
314 <doc:tt>adobe-srgb</doc:tt>.
315 </doc:para>
316 </doc:summary>
317 </doc:doc>
318 </arg>
319 <arg type='o' name='object_path' direction='out'>
320 <doc:doc>
321 <doc:summary>
322 <doc:para>
323 A profile path.
324 </doc:para>
325 </doc:summary>
326 </doc:doc>
327 </arg>
328 </method>
329
330 <!--***********************************************************-->
331 <method name='GetProfiles'>
332 <doc:doc>
333 <doc:description>
334 <doc:para>
335 Gets a list of all the profiles recognised by the system.
336 </doc:para>
337 </doc:description>
338 </doc:doc>
339 <arg type='ao' name='devices' direction='out'>
340 <doc:doc>
341 <doc:summary>
342 <doc:para>
343 An array of profile paths, e.g. <doc:tt>['/org/freedesktop/ColorManager/profile/adobe_rgb']</doc:tt>.
344 </doc:para>
345 </doc:summary>
346 </doc:doc>
347 </arg>
348 </method>
349
350 <!--***********************************************************-->
351 <method name='GetSensors'>
352 <doc:doc>
353 <doc:description>
354 <doc:para>
355 Gets a list of all the sensors recognised by the system.
356 </doc:para>
357 </doc:description>
358 </doc:doc>
359 <arg type='ao' name='devices' direction='out'>
360 <doc:doc>
361 <doc:summary>
362 <doc:para>
363 An array of sensor paths, e.g. <doc:tt>['/org/freedesktop/ColorManager/sensor/colormunki']</doc:tt>.
364 </doc:para>
365 </doc:summary>
366 </doc:doc>
367 </arg>
368 </method>
369
370 <!--***********************************************************-->
371 <method name='GetProfilesByKind'>
372 <doc:doc>
373 <doc:description>
374 <doc:para>
375 Gets a list of all the profiles of a specified type.
376 </doc:para>
377 </doc:description>
378 </doc:doc>
379 <arg type='s' name='kind' direction='in'>
380 <doc:doc>
381 <doc:summary>
382 <doc:para>
383 A profile kind, e.g. <doc:tt>input-device</doc:tt> or
384 <doc:tt>abstract</doc:tt>.
385 </doc:para>
386 </doc:summary>
387 </doc:doc>
388 </arg>
389 <arg type='ao' name='devices' direction='out'>
390 <doc:doc>
391 <doc:summary>
392 <doc:para>
393 An array of device paths, e.g. <doc:tt>['/org/freedesktop/ColorManager/device/xrandr_ibm_france_ltn154p2_l05']</doc:tt>.
394 </doc:para>
395 </doc:summary>
396 </doc:doc>
397 </arg>
398 </method>
399
400 <!--***********************************************************-->
401 <method name='CreateProfileWithFd'>
402 <doc:doc>
403 <doc:description>
404 <doc:para>
405 Creates a profile.
406 </doc:para>
407 <doc:para>
408 If the profile has been added to a device in the past, and
409 that device exists already, then the new profile will be
410 automatically added to the device.
411 To prevent this from happening, remove the assignment by
412 doing <doc:tt>RemoveProfile</doc:tt>doc:tt> on the relevant
413 device object.
414 </doc:para>
415 <doc:para>
416 An optional file descriptor can be sent out of band for the
417 ICC profile file.
418 </doc:para>
419 <doc:para>
420 Using a file descriptor in addition to the filename allows
421 the daemon to parse the ICC profile without re-opening it,
422 which allows the daemon to read files inside the users
423 home directory in a SELinux environment.
424 </doc:para>
425 </doc:description>
426 </doc:doc>
427 <arg type='s' name='profile_id' direction='in'>
428 <doc:doc>
429 <doc:summary>
430 <doc:para>
431 A unique profile ID that is used to map to the profile.
432 This is normally the MD5 hash of the disk profile.
433 </doc:para>
434 </doc:summary>
435 </doc:doc>
436 </arg>
437 <arg type='s' name='scope' direction='in'>
438 <doc:doc>
439 <doc:summary>
440 <doc:para>
441 Options for creating the profile. This allows the session
442 color management component to have per-user profiles
443 stored in the home directory that would not be valid if
444 the user logged off, or no users are logged in.
445 </doc:para>
446 </doc:summary>
447 <doc:list>
448 <doc:item>
449 <doc:term>normal</doc:term>
450 <doc:definition>
451 Normal profile.
452 </doc:definition>
453 </doc:item>
454 <doc:item>
455 <doc:term>temp</doc:term>
456 <doc:definition>
457 Profile is removed if the user logs out.
458 </doc:definition>
459 </doc:item>
460 <doc:item>
461 <doc:term>disk</doc:term>
462 <doc:definition>
463 Profile that is saved to disk and restored on next startup.
464 </doc:definition>
465 </doc:item>
466 </doc:list>
467 </doc:doc>
468 </arg>
469 <arg type='h' name='handle' direction='in'>
470 <doc:doc>
471 <doc:summary>
472 <doc:para>
473 An index into the array of file descriptors that may have
474 been sent with the DBus message.
475 </doc:para>
476 </doc:summary>
477 </doc:doc>
478 </arg>
479 <arg type='a{ss}' name='properties' direction='in'>
480 <annotation name="org.qtproject.QtDBus.QtTypeName.In3" value="CdStringMap"/>
481 <doc:doc>
482 <doc:summary>
483 <doc:para>
484 Properties to be used when constructing the profile.
485 </doc:para>
486 <doc:para>
487 This optional value allows the profile to be created with
488 the latency of one bus round-trip, rather than doing
489 a few <doc:tt>SetProperty</doc:tt> methods indervidually.
490 </doc:para>
491 <doc:para>
492 Any properties not interstood by colord will be added as
493 dictionary values to the <doc:tt>Metadata</doc:tt>
494 property.
495 </doc:para>
496 </doc:summary>
497 </doc:doc>
498 </arg>
499 <arg type='o' name='object_path' direction='out'>
500 <doc:doc>
501 <doc:summary>
502 <doc:para>
503 A profile path.
504 </doc:para>
505 </doc:summary>
506 </doc:doc>
507 </arg>
508 </method>
509
510 <!--***********************************************************-->
511 <method name='CreateProfile'>
512 <doc:doc>
513 <doc:description>
514 <doc:para>
515 Creates a profile without using a file descriptor.
516 It is recommended you use CreateProfileWithFd() as the
517 daemon may not be running as root and have read access
518 to profiles in the users home directory.
519 </doc:para>
520 </doc:description>
521 </doc:doc>
522 <arg type='s' name='profile_id' direction='in'>
523 <doc:doc>
524 <doc:summary>
525 <doc:para>
526 A unique profile ID that is used to map to the profile.
527 </doc:para>
528 </doc:summary>
529 </doc:doc>
530 </arg>
531 <arg type='s' name='scope' direction='in'>
532 <doc:doc>
533 <doc:summary>
534 <doc:para>
535 Options for creating the profile.
536 See CreateProfileWithFd() for the allowed values.
537 </doc:para>
538 </doc:summary>
539 </doc:doc>
540 </arg>
541 <arg type='a{ss}' name='properties' direction='in'>
542 <annotation name="org.qtproject.QtDBus.QtTypeName.In2" value="CdStringMap"/>
543 <doc:doc>
544 <doc:summary>
545 <doc:para>
546 Properties to be used when constructing the profile.
547 See CreateProfileWithFd() for the allowed values.
548 </doc:para>
549 </doc:summary>
550 </doc:doc>
551 </arg>
552 <arg type='o' name='object_path' direction='out'>
553 <doc:doc>
554 <doc:summary>
555 <doc:para>
556 A profile path.
557 </doc:para>
558 </doc:summary>
559 </doc:doc>
560 </arg>
561 </method>
562
563 <!--***********************************************************-->
564 <method name='CreateDevice'>
565 <doc:doc>
566 <doc:description>
567 <doc:para>
568 Creates a device.
569 </doc:para>
570 <doc:para>
571 If the device has profiles added to it in the past, and
572 that profiles exists already, then the new device will be
573 automatically have profiles added to the device.
574 To prevent this from happening, remove the assignment by
575 doing <doc:tt>RemoveProfile</doc:tt> on the relevant
576 device object.
577 </doc:para>
578 </doc:description>
579 </doc:doc>
580 <arg type='s' name='device_id' direction='in'>
581 <doc:doc>
582 <doc:summary>
583 <doc:para>
584 A device ID that is used to map to the device path.
585 </doc:para>
586 </doc:summary>
587 </doc:doc>
588 </arg>
589 <arg type='s' name='scope' direction='in'>
590 <doc:doc>
591 <doc:summary>
592 <doc:para>
593 Options for creating the device. This allows the session
594 color management component to have per-session virtual
595 devices cleaned up automatically or devices that are
596 re-created on each boot.
597 </doc:para>
598 </doc:summary>
599 <doc:list>
600 <doc:item>
601 <doc:term>normal</doc:term>
602 <doc:definition>
603 Normal device.
604 </doc:definition>
605 </doc:item>
606 <doc:item>
607 <doc:term>temp</doc:term>
608 <doc:definition>
609 Device that is removed if the user logs out.
610 </doc:definition>
611 </doc:item>
612 <doc:item>
613 <doc:term>disk</doc:term>
614 <doc:definition>
615 Device that is saved to disk, and restored if the
616 computer is restarted.
617 </doc:definition>
618 </doc:item>
619 </doc:list>
620 </doc:doc>
621 </arg>
622 <arg type='a{ss}' name='properties' direction='in'>
623 <annotation name="org.qtproject.QtDBus.QtTypeName.In2" value="CdStringMap"/>
624 <doc:doc>
625 <doc:summary>
626 <doc:para>
627 Properties to be used when constructing the device.
628 </doc:para>
629 <doc:para>
630 This optional value allows the device to be created with
631 the latency of one bus round-trip, rather than doing
632 a few <doc:tt>SetProperty</doc:tt> methods indervidually.
633 </doc:para>
634 <doc:para>
635 Any properties not interstood by colord will be added as
636 dictionary values to the <doc:tt>Metadata</doc:tt>
637 property.
638 </doc:para>
639 </doc:summary>
640 </doc:doc>
641 </arg>
642 <arg type='o' name='object_path' direction='out'>
643 <doc:doc>
644 <doc:summary>
645 <doc:para>
646 A device path.
647 </doc:para>
648 </doc:summary>
649 </doc:doc>
650 </arg>
651 </method>
652
653 <!--***********************************************************-->
654 <method name='DeleteDevice'>
655 <doc:doc>
656 <doc:description>
657 <doc:para>
658 Deletes a device.
659 </doc:para>
660 </doc:description>
661 </doc:doc>
662 <arg type='o' name='object_path' direction='in'>
663 <doc:doc>
664 <doc:summary>
665 <doc:para>
666 A device path.
667 </doc:para>
668 </doc:summary>
669 </doc:doc>
670 </arg>
671 </method>
672
673 <!--***********************************************************-->
674 <method name='DeleteProfile'>
675 <doc:doc>
676 <doc:description>
677 <doc:para>
678 Deletes a profile.
679 </doc:para>
680 </doc:description>
681 </doc:doc>
682 <arg type='o' name='object_path' direction='in'>
683 <doc:doc>
684 <doc:summary>
685 <doc:para>
686 A profile path.
687 </doc:para>
688 </doc:summary>
689 </doc:doc>
690 </arg>
691 </method>
692
693 <!--***********************************************************-->
694 <signal name='Changed'>
695 <doc:doc>
696 <doc:description>
697 <doc:para>
698 Some value on the interface or the number of devices or
699 profiles has changed.
700 </doc:para>
701 </doc:description>
702 </doc:doc>
703 </signal>
704
705 <!--***********************************************************-->
706 <signal name='DeviceAdded'>
707 <doc:doc>
708 <doc:description>
709 <doc:para>
710 A device has been added.
711 </doc:para>
712 </doc:description>
713 </doc:doc>
714 <arg type='o' name='object_path' direction='out'>
715 <doc:doc>
716 <doc:summary>
717 <doc:para>
718 The device path.
719 </doc:para>
720 </doc:summary>
721 </doc:doc>
722 </arg>
723 </signal>
724
725 <!--***********************************************************-->
726 <signal name='DeviceRemoved'>
727 <doc:doc>
728 <doc:description>
729 <doc:para>
730 A device has been removed.
731 </doc:para>
732 </doc:description>
733 </doc:doc>
734 <arg type='o' name='object_path' direction='out'>
735 <doc:doc>
736 <doc:summary>
737 <doc:para>
738 The device path.
739 </doc:para>
740 </doc:summary>
741 </doc:doc>
742 </arg>
743 </signal>
744
745 <!--***********************************************************-->
746 <signal name='DeviceChanged'>
747 <doc:doc>
748 <doc:description>
749 <doc:para>
750 A device has changed.
751 </doc:para>
752 </doc:description>
753 </doc:doc>
754 <arg type='o' name='object_path' direction='out'>
755 <doc:doc>
756 <doc:summary>
757 <doc:para>
758 The device path.
759 </doc:para>
760 </doc:summary>
761 </doc:doc>
762 </arg>
763 </signal>
764
765 <!--***********************************************************-->
766 <signal name='ProfileAdded'>
767 <doc:doc>
768 <doc:description>
769 <doc:para>
770 A profile has been added.
771 </doc:para>
772 </doc:description>
773 </doc:doc>
774 <arg type='o' name='object_path' direction='out'>
775 <doc:doc>
776 <doc:summary>
777 <doc:para>
778 The profile path.
779 </doc:para>
780 </doc:summary>
781 </doc:doc>
782 </arg>
783 </signal>
784
785 <!--***********************************************************-->
786 <signal name='ProfileRemoved'>
787 <doc:doc>
788 <doc:description>
789 <doc:para>
790 A profile has been removed.
791 </doc:para>
792 </doc:description>
793 </doc:doc>
794 <arg type='o' name='object_path' direction='out'>
795 <doc:doc>
796 <doc:summary>
797 <doc:para>
798 The profile path.
799 </doc:para>
800 </doc:summary>
801 </doc:doc>
802 </arg>
803 </signal>
804
805 <!--***********************************************************-->
806 <signal name='SensorAdded'>
807 <doc:doc>
808 <doc:description>
809 <doc:para>
810 A sensor has been added.
811 </doc:para>
812 </doc:description>
813 </doc:doc>
814 <arg type='o' name='object_path' direction='out'>
815 <doc:doc>
816 <doc:summary>
817 <doc:para>
818 The sensor path.
819 </doc:para>
820 </doc:summary>
821 </doc:doc>
822 </arg>
823 </signal>
824
825 <!--***********************************************************-->
826 <signal name='SensorRemoved'>
827 <doc:doc>
828 <doc:description>
829 <doc:para>
830 A sensor has been removed.
831 </doc:para>
832 </doc:description>
833 </doc:doc>
834 <arg type='o' name='object_path' direction='out'>
835 <doc:doc>
836 <doc:summary>
837 <doc:para>
838 The sensor path.
839 </doc:para>
840 </doc:summary>
841 </doc:doc>
842 </arg>
843 </signal>
844
845 <!--***********************************************************-->
846 <signal name='ProfileChanged'>
847 <doc:doc>
848 <doc:description>
849 <doc:para>
850 A profile has been changed.
851 </doc:para>
852 </doc:description>
853 </doc:doc>
854 <arg type='o' name='object_path' direction='out'>
855 <doc:doc>
856 <doc:summary>
857 <doc:para>
858 The profile path.
859 </doc:para>
860 </doc:summary>
861 </doc:doc>
862 </arg>
863 </signal>
864
865 </interface>
866 </node>