Debian Codegraph @

src/org.freedesktop.ColorManager.Profile.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.Profile'>
6 <doc:doc>
7 <doc:description>
8 <doc:para>
9 The interface used for querying color profiles.
10 </doc:para>
11 </doc:description>
12 </doc:doc>
13
14 <!--***********************************************************-->
15 <property name='ProfileId' type='s' access='read'>
16 <doc:doc>
17 <doc:description>
18 <doc:para>
19 The identification hash of the profile.
20 </doc:para>
21 </doc:description>
22 </doc:doc>
23 </property>
24
25 <!--***********************************************************-->
26 <property name='Title' type='s' access='read'>
27 <doc:doc>
28 <doc:description>
29 <doc:para>
30 The printable title for the profile.
31 </doc:para>
32 </doc:description>
33 </doc:doc>
34 </property>
35
36 <!--***********************************************************-->
37 <property name='Metadata' type='a{ss}' access='read'>
38 <annotation name="org.qtproject.QtDBus.QtTypeName" value="CdStringMap"/>
39 <doc:doc>
40 <doc:description>
41 <doc:para>
42 The metadata for the profile, which may include optional
43 keys like <doc:tt>EDID_md5</doc:tt> and
44 <doc:tt>EDID_manufacturer</doc:tt> that are set by several
45 CMS frameworks.
46 </doc:para>
47 </doc:description>
48 </doc:doc>
49 </property>
50
51 <!--***********************************************************-->
52 <property name='Qualifier' type='s' access='read'>
53 <doc:doc>
54 <doc:description>
55 <doc:para>
56 The qualifier for the profile.
57 A qualifier is used as a way to select a profile for a device.
58 This might be something free text like
59 <doc:tt>High quality studio</doc:tt>doc:tt> or something more
60 programmable like <doc:tt>RGB.Plain.300dpi</doc:tt>.
61 </doc:para>
62 </doc:description>
63 </doc:doc>
64 </property>
65
66 <!--***********************************************************-->
67 <property name='Format' type='s' access='read'>
68 <doc:doc>
69 <doc:description>
70 <doc:para>
71 The qualifier format for the profile.
72 </doc:para>
73 </doc:description>
74 </doc:doc>
75 </property>
76
77 <!--***********************************************************-->
78 <property name='Kind' type='s' access='read'>
79 <doc:doc>
80 <doc:description>
81 <doc:para>
82 The profile kind, e.g. <doc:tt>colorspace-conversion</doc:tt>,
83 <doc:tt>abstract</doc:tt> or <doc:tt>display-device</doc:tt>.
84 </doc:para>
85 </doc:description>
86 </doc:doc>
87 </property>
88
89 <!--***********************************************************-->
90 <property name='Colorspace' type='s' access='read'>
91 <doc:doc>
92 <doc:description>
93 <doc:para>
94 The profile colorspace, e.g. <doc:tt>rgb</doc:tt>.
95 </doc:para>
96 </doc:description>
97 </doc:doc>
98 </property>
99
100 <!--***********************************************************-->
101 <property name='HasVcgt' type='b' access='read'>
102 <doc:doc>
103 <doc:description>
104 <doc:para>
105 If the profile has a VCGT entry.
106 </doc:para>
107 </doc:description>
108 </doc:doc>
109 </property>
110
111 <!--***********************************************************-->
112 <property name='IsSystemWide' type='b' access='read'>
113 <doc:doc>
114 <doc:description>
115 <doc:para>
116 If the profile is installed system wide and available
117 for all users.
118 </doc:para>
119 </doc:description>
120 </doc:doc>
121 </property>
122
123 <!--***********************************************************-->
124 <property name='Filename' type='s' access='read'>
125 <doc:doc>
126 <doc:description>
127 <doc:para>
128 The profile filename, if one exists.
129 </doc:para>
130 </doc:description>
131 </doc:doc>
132 </property>
133
134 <!--***********************************************************-->
135 <property name='Created' type='x' access='read'>
136 <doc:doc>
137 <doc:description>
138 <doc:para>
139 The date and time the profile was created in UNIX time.
140 </doc:para>
141 <doc:para>
142 NOTE: this is NOT the time the meta-profile was created,
143 or added to colord, nor the disk timestamp for the profile
144 filename.
145 This is the encoded date and time inside the ICC filename.
146 </doc:para>
147 </doc:description>
148 </doc:doc>
149 </property>
150
151 <!--***********************************************************-->
152 <property name='Scope' type='s' access='read'>
153 <doc:doc>
154 <doc:description>
155 <doc:para>
156 The scope of the device, e.g. <doc:tt>normal</doc:tt>,
157 <doc:tt>temp</doc:tt> or <doc:tt>disk</doc:tt>.
158 </doc:para>
159 </doc:description>
160 </doc:doc>
161 </property>
162
163 <!--***********************************************************-->
164 <property name='Owner' type='u' access='read'>
165 <doc:doc>
166 <doc:description>
167 <doc:para>
168 The user ID of the account that created the profile.
169 </doc:para>
170 </doc:description>
171 </doc:doc>
172 </property>
173
174 <!--***********************************************************-->
175 <property name='Warnings' type='as' access='read'>
176 <doc:doc>
177 <doc:description>
178 <doc:para>
179 Any warnings for the profile, e.g.
180 '<doc:tt>description-missing</doc:tt>' or
181 '<doc:tt>vcgt-non-monotonic</doc:tt>'.
182 </doc:para>
183 </doc:description>
184 </doc:doc>
185 </property>
186
187 <!--***********************************************************-->
188 <method name='SetProperty'>
189 <doc:doc>
190 <doc:description>
191 <doc:para>
192 Sets a property on the object.
193 </doc:para>
194 </doc:description>
195 </doc:doc>
196 <arg type='s' name='property_name' direction='in'>
197 <doc:doc>
198 <doc:summary>
199 <doc:para>
200 The property name, e.g. <doc:tt>Filename</doc:tt>,
201 or <doc:tt>Qualifier</doc:tt>.
202 </doc:para>
203 </doc:summary>
204 </doc:doc>
205 </arg>
206 <arg type='s' name='property_value' direction='in'>
207 <doc:doc>
208 <doc:summary>
209 <doc:para>
210 The property value, e.g. <doc:tt>RGB.Plain.</doc:tt>.
211 </doc:para>
212 </doc:summary>
213 </doc:doc>
214 </arg>
215 </method>
216
217 <!--***********************************************************-->
218 <method name='InstallSystemWide'>
219 <doc:doc>
220 <doc:description>
221 <doc:para>
222 Copies the profile system-wide so it can be used by all
223 users on the system or when no users are logged-in.
224 </doc:para>
225 </doc:description>
226 </doc:doc>
227 </method>
228
229 <!-- ************************************************************ -->
230 <signal name='Changed'>
231 <doc:doc>
232 <doc:description>
233 <doc:para>
234 Some value on the interface has changed.
235 </doc:para>
236 </doc:description>
237 </doc:doc>
238 </signal>
239
240 </interface>
241 </node>