summaryrefslogtreecommitdiff
path: root/src/org.freedesktop.ColorManager.Profile.xml
blob: c38ec8955d31b00f6ddebf0c3a3785a7fd8e6f22 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
<!DOCTYPE node PUBLIC
"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"https://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<node name="/" xmlns:doc="https://www.freedesktop.org/dbus/1.0/doc.dtd">
  <interface name='org.freedesktop.ColorManager.Profile'>
    <doc:doc>
      <doc:description>
        <doc:para>
          The interface used for quering color profiles.
        </doc:para>
      </doc:description>
    </doc:doc>

    <!--***********************************************************-->
    <property name='ProfileId' type='s' access='read'>
      <doc:doc>
        <doc:description>
          <doc:para>
            The identification hash of the profile.
          </doc:para>
        </doc:description>
      </doc:doc>
    </property>

    <!--***********************************************************-->
    <property name='Title' type='s' access='read'>
      <doc:doc>
        <doc:description>
          <doc:para>
            The printable title for the profile.
          </doc:para>
        </doc:description>
      </doc:doc>
    </property>

    <!--***********************************************************-->
    <property name='Metadata' type='a{ss}' access='read'>
      <annotation name="org.qtproject.QtDBus.QtTypeName" value="CdStringMap"/>
      <doc:doc>
        <doc:description>
          <doc:para>
            The metadata for the profile, which may include optional
            keys like <doc:tt>EDID_md5</doc:tt> and
            <doc:tt>EDID_manufacturer</doc:tt> that are set by several
            CMS frameworks.
          </doc:para>
        </doc:description>
      </doc:doc>
    </property>

    <!--***********************************************************-->
    <property name='Qualifier' type='s' access='read'>
      <doc:doc>
        <doc:description>
          <doc:para>
            The qualifier for the profile.
            A qualifier is used as a way to select a profile for a device.
            This might be something free text like
            <doc:tt>High quality studio</doc:tt>doc:tt> or something more
            programmable like <doc:tt>RGB.Plain.300dpi</doc:tt>.
          </doc:para>
        </doc:description>
      </doc:doc>
    </property>

    <!--***********************************************************-->
    <property name='Format' type='s' access='read'>
      <doc:doc>
        <doc:description>
          <doc:para>
            The qualifier format for the profile.
          </doc:para>
        </doc:description>
      </doc:doc>
    </property>

    <!--***********************************************************-->
    <property name='Kind' type='s' access='read'>
      <doc:doc>
        <doc:description>
          <doc:para>
            The profile kind, e.g. <doc:tt>colorspace-conversion</doc:tt>,
            <doc:tt>abstract</doc:tt> or <doc:tt>display-device</doc:tt>.
          </doc:para>
        </doc:description>
      </doc:doc>
    </property>

    <!--***********************************************************-->
    <property name='Colorspace' type='s' access='read'>
      <doc:doc>
        <doc:description>
          <doc:para>
            The profile colorspace, e.g. <doc:tt>rgb</doc:tt>.
          </doc:para>
        </doc:description>
      </doc:doc>
    </property>

    <!--***********************************************************-->
    <property name='HasVcgt' type='b' access='read'>
      <doc:doc>
        <doc:description>
          <doc:para>
            If the profile has a VCGT entry.
          </doc:para>
        </doc:description>
      </doc:doc>
    </property>

    <!--***********************************************************-->
    <property name='IsSystemWide' type='b' access='read'>
      <doc:doc>
        <doc:description>
          <doc:para>
            If the profile is installed system wide and available
            for all users.
          </doc:para>
        </doc:description>
      </doc:doc>
    </property>

    <!--***********************************************************-->
    <property name='Filename' type='s' access='read'>
      <doc:doc>
        <doc:description>
          <doc:para>
            The profile filename, if one exists.
          </doc:para>
        </doc:description>
      </doc:doc>
    </property>

    <!--***********************************************************-->
    <property name='Created' type='x' access='read'>
      <doc:doc>
        <doc:description>
          <doc:para>
            The date and time the profile was created in UNIX time.
          </doc:para>
          <doc:para>
            NOTE: this is NOT the time the meta-profile was created,
            or added to colord, nor the disk timestamp for the profile
            filename.
            This is the encoded date and time inside the ICC filename.
          </doc:para>
        </doc:description>
      </doc:doc>
    </property>

    <!--***********************************************************-->
    <property name='Scope' type='s' access='read'>
      <doc:doc>
        <doc:description>
          <doc:para>
            The scope of the device, e.g. <doc:tt>normal</doc:tt>,
            <doc:tt>temp</doc:tt> or <doc:tt>disk</doc:tt>.
          </doc:para>
        </doc:description>
      </doc:doc>
    </property>

    <!--***********************************************************-->
    <property name='Owner' type='u' access='read'>
      <doc:doc>
        <doc:description>
          <doc:para>
            The user ID of the account that created the profile.
          </doc:para>
        </doc:description>
      </doc:doc>
    </property>

    <!--***********************************************************-->
    <property name='Warnings' type='as' access='read'>
      <doc:doc>
        <doc:description>
          <doc:para>
            Any warnings for the profile, e.g.
            '<doc:tt>description-missing</doc:tt>' or
            '<doc:tt>vcgt-non-monotonic</doc:tt>'.
          </doc:para>
        </doc:description>
      </doc:doc>
    </property>

    <!--***********************************************************-->
    <method name='SetProperty'>
      <doc:doc>
        <doc:description>
          <doc:para>
            Sets a property on the object.
          </doc:para>
        </doc:description>
      </doc:doc>
      <arg type='s' name='property_name' direction='in'>
        <doc:doc>
          <doc:summary>
            <doc:para>
              The property name, e.g. <doc:tt>Filename</doc:tt>,
              or <doc:tt>Qualifier</doc:tt>.
            </doc:para>
          </doc:summary>
        </doc:doc>
      </arg>
      <arg type='s' name='property_value' direction='in'>
        <doc:doc>
          <doc:summary>
            <doc:para>
              The property value, e.g. <doc:tt>RGB.Plain.</doc:tt>.
            </doc:para>
          </doc:summary>
        </doc:doc>
      </arg>
    </method>

    <!--***********************************************************-->
    <method name='InstallSystemWide'>
      <doc:doc>
        <doc:description>
          <doc:para>
            Copies the profile system-wide so it can be used by all
            users on the system or when no users are logged-in.
          </doc:para>
        </doc:description>
      </doc:doc>
    </method>

    <!-- ************************************************************ -->
    <signal name='Changed'>
      <doc:doc>
        <doc:description>
          <doc:para>
            Some value on the interface has changed.
          </doc:para>
        </doc:description>
      </doc:doc>
    </signal>

  </interface>
</node>