diff options
| author | A. Walton <awalton@gnome.org> | 2010-01-31 15:43:10 -0500 |
|---|---|---|
| committer | William Jon McCann <jmccann@redhat.com> | 2010-01-31 15:43:10 -0500 |
| commit | b6c250fcb9011fc8189cd043f0bedff7052c86ac (patch) | |
| tree | 2cb5a6e8cb859c0c3c4275af5bbdeaaeb7972388 | |
| parent | b42a41d5ec68f028d672e46b52dab9367abd4ffe (diff) | |
| download | libnotify-b6c250fcb9011fc8189cd043f0bedff7052c86ac.tar.gz | |
[spec] Clarify image_data/path precidence
Image Data should be considered before Image Path if both are
present (which they shouldn't be, but isn't a hard error).
| -rw-r--r-- | docs/notification-spec.xml | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/docs/notification-spec.xml b/docs/notification-spec.xml index 4b65177..667f82b 100644 --- a/docs/notification-spec.xml +++ b/docs/notification-spec.xml @@ -456,13 +456,20 @@ Icon field or by the image_data or image_path hints. </para> <para> - The image_data field should be a raw image data structure of signature + The image_data hint 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. + per sample, channels and image data respectively. If an implementation + cannot display multiple icons then image_data should be preferred over + the Notification Icon field, as this icon is generally used to provide + more specific information about the notification (for example, a chat + application may use this field for a contact's icon). </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. + to use, or a FreeDesktop.org icon name. For the same reasons as above + this icon should be used before the icon specified in the Notification Icon + field if present. If the image_data hint is present, this hint should + be ignored. </para> <para> In existing implementations, a third deprecated hint "icon_data" may be |