aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMichael Albinus2012-04-24 17:19:07 +0200
committerMichael Albinus2012-04-24 17:19:07 +0200
commitb613912badfb9050e6310ee14fddc90e0fd16b2c (patch)
tree4272e3287e843d565c07b06acd7d1d53ffae8a41 /doc
parent257440aa1c368048203a111db15f5a791a07f53f (diff)
downloademacs-b613912badfb9050e6310ee14fddc90e0fd16b2c.tar.gz
emacs-b613912badfb9050e6310ee14fddc90e0fd16b2c.zip
* notifications.el (notifications-interface)
(notifications-notify-method, notifications-notify) (notifications-close-notification-method): Fix docstring. (notifications-get-capabilities-method): New defconst. (notifications-get-capabilities): New defun. * os.texi: (Notifications): Add notifications-get-capabilities.
Diffstat (limited to 'doc')
-rw-r--r--doc/lispref/ChangeLog4
-rw-r--r--doc/lispref/os.texi39
2 files changed, 43 insertions, 0 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index cc5660653f6..3bb2abd7cfe 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,7 @@
12012-04-24 Michael Albinus <michael.albinus@gmx.de>
2
3 * os.texi: (Notifications): Add notifications-get-capabilities.
4
12012-04-20 Chong Yidong <cyd@gnu.org> 52012-04-20 Chong Yidong <cyd@gnu.org>
2 6
3 * processes.texi (Asynchronous Processes): Mention nil argument to 7 * processes.texi (Asynchronous Processes): Mention nil argument to
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi
index aae2e4434d7..424cddaff0a 100644
--- a/doc/lispref/os.texi
+++ b/doc/lispref/os.texi
@@ -2355,6 +2355,9 @@ by the user. The function receive the notification @var{id} and the closing
2355@end itemize 2355@end itemize
2356@end table 2356@end table
2357 2357
2358Which parameters are accepted by the notification server can be
2359checked via @code{notifications-get-capabilities}.
2360
2358This function returns a notification id, an integer, which can be used 2361This function returns a notification id, an integer, which can be used
2359to manipulate the notification item with 2362to manipulate the notification item with
2360@code{notifications-close-notification} or the @code{:replaces-id} 2363@code{notifications-close-notification} or the @code{:replaces-id}
@@ -2395,6 +2398,42 @@ A message window opens on the desktop. Press "I agree"
2395This function closes a notification with identifier @var{id}. 2398This function closes a notification with identifier @var{id}.
2396@end defun 2399@end defun
2397 2400
2401@defun notifications-get-capabilities
2402Returns the capabilities of the notification server, a list of strings.
2403The following capabilities can be expected:
2404
2405@table @asis
2406@item "actions"
2407The server will provide the specified actions to the user.
2408
2409@item "body"
2410Supports body text.
2411
2412@item "body-hyperlinks"
2413The server supports hyperlinks in the notifications.
2414
2415@item "body-images"
2416The server supports images in the notifications.
2417
2418@item "body-markup"
2419Supports markup in the body text.
2420
2421@item "icon-multi"
2422The server will render an animation of all the frames in a given image
2423array.
2424
2425@item "icon-static"
2426Supports display of exactly 1 frame of any given image array. This
2427value is mutually exclusive with "icon-multi".
2428
2429@item "sound"
2430The server supports sounds on notifications.
2431@end table
2432
2433Further vendor-specific caps start with "x-vendor", like "x-gnome-foo-cap".
2434@end defun
2435
2436
2398@node Dynamic Libraries 2437@node Dynamic Libraries
2399@section Dynamically Loaded Libraries 2438@section Dynamically Loaded Libraries
2400@cindex dynamic libraries 2439@cindex dynamic libraries