pidgin/pidgin

closing merged branch
port-changes-from-branch-2.x.y-to-default
2020-02-03, Gary Kramlich
2f836435c33c
closing merged branch
/*
* Notify API Example Plugin
*
* Copyright (C) 2007, John Bailey <rekkanoryo@cpw.pidgin.im>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
* 02111-1301, USA.
*
*/
/* When writing a third-party plugin, do not include libpurple's internal.h
* included below. This file is for internal libpurple use only. We're including
* it here for our own convenience. */
#include "internal.h"
/* This file includes all the libpurple headers */
#include <purple.h>
#define PLUGIN_ID "core-notifyexample"
#define PLUGIN_AUTHORS { "John Bailey <rekkanoryo@cpw.pidgin.im>", NULL }
/* The next four functions and the calls within them should cause dialog boxes to appear
* when you select the plugin action from the Tools->Notify Example menu */
static void
notify_error_cb(PurplePluginAction *action)
{
purple_notify_error(action->plugin, "Test Notification", "Test Notification",
"This is a test error notification", NULL);
}
static void
notify_info_cb(PurplePluginAction *action)
{
purple_notify_info(action->plugin, "Test Notification", "Test Notification",
"This is a test informative notification", NULL);
}
static void
notify_warn_cb(PurplePluginAction *action)
{
purple_notify_warning(action->plugin, "Test Notification", "Test Notification",
"This is a test warning notification", NULL);
}
static void
notify_format_cb(PurplePluginAction *action)
{
purple_notify_formatted(action->plugin, "Test Notification", "Test Notification",
"Test Notification",
"<I>This is a test notification with formatted text.</I>", NULL, NULL);
}
static void
notify_uri_cb(PurplePluginAction *action)
{
/* This one should open your web browser of choice. */
purple_notify_uri(action->plugin, "https://pidgin.im/");
}
static GList *
plugin_actions(PurplePlugin *plugin)
{
GList *actions = NULL;
/* Here we take advantage of return values to avoid the need for a temp variable */
actions = g_list_prepend(actions,
purple_plugin_action_new("Show Error Notification", notify_error_cb));
actions = g_list_prepend(actions,
purple_plugin_action_new("Show Info Notification", notify_info_cb));
actions = g_list_prepend(actions,
purple_plugin_action_new("Show Warning Notification", notify_warn_cb));
actions = g_list_prepend(actions,
purple_plugin_action_new("Show Formatted Notification", notify_format_cb));
actions = g_list_prepend(actions,
purple_plugin_action_new("Show URI Notification", notify_uri_cb));
return g_list_reverse(actions);
}
static PurplePluginInfo *
plugin_query(GError **error)
{
const gchar * const authors[] = PLUGIN_AUTHORS;
return purple_plugin_info_new(
"id", PLUGIN_ID,
"name", "Notify API Example",
"version", DISPLAY_VERSION,
"category", "Example",
"summary", "Notify API Example",
"description", "Notify API Example",
"authors", authors,
"website", "https://pidgin.im",
"abi-version", PURPLE_ABI_VERSION,
"actions-cb", plugin_actions,
NULL
);
}
static gboolean
plugin_load(PurplePlugin *plugin, GError **error)
{
return TRUE;
}
static gboolean
plugin_unload(PurplePlugin *plugin, GError **error)
{
return TRUE;
}
PURPLE_PLUGIN_INIT(notifyexample, plugin_query, plugin_load, plugin_unload);