Warning, /graphics/colord-kde/colord-tmp-interfaces/org.freedesktop.ColorHelper.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.ColorHelper'> 0006 <doc:doc> 0007 <doc:description> 0008 <doc:para> 0009 The interface used for general calibration queries not related 0010 to specific device types, for example displays. 0011 </doc:para> 0012 </doc:description> 0013 </doc:doc> 0014 0015 <!--***********************************************************--> 0016 <property name='DaemonVersion' type='s' access='read'> 0017 <doc:doc> 0018 <doc:description> 0019 <doc:para> 0020 The daemon version. 0021 </doc:para> 0022 </doc:description> 0023 </doc:doc> 0024 </property> 0025 </interface> 0026 0027 <interface name='org.freedesktop.ColorHelper.Display'> 0028 <doc:doc> 0029 <doc:description> 0030 <doc:para> 0031 The interface used for calibrating displays. 0032 </doc:para> 0033 </doc:description> 0034 </doc:doc> 0035 0036 <!--***********************************************************--> 0037 <property name='Progress' type='u' access='read'> 0038 <doc:doc> 0039 <doc:description> 0040 <doc:para> 0041 The percentage complete of the calibration. 0042 </doc:para> 0043 </doc:description> 0044 </doc:doc> 0045 </property> 0046 0047 <!--***********************************************************--> 0048 <method name='Start'> 0049 <doc:doc> 0050 <doc:description> 0051 <doc:para> 0052 Starts the calibration. 0053 </doc:para> 0054 </doc:description> 0055 </doc:doc> 0056 <arg type='s' name='device_id' direction='in'> 0057 <doc:doc> 0058 <doc:summary> 0059 <doc:para> 0060 The device ID, e.g. <doc:tt>xrandr-LVDS1</doc:tt>. 0061 </doc:para> 0062 </doc:summary> 0063 </doc:doc> 0064 </arg> 0065 <arg type='s' name='profile_id' direction='in'> 0066 <doc:doc> 0067 <doc:summary> 0068 <doc:para> 0069 The profile ID, e.g. <doc:tt>sensor-colorhug</doc:tt>. 0070 </doc:para> 0071 </doc:summary> 0072 </doc:doc> 0073 </arg> 0074 <annotation name="org.qtproject.QtDBus.QtTypeName.In2" value="QVariantMap"/> 0075 <arg type='a{sv}' name='options' direction='in'> 0076 <doc:doc> 0077 <doc:summary> 0078 <doc:para> 0079 Optional parameters that will influence the calibration. 0080 Known keys are: 0081 <doc:tt>Quality</doc:tt> : (u) The calibration quality, where 0 is low, 1 is medium and 0082 2 is high. 0083 <doc:tt>Whitepoint</doc:tt> : (u) The target whitepoint in Kelvin, or 0 or native. 0084 <doc:tt>Title</doc:tt> : (s) The profile title, e.g. <doc:tt>Lenovo T61</doc:tt>. 0085 <doc:tt>DeviceKind</doc:tt> : (u) The CdSensorCap for the display. 0086 <doc:tt>Brightness</doc:tt> : (u) The display brightness. 0087 </doc:para> 0088 </doc:summary> 0089 </doc:doc> 0090 </arg> 0091 </method> 0092 0093 <!--***********************************************************--> 0094 <method name='Cancel'> 0095 <doc:doc> 0096 <doc:description> 0097 <doc:para> 0098 Cancel the calibration that is in progress. 0099 </doc:para> 0100 </doc:description> 0101 </doc:doc> 0102 </method> 0103 0104 <!--***********************************************************--> 0105 <method name='Resume'> 0106 <doc:doc> 0107 <doc:description> 0108 <doc:para> 0109 Resume the calibration that is in progress. 0110 </doc:para> 0111 </doc:description> 0112 </doc:doc> 0113 </method> 0114 0115 <!-- ************************************************************ --> 0116 <signal name='Finished'> 0117 <doc:doc> 0118 <doc:description> 0119 <doc:para> 0120 The calibration process has been completed. 0121 </doc:para> 0122 </doc:description> 0123 </doc:doc> 0124 <arg type='u' name='error_code' direction='out'> 0125 <doc:doc> 0126 <doc:summary> 0127 <doc:para> 0128 An error code, or 0 for no error. The error code is 0129 specified in CdMainError. 0130 </doc:para> 0131 </doc:summary> 0132 </doc:doc> 0133 </arg> 0134 <annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="QVariantMap"/> 0135 <arg type='a{sv}' name='details' direction='out'> 0136 <doc:doc> 0137 <doc:summary> 0138 <doc:para> 0139 Extra data from the calibration that may be useful to 0140 client software. 0141 Known keys are: 0142 <doc:tt>ProfileId</doc:tt> : (s) The ID of the profile. 0143 <doc:tt>ProfilePath</doc:tt> : (s) The object path of the profile. 0144 <doc:tt>ErrorDetails</doc:tt>: (s) Any untranslated error detail string. 0145 </doc:para> 0146 </doc:summary> 0147 </doc:doc> 0148 </arg> 0149 </signal> 0150 0151 <!-- ************************************************************ --> 0152 <signal name='UpdateSample'> 0153 <doc:doc> 0154 <doc:description> 0155 <doc:para> 0156 Emitted when the controller should update the RGB patch on 0157 the screen. The controller has 100ms to update the display. 0158 </doc:para> 0159 </doc:description> 0160 </doc:doc> 0161 <arg type='d' name='red' direction='out'> 0162 <doc:doc> 0163 <doc:summary> 0164 <doc:para> 0165 The red value from 0.0 to 1.0 0166 </doc:para> 0167 </doc:summary> 0168 </doc:doc> 0169 </arg> 0170 <arg type='d' name='green' direction='out'> 0171 <doc:doc> 0172 <doc:summary> 0173 <doc:para> 0174 The red value from 0.0 to 1.0 0175 </doc:para> 0176 </doc:summary> 0177 </doc:doc> 0178 </arg> 0179 <arg type='d' name='blue' direction='out'> 0180 <doc:doc> 0181 <doc:summary> 0182 <doc:para> 0183 The red value from 0.0 to 1.0 0184 </doc:para> 0185 </doc:summary> 0186 </doc:doc> 0187 </arg> 0188 </signal> 0189 0190 <!-- ************************************************************ --> 0191 <signal name='UpdateGamma'> 0192 <doc:doc> 0193 <doc:description> 0194 <doc:para> 0195 Emitted when the controller should update the gamma ramps 0196 for the screen. 0197 The controller has 50ms to update the display. 0198 </doc:para> 0199 </doc:description> 0200 </doc:doc> 0201 <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="CdGamaList"/> 0202 <arg type='a(ddd)' name='gamma' direction='out'> 0203 <doc:doc> 0204 <doc:summary> 0205 <doc:para> 0206 The red, green and blue ramps, which should be 0207 interpolated to match the display gamma size. 0208 </doc:para> 0209 </doc:summary> 0210 </doc:doc> 0211 </arg> 0212 </signal> 0213 0214 <!-- ************************************************************ --> 0215 <signal name='InteractionRequired'> 0216 <doc:doc> 0217 <doc:description> 0218 <doc:para> 0219 Emitted when the user needs to do something. 0220 </doc:para> 0221 </doc:description> 0222 </doc:doc> 0223 <arg type='u' name='code' direction='out'> 0224 <doc:doc> 0225 <doc:summary> 0226 <doc:para> 0227 The interaction code, where: 0228 0 = attach to screen 0229 1 = move to calibration mode. 0230 2 = move to surface mode. 0231 3 = shut the laptop lid. 0232 </doc:para> 0233 </doc:summary> 0234 </doc:doc> 0235 </arg> 0236 <arg type='s' name='message' direction='out'> 0237 <doc:doc> 0238 <doc:summary> 0239 <doc:para> 0240 Any debugging message for the interaction. 0241 </doc:para> 0242 </doc:summary> 0243 </doc:doc> 0244 </arg> 0245 <arg type='s' name='image' direction='out'> 0246 <doc:doc> 0247 <doc:summary> 0248 <doc:para> 0249 An image to show what interaction is required, or '' for 0250 no image available. 0251 </doc:para> 0252 </doc:summary> 0253 </doc:doc> 0254 </arg> 0255 </signal> 0256 0257 </interface> 0258 </node>