Mercurial > pidgin
changeset 21159:7c80ba584fb0
Document PurplePrefCallback.
| author | Will Thompson <will.thompson@collabora.co.uk> |
|---|---|
| date | Wed, 07 Nov 2007 10:51:21 +0000 |
| parents | 8d73d519155a |
| children | 45e550db32ab |
| files | libpurple/prefs.h |
| diffstat | 1 files changed, 13 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/libpurple/prefs.h Wed Nov 07 09:19:25 2007 +0000 +++ b/libpurple/prefs.h Wed Nov 07 10:51:21 2007 +0000 @@ -45,9 +45,20 @@ } PurplePrefType; /** - * Pref change callback type + * The type of callbacks for preference changes. + * + * @param name the name of the preference which has changed. + * @param type the type of the preferenced named @a name + * @param val the new value of the preferencs; should be cast to the correct + * type. For instance, to recover the value of a #PURPLE_PREF_INT + * preference, use <tt>GPOINTER_TO_INT(val)</tt>. Alternatively, + * just call purple_prefs_get_int(), purple_prefs_get_string_list() + * etc. + * @param data Arbitrary data specified when the callback was connected with + * purple_prefs_connect_callback(). + * + * @see purple_prefs_connect_callback() */ - typedef void (*PurplePrefCallback) (const char *name, PurplePrefType type, gconstpointer val, gpointer data);