libpurple/plugins/notify_example.c

   1 /*
   2  * Notify API Example Plugin
   3  *
   4  * Copyright (C) 2007, John Bailey <rekkanoryo@cpw.pidgin.im>
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License as
   8  * published by the Free Software Foundation; either version 2 of the
   9  * License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19  * 02111-1301, USA.
  20  *
  21  */
  22
  23 /* When writing a third-party plugin, do not include libpurple's internal.h
  24  * included below. This file is for internal libpurple use only. We're including
  25  * it here for our own convenience. */
  26 #include "internal.h"
  27
  28 /* This file defines PURPLE_PLUGINS and includes all the libpurple headers */
  29 #include <purple.h>
  30
  31 #define PLUGIN_ID "core-notifyexample"
  32 #define PLUGIN_AUTHORS { "John Bailey <rekkanoryo@cpw.pidgin.im>", NULL }
  33
  34 /* The next four functions and the calls within them should cause dialog boxes to appear
  35  * when you select the plugin action from the Tools->Notify Example menu */
  36 static void
  37 notify_error_cb(PurplePluginAction *action)
  38 {
  39         purple_notify_error(action->plugin, "Test Notification", "Test Notification",
  40                 "This is a test error notification", NULL);
  41 }
  42
  43 static void
  44 notify_info_cb(PurplePluginAction *action)
  45 {
  46         purple_notify_info(action->plugin, "Test Notification", "Test Notification",
  47                 "This is a test informative notification", NULL);
  48 }
  49
  50 static void
  51 notify_warn_cb(PurplePluginAction *action)
  52 {
  53         purple_notify_warning(action->plugin, "Test Notification", "Test Notification",
  54                 "This is a test warning notification", NULL);
  55 }
  56
  57 static void
  58 notify_format_cb(PurplePluginAction *action)
  59 {
  60         purple_notify_formatted(action->plugin, "Test Notification", "Test Notification",
  61                 "Test Notification",
  62                 "<I>This is a test notification with formatted text.</I>", NULL, NULL);
  63 }
  64
  65 static void
  66 notify_uri_cb(PurplePluginAction *action)
  67 {
  68         /* This one should open your web browser of choice. */
  69         purple_notify_uri(action->plugin, "https://pidgin.im/");
  70 }
  71
  72 static GList *
  73 plugin_actions(PurplePlugin *plugin)
  74 {
  75         GList *actions = NULL;
  76
  77         /* Here we take advantage of return values to avoid the need for a temp variable */
  78         actions = g_list_prepend(actions,
  79                 purple_plugin_action_new("Show Error Notification", notify_error_cb));
  80
  81         actions = g_list_prepend(actions,
  82                 purple_plugin_action_new("Show Info Notification", notify_info_cb));
  83
  84         actions = g_list_prepend(actions,
  85                 purple_plugin_action_new("Show Warning Notification", notify_warn_cb));
  86
  87         actions = g_list_prepend(actions,
  88                 purple_plugin_action_new("Show Formatted Notification", notify_format_cb));
  89
  90         actions = g_list_prepend(actions,
  91                 purple_plugin_action_new("Show URI Notification", notify_uri_cb));
  92
  93         return g_list_reverse(actions);
  94 }
  95
  96 static PurplePluginInfo *
  97 plugin_query(GError **error)
  98 {
  99         const gchar * const authors[] = PLUGIN_AUTHORS;
 100
 101         return purple_plugin_info_new(
 102                 "id",           PLUGIN_ID,
 103                 "name",         "Notify API Example",
 104                 "version",      DISPLAY_VERSION,
 105                 "category",     "Example",
 106                 "summary",      "Notify API Example",
 107                 "description",  "Notify API Example",
 108                 "authors",      authors,
 109                 "website",      "https://pidgin.im",
 110                 "abi-version",  PURPLE_ABI_VERSION,
 111                 "actions-cb",   plugin_actions,
 112                 NULL
 113         );
 114 }
 115
 116 static gboolean
 117 plugin_load(PurplePlugin *plugin, GError **error)
 118 {
 119         return TRUE;
 120 }
 121
 122 static gboolean
 123 plugin_unload(PurplePlugin *plugin, GError **error)
 124 {
 125         return TRUE;
 126 }
 127
 128 PURPLE_PLUGIN_INIT(notifyexample, plugin_query, plugin_load, plugin_unload);
 129