diff options
author | Mark Doliner <markdoliner@pidgin.im> | 2009-04-20 06:56:25 +0000 |
---|---|---|
committer | Mark Doliner <markdoliner@pidgin.im> | 2009-04-20 06:56:25 +0000 |
commit | 0be938d4d78af7a7347fbb931336a71f9c348138 (patch) | |
tree | 8deb8c701cf2022c25943fab59fd5fda4cc943b4 | |
parent | 9dffbeaf5d1c1648408c5f7b620bed8f3b24ab09 (diff) | |
download | pidgin-0be938d4d78af7a7347fbb931336a71f9c348138.tar.gz |
Document this callback function. Prompted by a question in #pidgin
that I didn't know the answer to
-rw-r--r-- | libpurple/plugin.h | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/libpurple/plugin.h b/libpurple/plugin.h index 37fe91dd2b..0374418dfd 100644 --- a/libpurple/plugin.h +++ b/libpurple/plugin.h @@ -105,6 +105,20 @@ struct _PurplePluginInfo 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); |