jcarr
/
libnotify
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[spec] Deprecate icon_data in favor of image_data and image_path hints 

As discussed on the XDG list.
http://lists.freedesktop.org/archives/xdg/2009-June/010524.html
http://lists.freedesktop.org/archives/xdg/2009-June/010568.html
This commit is contained in:
A. Walton 2010-01-31 15:27:50 -05:00 committed by William Jon McCann
parent 9bc1f5d983
commit 5a08fb1ab7
1 changed files with 33 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
docs/notification-spec.xml
View File

@ -278,8 +278,9 @@
</seglistitem> </seglistitem>
<seglistitem> <seglistitem>
<seg>Icon Data</seg> <seg>Icon Data</seg>
<seg>Instead of overloading the icon field we now have an icon_data <seg>Deprecated and should not be used in new
field that is used when icon is blank.</seg> implementations. Use the Image Data hint instead.
</seg>
</seglistitem> </seglistitem>
</segmentedlist> </segmentedlist>
</entry> </entry>
@ -452,13 +453,23 @@
<title>Icons</title> <title>Icons</title>
<para> <para>
A notification can optionally have an icon specified by the Notification A notification can optionally have an icon specified by the Notification
Icon field or by the icon_data hint. Icon field or by the image_data or image_path hints.
</para> </para>
<para> <para>
The icon_data field should be a raw image data structure of signature The image_data field should be a raw image data structure of signature
(iiibiiay) which describes the width, height, rowstride, has alpha, bits (iiibiiay) which describes the width, height, rowstride, has alpha, bits
per sample, channels and image data respectively. per sample, channels and image data respectively.
</para> </para>
<para>
The image_path hint should be a string that contains the path to an image
to use, or a FreeDesktop.org icon name.
</para>
<para>
In existing implementations, a third deprecated hint "icon_data" may be
present, and is used similarly to the image_data hint. However,
new implementations should not use this hint, and existing
implementations should migrate to image_data instead.
</para>
</sect1> </sect1>
<sect1 id="categories" xreflabel="Categories"> <sect1 id="categories" xreflabel="Categories">
@ -746,12 +757,28 @@
</entry> </entry>
</row> </row>
<row> <row>
<entry><literal>"icon_data"</literal></entry> <entry><literal>"image_path"</literal></entry>
<entry>string</entry>
<entry>
This is represented either as a URI (file:// is the only URI
schema supported right now) or a name in a
freedesktop.org-compliant icon theme (not a GTK+ stock ID).
</entry>
</row>
<row>
<entry><literal>"image_data"</literal></entry>
<entry>(iiibiiay)</entry> <entry>(iiibiiay)</entry>
<entry> <entry>
This is a raw data image format which describes the width, height, This is a raw data image format which describes the width, height,
rowstride, has alpha, bits per sample, channels and image data rowstride, has alpha, bits per sample, channels and image data
respectively. We use this value if the icon field is left blank. respectively.
</entry>
</row>
<row>
<entry><literal>"icon_data"</literal></entry>
<entry>(iiibiiay)</entry>
<entry>
<emphasis>Deprecated</emphasis>. Use image_data instead.
</entry> </entry>
</row> </row>
<row> <row>