| |
1 /** |
| |
2 * @file gtkplugin.h GTK+ Plugin API |
| |
3 * @ingroup gtkui |
| |
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 */ |
| |
25 #ifndef _GAIM_GTKPLUGIN_H_ |
| |
26 #define _GAIM_GTKPLUGIN_H_ |
| |
27 |
| |
28 #include "gtkgaim.h" |
| |
29 #include "plugin.h" |
| |
30 |
| |
31 typedef struct _GaimGtkPluginUiInfo GaimGtkPluginUiInfo; |
| |
32 |
| |
33 /** |
| |
34 * A GTK+ UI structure for plugins. |
| |
35 */ |
| |
36 struct _GaimGtkPluginUiInfo |
| |
37 { |
| |
38 GtkWidget *(*get_config_frame)(GaimPlugin *plugin); |
| |
39 |
| |
40 int page_num; /**< Reserved */ |
| |
41 }; |
| |
42 |
| |
43 #define GAIM_GTK_PLUGIN_TYPE GAIM_GTK_UI |
| |
44 |
| |
45 #define GAIM_IS_GTK_PLUGIN(plugin) \ |
| |
46 ((plugin)->info != NULL && (plugin)->info->ui_info != NULL && \ |
| |
47 !strcmp((plugin)->info->ui_requirement, GAIM_GTK_PLUGIN_TYPE)) |
| |
48 |
| |
49 #define GAIM_GTK_PLUGIN_UI_INFO(plugin) \ |
| |
50 ((GaimGtkPluginUiInfo *)(plugin)->info->ui_info) |
| |
51 |
| |
52 /** |
| |
53 * Returns the configuration frame widget for a GTK+ plugin, if one |
| |
54 * exists. |
| |
55 * |
| |
56 * @param plugin The plugin. |
| |
57 * |
| |
58 * @return The frame, if the plugin is a GTK+ plugin and provides a |
| |
59 * configuration frame. |
| |
60 */ |
| |
61 GtkWidget *gaim_gtk_plugin_get_config_frame(GaimPlugin *plugin); |
| |
62 |
| |
63 /** |
| |
64 * Saves all loaded plugins. |
| |
65 */ |
| |
66 void gaim_gtk_plugins_save(void); |
| |
67 |
| |
68 /** |
| |
69 * Shows the Plugins dialog |
| |
70 */ |
| |
71 void gaim_gtk_plugin_dialog_show(void); |
| |
72 |
| |
73 #endif /* _GAIM_GTKPLUGIN_H_ */ |