Mercurial > pidgin
comparison libpurple/plugin.h @ 26633:7b7f0856fb2c
Document this callback function. Prompted by a question in #pidgin
that I didn't know the answer to
author | Mark Doliner <mark@kingant.net> |
---|---|
date | Mon, 20 Apr 2009 06:56:25 +0000 |
parents | 8a0797f40695 |
children | 19cbe3af6167 01f1929d0936 |
comparison
equal
deleted
inserted
replaced
26632:657ccc44e763 | 26633:7b7f0856fb2c |
---|---|
103 void (*destroy)(PurplePlugin *plugin); | 103 void (*destroy)(PurplePlugin *plugin); |
104 | 104 |
105 void *ui_info; /**< Used only by UI-specific plugins to build a preference screen with a custom UI */ | 105 void *ui_info; /**< Used only by UI-specific plugins to build a preference screen with a custom UI */ |
106 void *extra_info; | 106 void *extra_info; |
107 PurplePluginUiInfo *prefs_info; /**< Used by any plugin to display preferences. If #ui_info has been specified, this will be ignored. */ | 107 PurplePluginUiInfo *prefs_info; /**< Used by any plugin to display preferences. If #ui_info has been specified, this will be ignored. */ |
108 | |
109 /** | |
110 * This callback has a different use depending on whether this | |
111 * plugin type is PURPLE_PLUGIN_STANDARD or PURPLE_PLUGIN_PROTOCOL. | |
112 * | |
113 * If PURPLE_PLUGIN_STANDARD then the list of actions will show up | |
114 * in the Tools menu, under a submenu with the name of the plugin. | |
115 * context will be NULL. | |
116 * | |
117 * If PURPLE_PLUGIN_PROTOCOL then the list of actions will show up | |
118 * in the Accounts menu, under a submenu with the name of the | |
119 * account. context will be set to the PurpleConnection for that | |
120 * account. This callback will only be called for online accounts. | |
121 */ | |
108 GList *(*actions)(PurplePlugin *plugin, gpointer context); | 122 GList *(*actions)(PurplePlugin *plugin, gpointer context); |
109 | 123 |
110 void (*_purple_reserved1)(void); | 124 void (*_purple_reserved1)(void); |
111 void (*_purple_reserved2)(void); | 125 void (*_purple_reserved2)(void); |
112 void (*_purple_reserved3)(void); | 126 void (*_purple_reserved3)(void); |