diff --git a/docs/notification-spec.xml b/docs/notification-spec.xml index 02e08e2..77eba43 100644 --- a/docs/notification-spec.xml +++ b/docs/notification-spec.xml @@ -278,8 +278,9 @@ Icon Data - Instead of overloading the icon field we now have an icon_data - field that is used when icon is blank. + Deprecated and should not be used in new + implementations. Use the Image Data hint instead. + @@ -452,13 +453,23 @@ Icons 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. - 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 per sample, channels and image data respectively. + + The image_path hint should be a string that contains the path to an image + to use, or a FreeDesktop.org icon name. + + + 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. + @@ -746,12 +757,28 @@ - "icon_data" + "image_path" + string + + 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). + + + + "image_data" (iiibiiay) This is a raw data image format which describes the width, height, rowstride, has alpha, bits per sample, channels and image data - respectively. We use this value if the icon field is left blank. + respectively. + + + + "icon_data" + (iiibiiay) + + Deprecated. Use image_data instead.