Warning, /graphics/colord-kde/colord-tmp-interfaces/org.freedesktop.ColorManager.Device.xml is written in an unsupported language. File is not indexed.
0001 <!DOCTYPE node PUBLIC 0002 "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" 0003 "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd"> 0004 <node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd"> 0005 <interface name='org.freedesktop.ColorManager.Device'> 0006 <doc:doc> 0007 <doc:description> 0008 <doc:para> 0009 The interface used for quering color parameters for a specific device. 0010 </doc:para> 0011 </doc:description> 0012 </doc:doc> 0013 0014 <!--***********************************************************--> 0015 <property name='Created' type='t' access='read'> 0016 <doc:doc> 0017 <doc:description> 0018 <doc:para> 0019 The date the device was created. 0020 </doc:para> 0021 </doc:description> 0022 </doc:doc> 0023 </property> 0024 0025 <!--***********************************************************--> 0026 <property name='Modified' type='t' access='read'> 0027 <doc:doc> 0028 <doc:description> 0029 <doc:para> 0030 The date the device was last modified, which in this 0031 instance means having a profile added or removed, or a 0032 different profile set as default. 0033 </doc:para> 0034 </doc:description> 0035 </doc:doc> 0036 </property> 0037 0038 <!--***********************************************************--> 0039 <property name='Model' type='s' access='read'> 0040 <doc:doc> 0041 <doc:description> 0042 <doc:para> 0043 The device model string. 0044 </doc:para> 0045 </doc:description> 0046 </doc:doc> 0047 </property> 0048 0049 <!--***********************************************************--> 0050 <property name='Serial' type='s' access='read'> 0051 <doc:doc> 0052 <doc:description> 0053 <doc:para> 0054 The device serial string. 0055 </doc:para> 0056 </doc:description> 0057 </doc:doc> 0058 </property> 0059 0060 <!--***********************************************************--> 0061 <property name='Vendor' type='s' access='read'> 0062 <doc:doc> 0063 <doc:description> 0064 <doc:para> 0065 The device vendor string. 0066 </doc:para> 0067 </doc:description> 0068 </doc:doc> 0069 </property> 0070 0071 <!--***********************************************************--> 0072 <property name='Colorspace' type='s' access='read'> 0073 <doc:doc> 0074 <doc:description> 0075 <doc:para> 0076 The device supported colorspace string, e.g. <doc:tt>RGB</doc:tt>. 0077 </doc:para> 0078 </doc:description> 0079 </doc:doc> 0080 </property> 0081 0082 <!--***********************************************************--> 0083 <property name='Kind' type='s' access='read'> 0084 <doc:doc> 0085 <doc:description> 0086 <doc:para> 0087 The device kind, e.g. <doc:tt>scanner</doc:tt>, 0088 <doc:tt>display</doc:tt>, <doc:tt>printer</doc:tt> or 0089 <doc:tt>camera</doc:tt> 0090 </doc:para> 0091 </doc:description> 0092 </doc:doc> 0093 </property> 0094 0095 <!--***********************************************************--> 0096 <property name='DeviceId' type='s' access='read'> 0097 <doc:doc> 0098 <doc:description> 0099 <doc:para> 0100 The device id string. 0101 </doc:para> 0102 </doc:description> 0103 </doc:doc> 0104 </property> 0105 0106 <!--***********************************************************--> 0107 <property name='Profiles' type='ao' access='read'> 0108 <doc:doc> 0109 <doc:description> 0110 <doc:para> 0111 The profile paths associated with this device. 0112 Profiles are returned even if the device is disabled or 0113 is profiling, and clients should not assume that the first 0114 profile in this array should be applied. 0115 </doc:para> 0116 </doc:description> 0117 </doc:doc> 0118 </property> 0119 0120 <!--***********************************************************--> 0121 <property name='Mode' type='s' access='read'> 0122 <doc:doc> 0123 <doc:description> 0124 <doc:para> 0125 The mode of the device, e.g. <doc:tt>virtual</doc:tt>, 0126 <doc:tt>physical</doc:tt> or <doc:tt>unknown</doc:tt>. 0127 </doc:para> 0128 <doc:para> 0129 Virtual devices are not tied to a specific item of hardware 0130 and can represent abstract devices such as "Boots Photo Lab". 0131 </doc:para> 0132 <doc:para> 0133 Physical devices correspond to a connected device that 0134 cannot be removed by client software. 0135 </doc:para> 0136 <doc:para> 0137 If a virtual 'disk' device gets added by a client then it 0138 is promoted to a 'physical' device. 0139 This can happen if a printer is saved and then restored at 0140 next boot before the CUPS daemon is running. 0141 </doc:para> 0142 </doc:description> 0143 </doc:doc> 0144 </property> 0145 0146 <!--***********************************************************--> 0147 <property name='Format' type='s' access='read'> 0148 <doc:doc> 0149 <doc:description> 0150 <doc:para> 0151 The qualifier format for the device, e.g. 0152 <doc:tt>ColorModel.OutputMode.OutputResolution</doc:tt>. 0153 </doc:para> 0154 </doc:description> 0155 </doc:doc> 0156 </property> 0157 0158 <!--***********************************************************--> 0159 <property name='Scope' type='s' access='read'> 0160 <doc:doc> 0161 <doc:description> 0162 <doc:para> 0163 The scope of the device, e.g. <doc:tt>normal</doc:tt>, 0164 <doc:tt>temp</doc:tt> or <doc:tt>disk</doc:tt>. 0165 </doc:para> 0166 </doc:description> 0167 </doc:doc> 0168 </property> 0169 0170 <!--***********************************************************--> 0171 <property name='Owner' type='u' access='read'> 0172 <doc:doc> 0173 <doc:description> 0174 <doc:para> 0175 The user ID of the account that created the device. 0176 </doc:para> 0177 </doc:description> 0178 </doc:doc> 0179 </property> 0180 0181 <!--***********************************************************--> 0182 <property name='Enabled' type='b' access='read'> 0183 <doc:doc> 0184 <doc:description> 0185 <doc:para> 0186 If the device is enabled. Devices are enabled by default 0187 until <doc:tt>Device.SetEnabled(False)</doc:tt> is called. 0188 If the enabled state is changed then this is reflected for 0189 all users and persistent across reboots. 0190 </doc:para> 0191 </doc:description> 0192 </doc:doc> 0193 </property> 0194 0195 <!--***********************************************************--> 0196 <property name='Seat' type='s' access='read'> 0197 <doc:doc> 0198 <doc:description> 0199 <doc:para> 0200 The seat that the device belongs to, or an empty string for 0201 none or unknown. 0202 </doc:para> 0203 </doc:description> 0204 </doc:doc> 0205 </property> 0206 0207 <!--***********************************************************--> 0208 <property name='Embedded' type='b' access='read'> 0209 <doc:doc> 0210 <doc:description> 0211 <doc:para> 0212 If the device is embedded into the hardware itself, for 0213 example the internal webcam or laptop screen. 0214 </doc:para> 0215 </doc:description> 0216 </doc:doc> 0217 </property> 0218 0219 <!--***********************************************************--> 0220 <property name='Metadata' type='a{ss}' access='read'> 0221 <annotation name="org.qtproject.QtDBus.QtTypeName" value="CdStringMap"/> 0222 <doc:doc> 0223 <doc:description> 0224 <doc:para> 0225 The metadata for the device, which may include optional 0226 keys like <doc:tt>XRANDR_name</doc:tt>. 0227 </doc:para> 0228 </doc:description> 0229 </doc:doc> 0230 </property> 0231 0232 <!--***********************************************************--> 0233 <property name='ProfilingInhibitors' type='as' access='read'> 0234 <doc:doc> 0235 <doc:description> 0236 <doc:para> 0237 The bus names of all the clients that have inhibited the 0238 device for profiling. e.g. <doc:tt>[ ":1.99", ":1.109" ]</doc:tt> 0239 </doc:para> 0240 </doc:description> 0241 </doc:doc> 0242 </property> 0243 0244 <!--***********************************************************--> 0245 <method name='SetProperty'> 0246 <doc:doc> 0247 <doc:description> 0248 <doc:para> 0249 Sets a property on the object. 0250 </doc:para> 0251 </doc:description> 0252 </doc:doc> 0253 <arg type='s' name='property_name' direction='in'> 0254 <doc:doc> 0255 <doc:summary> 0256 <doc:para> 0257 The property name, e.g. <doc:tt>Model</doc:tt>. 0258 </doc:para> 0259 </doc:summary> 0260 </doc:doc> 0261 </arg> 0262 <arg type='s' name='property_value' direction='in'> 0263 <doc:doc> 0264 <doc:summary> 0265 <doc:para> 0266 The property value, e.g. <doc:tt>RGB.Plain.</doc:tt>. 0267 </doc:para> 0268 </doc:summary> 0269 </doc:doc> 0270 </arg> 0271 </method> 0272 0273 <!-- ************************************************************ --> 0274 <signal name='Changed'> 0275 <doc:doc> 0276 <doc:description> 0277 <doc:para> 0278 Some value on the interface has changed. 0279 </doc:para> 0280 </doc:description> 0281 </doc:doc> 0282 </signal> 0283 0284 <!--***********************************************************--> 0285 <method name='AddProfile'> 0286 <doc:doc> 0287 <doc:description> 0288 <doc:para> 0289 Adds a profile to the device. The profile must have been 0290 previously created. 0291 </doc:para> 0292 <doc:para> 0293 This method also stores the device to profile mapping in a 0294 persistent datadase, so that if the device and profile 0295 happen to both exist in the future, the profiles are 0296 auto-added to the device. 0297 </doc:para> 0298 </doc:description> 0299 </doc:doc> 0300 <arg type='s' name='relation' direction='in'> 0301 <doc:doc> 0302 <doc:summary> 0303 <doc:para> 0304 The strength of the relationship from profile to device. 0305 This can be <doc:tt>soft</doc:tt> to indicate that the 0306 mapping is not important, or that the profile is assumed 0307 from a device and not in response to user action. 0308 <doc:para> 0309 </doc:para> 0310 The default option is <doc:tt>hard</doc:tt>, and this 0311 means that the user has explicitly mapped a profile to 0312 a device, and this should take precidence over any 0313 <doc:tt>soft</doc:tt> profiles. 0314 </doc:para> 0315 <doc:para> 0316 If the user makes a <doc:tt>soft</doc:tt> profile default, 0317 then it is explicitly promoted to a <doc:tt>hard</doc:tt> 0318 relationship. 0319 </doc:para> 0320 </doc:summary> 0321 </doc:doc> 0322 </arg> 0323 <arg type='o' name='object_path' direction='in'> 0324 <doc:doc> 0325 <doc:summary> 0326 <doc:para> 0327 The profile path to add. 0328 </doc:para> 0329 </doc:summary> 0330 </doc:doc> 0331 </arg> 0332 </method> 0333 0334 <!--***********************************************************--> 0335 <method name='RemoveProfile'> 0336 <doc:doc> 0337 <doc:description> 0338 <doc:para> 0339 Removes a profile for a device. 0340 </doc:para> 0341 <doc:para> 0342 This method also removes the device to profile mapping from 0343 a persistent datadase, so that if the device and profile 0344 happen to both exist in the future, the profiles are 0345 no longer auto-added to the device. 0346 </doc:para> 0347 <doc:para> 0348 If the profile was automatically added due to metadata in 0349 the profile (e.g. the profile was created for the device) 0350 then manually removing the profile will cause this metadata 0351 add to be supressed. 0352 This allows the user to remove old or obsolete profiles 0353 from any color control panel without having to delete them. 0354 </doc:para> 0355 </doc:description> 0356 </doc:doc> 0357 <arg type='o' name='object_path' direction='in'> 0358 <doc:doc> 0359 <doc:summary> 0360 <doc:para> 0361 The profile path that has already been added to the device. 0362 </doc:para> 0363 </doc:summary> 0364 </doc:doc> 0365 </arg> 0366 </method> 0367 0368 <!--***********************************************************--> 0369 <method name='MakeProfileDefault'> 0370 <doc:doc> 0371 <doc:description> 0372 <doc:para> 0373 Sets the default profile for a device. 0374 </doc:para> 0375 </doc:description> 0376 </doc:doc> 0377 <arg type='o' name='profile_path' direction='in'> 0378 <doc:doc> 0379 <doc:summary> 0380 <doc:para> 0381 The profile path that has already been added to the device. 0382 </doc:para> 0383 </doc:summary> 0384 </doc:doc> 0385 </arg> 0386 </method> 0387 0388 <!--***********************************************************--> 0389 <method name='GetProfileForQualifiers'> 0390 <doc:doc> 0391 <doc:description> 0392 <doc:para> 0393 Gets a single profile object path for a qualifier. 0394 The search term can contain '*' and '?' wildcards. 0395 </doc:para> 0396 </doc:description> 0397 </doc:doc> 0398 <arg type='as' name='qualifiers' direction='in'> 0399 <doc:doc> 0400 <doc:summary> 0401 <doc:para> 0402 An array of qualifiers, e.g. <doc:tt>['RGB.*.300dpi', 'RGB.*.*', '*.*.*']</doc:tt>. 0403 </doc:para> 0404 <doc:para> 0405 If the qualifier <doc:tt>*</doc:tt> is specified then 0406 the default profile is returned. 0407 </doc:para> 0408 </doc:summary> 0409 </doc:doc> 0410 </arg> 0411 <arg type='o' name='object_path' direction='out'> 0412 <doc:doc> 0413 <doc:summary> 0414 <doc:para> 0415 The profile path for the search terms. 0416 </doc:para> 0417 </doc:summary> 0418 </doc:doc> 0419 </arg> 0420 </method> 0421 0422 <!--***********************************************************--> 0423 <method name='GetProfileRelation'> 0424 <doc:doc> 0425 <doc:description> 0426 <doc:para> 0427 Gets a profile relation for a given profile that has been 0428 added to this device. 0429 </doc:para> 0430 </doc:description> 0431 </doc:doc> 0432 <arg type='o' name='object_path' direction='in'> 0433 <doc:doc> 0434 <doc:summary> 0435 <doc:para> 0436 A profile object path. 0437 </doc:para> 0438 </doc:summary> 0439 </doc:doc> 0440 </arg> 0441 <arg type='s' name='relation' direction='out'> 0442 <doc:doc> 0443 <doc:summary> 0444 <doc:para> 0445 The profile to device relation, e.g. <doc:tt>hard</doc:tt>. 0446 </doc:para> 0447 </doc:summary> 0448 </doc:doc> 0449 </arg> 0450 </method> 0451 0452 <!--***********************************************************--> 0453 <method name='ProfilingInhibit'> 0454 <doc:doc> 0455 <doc:description> 0456 <doc:para> 0457 Adds an inhibit on all profiles for this device. This means 0458 that any calls to <doc:tt>GetProfileForQualifier</doc:tt> 0459 will always match no profiles. 0460 </doc:para> 0461 <doc:para> 0462 This method will be used when creating profiles for devices, 0463 where the session color manager wants to be very sure that 0464 no profiles are being applied wen displaying color samples 0465 or printing color swatches. 0466 </doc:para> 0467 <doc:para> 0468 If the calling program exits without calling 0469 <doc:tt>ProfilingUninhibit</doc:tt> then the inhibit is 0470 automatically removed. 0471 </doc:para> 0472 </doc:description> 0473 </doc:doc> 0474 </method> 0475 0476 <!--***********************************************************--> 0477 <method name='ProfilingUninhibit'> 0478 <doc:doc> 0479 <doc:description> 0480 <doc:para> 0481 Removes an inhibit on the device. 0482 This method should be used when profiling has finished and 0483 normal device matching behaviour should resume. 0484 </doc:para> 0485 </doc:description> 0486 </doc:doc> 0487 </method> 0488 0489 <!--***********************************************************--> 0490 <method name='SetEnabled'> 0491 <doc:doc> 0492 <doc:description> 0493 <doc:para> 0494 Sets the device enable state. 0495 </doc:para> 0496 </doc:description> 0497 </doc:doc> 0498 <arg type='b' name='enabled' direction='in'> 0499 <doc:doc> 0500 <doc:summary> 0501 <doc:para> 0502 If the device is enabled. 0503 </doc:para> 0504 </doc:summary> 0505 </doc:doc> 0506 </arg> 0507 </method> 0508 0509 </interface> 0510 </node>