Mercurial > pidgin
changeset 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 | 657ccc44e763 |
| children | 474a0cb44f58 |
| files | libpurple/plugin.h |
| diffstat | 1 files changed, 14 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/libpurple/plugin.h Sun Apr 19 15:35:28 2009 +0000 +++ b/libpurple/plugin.h Mon Apr 20 06:56:25 2009 +0000 @@ -105,6 +105,20 @@ void *ui_info; /**< Used only by UI-specific plugins to build a preference screen with a custom UI */ void *extra_info; PurplePluginUiInfo *prefs_info; /**< Used by any plugin to display preferences. If #ui_info has been specified, this will be ignored. */ + + /** + * This callback has a different use depending on whether this + * plugin type is PURPLE_PLUGIN_STANDARD or PURPLE_PLUGIN_PROTOCOL. + * + * If PURPLE_PLUGIN_STANDARD then the list of actions will show up + * in the Tools menu, under a submenu with the name of the plugin. + * context will be NULL. + * + * If PURPLE_PLUGIN_PROTOCOL then the list of actions will show up + * in the Accounts menu, under a submenu with the name of the + * account. context will be set to the PurpleConnection for that + * account. This callback will only be called for online accounts. + */ GList *(*actions)(PurplePlugin *plugin, gpointer context); void (*_purple_reserved1)(void);