Mercurial > pidgin
comparison console/gntplugin.h @ 14558:81650a27f253
[gaim-migrate @ 17281]
Doxygen for console/
committer: Tailor Script <tailor@pidgin.im>
author | Sadrul Habib Chowdhury <imadil@gmail.com> |
---|---|
date | Fri, 15 Sep 2006 01:21:53 +0000 |
parents | c65ed4f6eea8 |
children | 62366c6a10eb |
comparison
equal
deleted
inserted
replaced
14557:fb67a345056e | 14558:81650a27f253 |
---|---|
1 /** | |
2 * @file gntplugin.h GNT Plugins API | |
3 * @ingroup gntui | |
4 * | |
5 * gaim | |
6 * | |
7 * Gaim is the legal property of its developers, whose names are too numerous | |
8 * to list here. Please refer to the COPYRIGHT file distributed with this | |
9 * source distribution. | |
10 * | |
11 * This program is free software; you can redistribute it and/or modify | |
12 * it under the terms of the GNU General Public License as published by | |
13 * the Free Software Foundation; either version 2 of the License, or | |
14 * (at your option) any later version. | |
15 * | |
16 * This program is distributed in the hope that it will be useful, | |
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 * GNU General Public License for more details. | |
20 * | |
21 * You should have received a copy of the GNU General Public License | |
22 * along with this program; if not, write to the Free Software | |
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
24 */ | |
1 #ifndef _GNT_PLUGIN_H | 25 #ifndef _GNT_PLUGIN_H |
2 #define _GNT_PLUGIN_H | 26 #define _GNT_PLUGIN_H |
3 | 27 |
4 #include <gnt.h> | 28 #include <gnt.h> |
5 | 29 |
6 #include <plugin.h> | 30 #include <plugin.h> |
7 | 31 |
8 #include <string.h> | 32 #include <string.h> |
9 | 33 |
34 /********************************************************************** | |
35 * @name GNT Plugins API | |
36 **********************************************************************/ | |
37 /*@{*/ | |
38 | |
10 typedef GntWidget* (*GGPluginFrame) (); | 39 typedef GntWidget* (*GGPluginFrame) (); |
11 | 40 |
12 /* Guess where these came from */ | 41 /* Guess where these came from */ |
13 #define GAIM_GNT_PLUGIN_TYPE "gnt" | 42 #define GAIM_GNT_PLUGIN_TYPE "gnt" |
14 | 43 |
44 /** | |
45 * Decide whether a plugin is a GNT-plugin. | |
46 */ | |
15 #define GAIM_IS_GNT_PLUGIN(plugin) \ | 47 #define GAIM_IS_GNT_PLUGIN(plugin) \ |
16 ((plugin)->info != NULL && (plugin)->info->ui_info != NULL && \ | 48 ((plugin)->info != NULL && (plugin)->info->ui_info != NULL && \ |
17 !strcmp((plugin)->info->ui_requirement, GAIM_GNT_PLUGIN_TYPE)) | 49 !strcmp((plugin)->info->ui_requirement, GAIM_GNT_PLUGIN_TYPE)) |
18 | 50 |
51 /** | |
52 * Get the ui-info from GNT-plugins. | |
53 */ | |
19 #define GAIM_GNT_PLUGIN_UI_INFO(plugin) \ | 54 #define GAIM_GNT_PLUGIN_UI_INFO(plugin) \ |
20 (GGPluginFrame)((plugin)->info->ui_info) | 55 (GGPluginFrame)((plugin)->info->ui_info) |
21 | 56 |
57 /** | |
58 * Show a list of plugins. | |
59 */ | |
22 void gg_plugins_show_all(void); | 60 void gg_plugins_show_all(void); |
23 | 61 |
62 /** | |
63 * Save the list of loaded plugins. | |
64 */ | |
24 void gg_plugins_save_loaded(void); | 65 void gg_plugins_save_loaded(void); |
25 | 66 |
67 /*@}*/ | |
68 | |
26 #endif | 69 #endif |