pidgin/gtknotify.h

   1 /* pidgin
   2  *
   3  * Pidgin is the legal property of its developers, whose names are too numerous
   4  * to list here.  Please refer to the COPYRIGHT file distributed with this
   5  * source distribution.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  20  */
  21
  22 #ifndef _PIDGINNOTIFY_H_
  23 #define _PIDGINNOTIFY_H_
  24 /**
  25  * SECTION:gtknotify
  26  * @section_id: pidgin-gtknotify
  27  * @short_description: <filename>gtknotify.h</filename>
  28  * @title: Notification API
  29  */
  30
  31 #include "notify.h"
  32 #include "pounce.h"
  33
  34 G_BEGIN_DECLS
  35
  36 /**
  37  * pidgin_notify_pounce_add:
  38  * @account:    The account
  39  * @pounce:     The pounce
  40  * @alias:              The buddy alias
  41  * @event:              Event description
  42  * @message:    Pounce message
  43  * @date:               Pounce date
  44  *
  45  * Adds a buddy pounce to the buddy pounce dialog
  46  */
  47 void pidgin_notify_pounce_add(PurpleAccount *account, PurplePounce *pounce,
  48                 const char *alias, const char *event, const char *message, const char *date);
  49
  50 /**
  51  * pidgin_notify_get_ui_ops:
  52  *
  53  * Returns the UI operations structure for GTK+ notification functions.
  54  *
  55  * Returns: The GTK+ UI notify operations structure.
  56  */
  57 PurpleNotifyUiOps *pidgin_notify_get_ui_ops(void);
  58
  59 /**
  60  * pidgin_notify_init:
  61  *
  62  * Initializes the GTK+ notifications subsystem.
  63  */
  64 void pidgin_notify_init(void);
  65
  66 /**
  67  * pidgin_notify_uninit:
  68  *
  69  * Uninitialized the GTK+ notifications subsystem.
  70  */
  71 void pidgin_notify_uninit(void);
  72
  73 /**
  74  * pidgin_notify_emails_pending:
  75  *
  76  * Returns TRUE if there are unseen emails, FALSE otherwise.
  77  *
  78  * Returns: TRUE if there are unseen emails, FALSE otherwise.
  79  */
  80 gboolean pidgin_notify_emails_pending(void);
  81
  82 /**
  83  * pidgin_notify_emails_present:
  84  *
  85  * Presents mail dialog to the user.
  86  */
  87 void pidgin_notify_emails_present(void *data);
  88
  89 G_END_DECLS
  90
  91 #endif /* _PIDGINNOTIFY_H_ */