Mercurial > pidgin.yaz
comparison libpurple/prefs.h @ 21159:7c80ba584fb0
Document PurplePrefCallback.
author | Will Thompson <will.thompson@collabora.co.uk> |
---|---|
date | Wed, 07 Nov 2007 10:51:21 +0000 |
parents | d947d75635fb |
children | 5913a8477237 |
comparison
equal
deleted
inserted
replaced
21157:8d73d519155a | 21159:7c80ba584fb0 |
---|---|
43 PURPLE_PREF_PATH_LIST | 43 PURPLE_PREF_PATH_LIST |
44 | 44 |
45 } PurplePrefType; | 45 } PurplePrefType; |
46 | 46 |
47 /** | 47 /** |
48 * Pref change callback type | 48 * The type of callbacks for preference changes. |
49 */ | 49 * |
50 | 50 * @param name the name of the preference which has changed. |
51 * @param type the type of the preferenced named @a name | |
52 * @param val the new value of the preferencs; should be cast to the correct | |
53 * type. For instance, to recover the value of a #PURPLE_PREF_INT | |
54 * preference, use <tt>GPOINTER_TO_INT(val)</tt>. Alternatively, | |
55 * just call purple_prefs_get_int(), purple_prefs_get_string_list() | |
56 * etc. | |
57 * @param data Arbitrary data specified when the callback was connected with | |
58 * purple_prefs_connect_callback(). | |
59 * | |
60 * @see purple_prefs_connect_callback() | |
61 */ | |
51 typedef void (*PurplePrefCallback) (const char *name, PurplePrefType type, | 62 typedef void (*PurplePrefCallback) (const char *name, PurplePrefType type, |
52 gconstpointer val, gpointer data); | 63 gconstpointer val, gpointer data); |
53 | 64 |
54 #ifdef __cplusplus | 65 #ifdef __cplusplus |
55 extern "C" { | 66 extern "C" { |