doc/notify-signals.dox

   1 /** @page notify-signals Notification Signals
   2
   3  @signals
   4   @signal displaying-userinfo
   5   @signal displaying-email-notification
   6   @signal displaying-emails-notification
   7  @endsignals
   8
   9  @see notify.h
  10
  11  @signaldef displaying-userinfo
  12   @signalproto
  13 void (*displaying_userinfo)(PurpleAccount *account, const char *who, PurpleNotifyUserInfo *user_info);
  14   @endsignalproto
  15   @signaldesc
  16    Emitted before userinfo is handed to the UI to display.
  17    @a user_info can be manipulated via the PurpleNotifyUserInfo API in notify.c.
  18   @note
  19     If adding a PurpleNotifyUserInfoEntry, be sure not to free it -- PurpleNotifyUserInfo assumes responsibility for its objects.
  20   @param account   The account on which the info was obtained.
  21   @param who       The name of the buddy whose info is to be displayed.
  22   @param user_info The information to be displayed, as PurpleNotifyUserInfoEntry objects
  23  @endsignaldef
  24
  25  @signaldef displaying-email-notification
  26   @signalproto
  27 void (*displaying_email_notification)(const char *subject,
  28                                       const char *from,
  29                                       const char *to,
  30                                       const char *url);
  31   @endsignalproto
  32   @signaldesc
  33    Emitted before notification of a single email is handed to the UI to display.
  34   @param subject   Subject of email being notified of.
  35   @param from      Who the email is from.
  36   @param to        Who the email is to.
  37   @param url       A url to view the email.
  38   @since 2.1.0
  39  @endsignaldef
  40
  41  @signaldef displaying-emails-notification
  42   @signalproto
  43 void (*displaying_emails_notification)(const char **subjects,
  44                                        const char **froms,
  45                                        const char **tos,
  46                                        const char **urls,
  47                                        guint count);
  48   @endsignalproto
  49   @signaldesc
  50    Emitted before notification of multiple emails is handed to the UI to display.
  51   @param subjects   Subjects of emails being notified of.
  52   @param froms      Who the emails are from.
  53   @param tos        Who the emails are to.
  54   @param urls       The urls to view the emails.
  55   @param count      Number of emails being notified of.
  56   @since 2.1.0
  57  @endsignaldef
  58
  59 */
  60 // vim: syntax=c.doxygen tw=75 et