| 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.Device'> |
| 6 |
<doc:doc> |
| 7 |
<doc:description> |
| 8 |
<doc:para> |
| 9 |
The interface used for querying color parameters for a specific device. |
| 10 |
</doc:para> |
| 11 |
</doc:description> |
| 12 |
</doc:doc> |
| 13 |
|
| 14 |
<!--***********************************************************--> |
| 15 |
<property name='Created' type='t' access='read'> |
| 16 |
<doc:doc> |
| 17 |
<doc:description> |
| 18 |
<doc:para> |
| 19 |
The date the device was created. |
| 20 |
</doc:para> |
| 21 |
</doc:description> |
| 22 |
</doc:doc> |
| 23 |
</property> |
| 24 |
|
| 25 |
<!--***********************************************************--> |
| 26 |
<property name='Modified' type='t' access='read'> |
| 27 |
<doc:doc> |
| 28 |
<doc:description> |
| 29 |
<doc:para> |
| 30 |
The date the device was last modified, which in this |
| 31 |
instance means having a profile added or removed, or a |
| 32 |
different profile set as default. |
| 33 |
</doc:para> |
| 34 |
</doc:description> |
| 35 |
</doc:doc> |
| 36 |
</property> |
| 37 |
|
| 38 |
<!--***********************************************************--> |
| 39 |
<property name='Model' type='s' access='read'> |
| 40 |
<doc:doc> |
| 41 |
<doc:description> |
| 42 |
<doc:para> |
| 43 |
The device model string. |
| 44 |
</doc:para> |
| 45 |
</doc:description> |
| 46 |
</doc:doc> |
| 47 |
</property> |
| 48 |
|
| 49 |
<!--***********************************************************--> |
| 50 |
<property name='Serial' type='s' access='read'> |
| 51 |
<doc:doc> |
| 52 |
<doc:description> |
| 53 |
<doc:para> |
| 54 |
The device serial string. |
| 55 |
</doc:para> |
| 56 |
</doc:description> |
| 57 |
</doc:doc> |
| 58 |
</property> |
| 59 |
|
| 60 |
<!--***********************************************************--> |
| 61 |
<property name='Vendor' type='s' access='read'> |
| 62 |
<doc:doc> |
| 63 |
<doc:description> |
| 64 |
<doc:para> |
| 65 |
The device vendor string. |
| 66 |
</doc:para> |
| 67 |
</doc:description> |
| 68 |
</doc:doc> |
| 69 |
</property> |
| 70 |
|
| 71 |
<!--***********************************************************--> |
| 72 |
<property name='Colorspace' type='s' access='read'> |
| 73 |
<doc:doc> |
| 74 |
<doc:description> |
| 75 |
<doc:para> |
| 76 |
The device supported colorspace string, e.g. <doc:tt>RGB</doc:tt>. |
| 77 |
</doc:para> |
| 78 |
</doc:description> |
| 79 |
</doc:doc> |
| 80 |
</property> |
| 81 |
|
| 82 |
<!--***********************************************************--> |
| 83 |
<property name='Kind' type='s' access='read'> |
| 84 |
<doc:doc> |
| 85 |
<doc:description> |
| 86 |
<doc:para> |
| 87 |
The device kind, e.g. <doc:tt>scanner</doc:tt>, |
| 88 |
<doc:tt>display</doc:tt>, <doc:tt>printer</doc:tt> or |
| 89 |
<doc:tt>camera</doc:tt> |
| 90 |
</doc:para> |
| 91 |
</doc:description> |
| 92 |
</doc:doc> |
| 93 |
</property> |
| 94 |
|
| 95 |
<!--***********************************************************--> |
| 96 |
<property name='DeviceId' type='s' access='read'> |
| 97 |
<doc:doc> |
| 98 |
<doc:description> |
| 99 |
<doc:para> |
| 100 |
The device id string. |
| 101 |
</doc:para> |
| 102 |
</doc:description> |
| 103 |
</doc:doc> |
| 104 |
</property> |
| 105 |
|
| 106 |
<!--***********************************************************--> |
| 107 |
<property name='Profiles' type='ao' access='read'> |
| 108 |
<doc:doc> |
| 109 |
<doc:description> |
| 110 |
<doc:para> |
| 111 |
The profile paths associated with this device. |
| 112 |
Profiles are returned even if the device is disabled or |
| 113 |
is profiling, and clients should not assume that the first |
| 114 |
profile in this array should be applied. |
| 115 |
</doc:para> |
| 116 |
</doc:description> |
| 117 |
</doc:doc> |
| 118 |
</property> |
| 119 |
|
| 120 |
<!--***********************************************************--> |
| 121 |
<property name='Mode' type='s' access='read'> |
| 122 |
<doc:doc> |
| 123 |
<doc:description> |
| 124 |
<doc:para> |
| 125 |
The mode of the device, e.g. <doc:tt>virtual</doc:tt>, |
| 126 |
<doc:tt>physical</doc:tt> or <doc:tt>unknown</doc:tt>. |
| 127 |
</doc:para> |
| 128 |
<doc:para> |
| 129 |
Virtual devices are not tied to a specific item of hardware |
| 130 |
and can represent abstract devices such as "Boots Photo Lab". |
| 131 |
</doc:para> |
| 132 |
<doc:para> |
| 133 |
Physical devices correspond to a connected device that |
| 134 |
cannot be removed by client software. |
| 135 |
</doc:para> |
| 136 |
<doc:para> |
| 137 |
If a virtual 'disk' device gets added by a client then it |
| 138 |
is promoted to a 'physical' device. |
| 139 |
This can happen if a printer is saved and then restored at |
| 140 |
next boot before the CUPS daemon is running. |
| 141 |
</doc:para> |
| 142 |
</doc:description> |
| 143 |
</doc:doc> |
| 144 |
</property> |
| 145 |
|
| 146 |
<!--***********************************************************--> |
| 147 |
<property name='Format' type='s' access='read'> |
| 148 |
<doc:doc> |
| 149 |
<doc:description> |
| 150 |
<doc:para> |
| 151 |
The qualifier format for the device, e.g. |
| 152 |
<doc:tt>ColorModel.OutputMode.OutputResolution</doc:tt>. |
| 153 |
</doc:para> |
| 154 |
</doc:description> |
| 155 |
</doc:doc> |
| 156 |
</property> |
| 157 |
|
| 158 |
<!--***********************************************************--> |
| 159 |
<property name='Scope' type='s' access='read'> |
| 160 |
<doc:doc> |
| 161 |
<doc:description> |
| 162 |
<doc:para> |
| 163 |
The scope of the device, e.g. <doc:tt>normal</doc:tt>, |
| 164 |
<doc:tt>temp</doc:tt> or <doc:tt>disk</doc:tt>. |
| 165 |
</doc:para> |
| 166 |
</doc:description> |
| 167 |
</doc:doc> |
| 168 |
</property> |
| 169 |
|
| 170 |
<!--***********************************************************--> |
| 171 |
<property name='Owner' type='u' access='read'> |
| 172 |
<doc:doc> |
| 173 |
<doc:description> |
| 174 |
<doc:para> |
| 175 |
The user ID of the account that created the device. |
| 176 |
</doc:para> |
| 177 |
</doc:description> |
| 178 |
</doc:doc> |
| 179 |
</property> |
| 180 |
|
| 181 |
<!--***********************************************************--> |
| 182 |
<property name='Enabled' type='b' access='read'> |
| 183 |
<doc:doc> |
| 184 |
<doc:description> |
| 185 |
<doc:para> |
| 186 |
If the device is enabled. Devices are enabled by default |
| 187 |
until <doc:tt>Device.SetEnabled(False)</doc:tt> is called. |
| 188 |
If the enabled state is changed then this is reflected for |
| 189 |
all users and persistent across reboots. |
| 190 |
</doc:para> |
| 191 |
</doc:description> |
| 192 |
</doc:doc> |
| 193 |
</property> |
| 194 |
|
| 195 |
<!--***********************************************************--> |
| 196 |
<property name='Seat' type='s' access='read'> |
| 197 |
<doc:doc> |
| 198 |
<doc:description> |
| 199 |
<doc:para> |
| 200 |
The seat that the device belongs to, or an empty string for |
| 201 |
none or unknown. |
| 202 |
</doc:para> |
| 203 |
</doc:description> |
| 204 |
</doc:doc> |
| 205 |
</property> |
| 206 |
|
| 207 |
<!--***********************************************************--> |
| 208 |
<property name='Embedded' type='b' access='read'> |
| 209 |
<doc:doc> |
| 210 |
<doc:description> |
| 211 |
<doc:para> |
| 212 |
If the device is embedded into the hardware itself, for |
| 213 |
example the internal webcam or laptop screen. |
| 214 |
</doc:para> |
| 215 |
</doc:description> |
| 216 |
</doc:doc> |
| 217 |
</property> |
| 218 |
|
| 219 |
<!--***********************************************************--> |
| 220 |
<property name='Metadata' type='a{ss}' access='read'> |
| 221 |
<annotation name="org.qtproject.QtDBus.QtTypeName" value="CdStringMap"/> |
| 222 |
<doc:doc> |
| 223 |
<doc:description> |
| 224 |
<doc:para> |
| 225 |
The metadata for the device, which may include optional |
| 226 |
keys like <doc:tt>XRANDR_name</doc:tt>. |
| 227 |
</doc:para> |
| 228 |
</doc:description> |
| 229 |
</doc:doc> |
| 230 |
</property> |
| 231 |
|
| 232 |
<!--***********************************************************--> |
| 233 |
<property name='ProfilingInhibitors' type='as' access='read'> |
| 234 |
<doc:doc> |
| 235 |
<doc:description> |
| 236 |
<doc:para> |
| 237 |
The bus names of all the clients that have inhibited the |
| 238 |
device for profiling. e.g. <doc:tt>[ ":1.99", ":1.109" ]</doc:tt> |
| 239 |
</doc:para> |
| 240 |
</doc:description> |
| 241 |
</doc:doc> |
| 242 |
</property> |
| 243 |
|
| 244 |
<!--***********************************************************--> |
| 245 |
<method name='SetProperty'> |
| 246 |
<doc:doc> |
| 247 |
<doc:description> |
| 248 |
<doc:para> |
| 249 |
Sets a property on the object. |
| 250 |
</doc:para> |
| 251 |
</doc:description> |
| 252 |
</doc:doc> |
| 253 |
<arg type='s' name='property_name' direction='in'> |
| 254 |
<doc:doc> |
| 255 |
<doc:summary> |
| 256 |
<doc:para> |
| 257 |
The property name, e.g. <doc:tt>Model</doc:tt>. |
| 258 |
</doc:para> |
| 259 |
</doc:summary> |
| 260 |
</doc:doc> |
| 261 |
</arg> |
| 262 |
<arg type='s' name='property_value' direction='in'> |
| 263 |
<doc:doc> |
| 264 |
<doc:summary> |
| 265 |
<doc:para> |
| 266 |
The property value, e.g. <doc:tt>RGB.Plain.</doc:tt>. |
| 267 |
</doc:para> |
| 268 |
</doc:summary> |
| 269 |
</doc:doc> |
| 270 |
</arg> |
| 271 |
</method> |
| 272 |
|
| 273 |
<!-- ************************************************************ --> |
| 274 |
<signal name='Changed'> |
| 275 |
<doc:doc> |
| 276 |
<doc:description> |
| 277 |
<doc:para> |
| 278 |
Some value on the interface has changed. |
| 279 |
</doc:para> |
| 280 |
</doc:description> |
| 281 |
</doc:doc> |
| 282 |
</signal> |
| 283 |
|
| 284 |
<!--***********************************************************--> |
| 285 |
<method name='AddProfile'> |
| 286 |
<doc:doc> |
| 287 |
<doc:description> |
| 288 |
<doc:para> |
| 289 |
Adds a profile to the device. The profile must have been |
| 290 |
previously created. |
| 291 |
</doc:para> |
| 292 |
<doc:para> |
| 293 |
This method also stores the device to profile mapping in a |
| 294 |
persistent datadase, so that if the device and profile |
| 295 |
happen to both exist in the future, the profiles are |
| 296 |
auto-added to the device. |
| 297 |
</doc:para> |
| 298 |
</doc:description> |
| 299 |
</doc:doc> |
| 300 |
<arg type='s' name='relation' direction='in'> |
| 301 |
<doc:doc> |
| 302 |
<doc:summary> |
| 303 |
<doc:para> |
| 304 |
The strength of the relationship from profile to device. |
| 305 |
This can be <doc:tt>soft</doc:tt> to indicate that the |
| 306 |
mapping is not important, or that the profile is assumed |
| 307 |
from a device and not in response to user action. |
| 308 |
<doc:para> |
| 309 |
</doc:para> |
| 310 |
The default option is <doc:tt>hard</doc:tt>, and this |
| 311 |
means that the user has explicitly mapped a profile to |
| 312 |
a device, and this should take precedence over any |
| 313 |
<doc:tt>soft</doc:tt> profiles. |
| 314 |
</doc:para> |
| 315 |
<doc:para> |
| 316 |
If the user makes a <doc:tt>soft</doc:tt> profile default, |
| 317 |
then it is explicitly promoted to a <doc:tt>hard</doc:tt> |
| 318 |
relationship. |
| 319 |
</doc:para> |
| 320 |
</doc:summary> |
| 321 |
</doc:doc> |
| 322 |
</arg> |
| 323 |
<arg type='o' name='object_path' direction='in'> |
| 324 |
<doc:doc> |
| 325 |
<doc:summary> |
| 326 |
<doc:para> |
| 327 |
The profile path to add. |
| 328 |
</doc:para> |
| 329 |
</doc:summary> |
| 330 |
</doc:doc> |
| 331 |
</arg> |
| 332 |
</method> |
| 333 |
|
| 334 |
<!--***********************************************************--> |
| 335 |
<method name='RemoveProfile'> |
| 336 |
<doc:doc> |
| 337 |
<doc:description> |
| 338 |
<doc:para> |
| 339 |
Removes a profile for a device. |
| 340 |
</doc:para> |
| 341 |
<doc:para> |
| 342 |
This method also removes the device to profile mapping from |
| 343 |
a persistent datadase, so that if the device and profile |
| 344 |
happen to both exist in the future, the profiles are |
| 345 |
no longer auto-added to the device. |
| 346 |
</doc:para> |
| 347 |
<doc:para> |
| 348 |
If the profile was automatically added due to metadata in |
| 349 |
the profile (e.g. the profile was created for the device) |
| 350 |
then manually removing the profile will cause this metadata |
| 351 |
add to be suppressed. |
| 352 |
This allows the user to remove old or obsolete profiles |
| 353 |
from any color control panel without having to delete them. |
| 354 |
</doc:para> |
| 355 |
</doc:description> |
| 356 |
</doc:doc> |
| 357 |
<arg type='o' name='object_path' direction='in'> |
| 358 |
<doc:doc> |
| 359 |
<doc:summary> |
| 360 |
<doc:para> |
| 361 |
The profile path that has already been added to the device. |
| 362 |
</doc:para> |
| 363 |
</doc:summary> |
| 364 |
</doc:doc> |
| 365 |
</arg> |
| 366 |
</method> |
| 367 |
|
| 368 |
<!--***********************************************************--> |
| 369 |
<method name='MakeProfileDefault'> |
| 370 |
<doc:doc> |
| 371 |
<doc:description> |
| 372 |
<doc:para> |
| 373 |
Sets the default profile for a device. |
| 374 |
</doc:para> |
| 375 |
</doc:description> |
| 376 |
</doc:doc> |
| 377 |
<arg type='o' name='profile_path' direction='in'> |
| 378 |
<doc:doc> |
| 379 |
<doc:summary> |
| 380 |
<doc:para> |
| 381 |
The profile path that has already been added to the device. |
| 382 |
</doc:para> |
| 383 |
</doc:summary> |
| 384 |
</doc:doc> |
| 385 |
</arg> |
| 386 |
</method> |
| 387 |
|
| 388 |
<!--***********************************************************--> |
| 389 |
<method name='GetProfileForQualifiers'> |
| 390 |
<doc:doc> |
| 391 |
<doc:description> |
| 392 |
<doc:para> |
| 393 |
Gets a single profile object path for a qualifier. |
| 394 |
The search term can contain '*' and '?' wildcards. |
| 395 |
</doc:para> |
| 396 |
</doc:description> |
| 397 |
</doc:doc> |
| 398 |
<arg type='as' name='qualifiers' direction='in'> |
| 399 |
<doc:doc> |
| 400 |
<doc:summary> |
| 401 |
<doc:para> |
| 402 |
An array of qualifiers, e.g. <doc:tt>['RGB.*.300dpi', 'RGB.*.*', '*.*.*']</doc:tt>. |
| 403 |
</doc:para> |
| 404 |
<doc:para> |
| 405 |
If the qualifier <doc:tt>*</doc:tt> is specified then |
| 406 |
the default profile is returned. |
| 407 |
</doc:para> |
| 408 |
</doc:summary> |
| 409 |
</doc:doc> |
| 410 |
</arg> |
| 411 |
<arg type='o' name='object_path' direction='out'> |
| 412 |
<doc:doc> |
| 413 |
<doc:summary> |
| 414 |
<doc:para> |
| 415 |
The profile path for the search terms. |
| 416 |
</doc:para> |
| 417 |
</doc:summary> |
| 418 |
</doc:doc> |
| 419 |
</arg> |
| 420 |
</method> |
| 421 |
|
| 422 |
<!--***********************************************************--> |
| 423 |
<method name='GetProfileRelation'> |
| 424 |
<doc:doc> |
| 425 |
<doc:description> |
| 426 |
<doc:para> |
| 427 |
Gets a profile relation for a given profile that has been |
| 428 |
added to this device. |
| 429 |
</doc:para> |
| 430 |
</doc:description> |
| 431 |
</doc:doc> |
| 432 |
<arg type='o' name='object_path' direction='in'> |
| 433 |
<doc:doc> |
| 434 |
<doc:summary> |
| 435 |
<doc:para> |
| 436 |
A profile object path. |
| 437 |
</doc:para> |
| 438 |
</doc:summary> |
| 439 |
</doc:doc> |
| 440 |
</arg> |
| 441 |
<arg type='s' name='relation' direction='out'> |
| 442 |
<doc:doc> |
| 443 |
<doc:summary> |
| 444 |
<doc:para> |
| 445 |
The profile to device relation, e.g. <doc:tt>hard</doc:tt>. |
| 446 |
</doc:para> |
| 447 |
</doc:summary> |
| 448 |
</doc:doc> |
| 449 |
</arg> |
| 450 |
</method> |
| 451 |
|
| 452 |
<!--***********************************************************--> |
| 453 |
<method name='ProfilingInhibit'> |
| 454 |
<doc:doc> |
| 455 |
<doc:description> |
| 456 |
<doc:para> |
| 457 |
Adds an inhibit on all profiles for this device. This means |
| 458 |
that any calls to <doc:tt>GetProfileForQualifier</doc:tt> |
| 459 |
will always match no profiles. |
| 460 |
</doc:para> |
| 461 |
<doc:para> |
| 462 |
This method will be used when creating profiles for devices, |
| 463 |
where the session color manager wants to be very sure that |
| 464 |
no profiles are being applied wen displaying color samples |
| 465 |
or printing color swatches. |
| 466 |
</doc:para> |
| 467 |
<doc:para> |
| 468 |
If the calling program exits without calling |
| 469 |
<doc:tt>ProfilingUninhibit</doc:tt> then the inhibit is |
| 470 |
automatically removed. |
| 471 |
</doc:para> |
| 472 |
</doc:description> |
| 473 |
</doc:doc> |
| 474 |
</method> |
| 475 |
|
| 476 |
<!--***********************************************************--> |
| 477 |
<method name='ProfilingUninhibit'> |
| 478 |
<doc:doc> |
| 479 |
<doc:description> |
| 480 |
<doc:para> |
| 481 |
Removes an inhibit on the device. |
| 482 |
This method should be used when profiling has finished and |
| 483 |
normal device matching behaviour should resume. |
| 484 |
</doc:para> |
| 485 |
</doc:description> |
| 486 |
</doc:doc> |
| 487 |
</method> |
| 488 |
|
| 489 |
<!--***********************************************************--> |
| 490 |
<method name='SetEnabled'> |
| 491 |
<doc:doc> |
| 492 |
<doc:description> |
| 493 |
<doc:para> |
| 494 |
Sets the device enable state. |
| 495 |
</doc:para> |
| 496 |
</doc:description> |
| 497 |
</doc:doc> |
| 498 |
<arg type='b' name='enabled' direction='in'> |
| 499 |
<doc:doc> |
| 500 |
<doc:summary> |
| 501 |
<doc:para> |
| 502 |
If the device is enabled. |
| 503 |
</doc:para> |
| 504 |
</doc:summary> |
| 505 |
</doc:doc> |
| 506 |
</arg> |
| 507 |
</method> |
| 508 |
|
| 509 |
</interface> |
| 510 |
</node> |