comparison src/buddyicon.h @ 6886:b5fb1d5282e5

[gaim-migrate @ 7432] Buddy icon caching can now be enabled/disabled in the core, and the cache dir can be changed. committer: Tailor Script <tailor@pidgin.im>
author Christian Hammond <chipx86@chipx86.com>
date Thu, 18 Sep 2003 07:11:55 +0000
parents 7ec9c81dfe72
children c47633e9e2a4
comparison
equal deleted inserted replaced
6885:66dd420d3d23 6886:b5fb1d5282e5
92 * @param icon The buddy icon. 92 * @param icon The buddy icon.
93 */ 93 */
94 void gaim_buddy_icon_update(GaimBuddyIcon *icon); 94 void gaim_buddy_icon_update(GaimBuddyIcon *icon);
95 95
96 /** 96 /**
97 * Caches a buddy icon associated with a specific buddy to disk.
98 *
99 * @param icon The buddy icon.
100 * @param buddy The buddy that this icon belongs to.
101 */
102 void gaim_buddy_icon_cache(GaimBuddyIcon *icon, GaimBuddy *buddy);
103
104 /**
97 * Sets the buddy icon's account. 105 * Sets the buddy icon's account.
98 * 106 *
99 * @param icon The buddy icon. 107 * @param icon The buddy icon.
100 * @param account The account. 108 * @param account The account.
101 */ 109 */
174 */ 182 */
175 GaimBuddyIcon *gaim_buddy_icons_find(const GaimAccount *account, 183 GaimBuddyIcon *gaim_buddy_icons_find(const GaimAccount *account,
176 const char *username); 184 const char *username);
177 185
178 /** 186 /**
187 * Sets whether or not buddy icon caching is enabled.
188 *
189 * @param caching TRUE of buddy icon caching should be enabled, or
190 * FALSE otherwise.
191 */
192 void gaim_buddy_icons_set_caching(gboolean caching);
193
194 /**
195 * Returns whether or not buddy icon caching should be enabled.
196 *
197 * The default is TRUE, unless otherwise specified by
198 * gaim_buddy_icons_set_caching().
199 *
200 * @return TRUE if buddy icon caching is enabled, or FALSE otherwise.
201 */
202 gboolean gaim_buddy_icons_is_caching(void);
203
204 /**
205 * Sets the directory used to store buddy icon cache files.
206 *
207 * @param dir The directory to store buddy icon cache files to.
208 */
209 void gaim_buddy_icons_set_cache_dir(const char *cache_dir);
210
211 /**
212 * Returns the directory used to store buddy icon cache files.
213 *
214 * The default directory is GAIMDIR/icons, unless otherwise specified
215 * by gaim_buddy_icons_set_cache_dir().
216 *
217 * @return The directory to store buddy icon cache files to.
218 */
219 const char *gaim_buddy_icons_get_cache_dir(void);
220
221 /**
179 * Returns the buddy icon subsystem handle. 222 * Returns the buddy icon subsystem handle.
180 * 223 *
181 * @return The subsystem handle. 224 * @return The subsystem handle.
182 */ 225 */
183 void *gaim_buddy_icons_get_handle(); 226 void *gaim_buddy_icons_get_handle();