Mercurial > pidgin
annotate src/buddyicon.h @ 9460:eae7e049d639
[gaim-migrate @ 10285]
" This patch completely eliminates the use of the old
numeric prpl identifiers.
I've noticed that some plugins (both in gaim's cvs and
external) continue to use the constants even though
they are essentially no longer valid - code that relies
on them being unique will fail - the new built-in prpls
(SILC and novell) ,and any recent external prpls don't
have numeric values.
The once side effect that the removal causes is that
the code for importing of the old .gaimrc and *.blist
files is a little more kludgy (using magic numbers
instead of the old constants). IMHO this isn't a big
deal as the code will go away eventually anyway.
**This patch also fixes the raw plugin so that i
compiles once again.
**Someone should make sure that the gaim-remote and raw
plugins still work. (If the raw doesn't work, it may be
unrelated as it hasn't been updated since the latest
significant MSN changes - i just made a minor change to
make it compile)" --Daniel Atallah
(13:44:44) Me: what think you of getting rid of prpl numbers?
(13:45:05) Sean: what do you mean?
(13:45:27) Me: right now they are listed as deprecated, but still used in a
few of our own plugins as well as in some 3rd party stuff
(13:45:32) Me: and the enum still exists in the core
(13:45:44) Me: and the newwer prpls such as novell don't use them
(13:45:59) Me: datallah has submitted a patch to get rid of them entirely
(13:46:31) Me: the only thing it would break would be the old blist import,
which he hacked into working with magic numbers, but which i tend to think
we could remove entirely anyway
(13:50:03) Sean: Let's get rid of them, then.
(13:50:10) Sean: and take out old .blist code too
(13:50:14) Me: cool
(13:52:37) Sean: we should get rid of .gaimrc code too, sometime.
(13:53:02) Sean: If anyone's seriously just now upgrading from 0.59.x, or
whatever, they deserve to lose their preferences.
(12:27:56) LSchiere: Paco-Paco: what do you think of getting rid of the
deprecated prpl numbers?
(12:28:14) Paco-Paco: LSchiere: I think it shouldh ave happened long ago
committer: Tailor Script <tailor@pidgin.im>
author | Luke Schierer <lschiere@pidgin.im> |
---|---|
date | Tue, 06 Jul 2004 18:06:43 +0000 |
parents | 84594a281500 |
children | db62420a53a2 |
rev | line source |
---|---|
6846 | 1 /** |
6869 | 2 * @file buddyicon.h Buddy Icon API |
6846 | 3 * @ingroup core |
4 * | |
5 * gaim | |
6 * | |
8046 | 7 * Gaim is the legal property of its developers, whose names are too numerous |
8 * to list here. Please refer to the COPYRIGHT file distributed with this | |
9 * source distribution. | |
6846 | 10 * |
11 * This program is free software; you can redistribute it and/or modify | |
12 * it under the terms of the GNU General Public License as published by | |
13 * the Free Software Foundation; either version 2 of the License, or | |
14 * (at your option) any later version. | |
15 * | |
16 * This program is distributed in the hope that it will be useful, | |
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 * GNU General Public License for more details. | |
20 * | |
21 * You should have received a copy of the GNU General Public License | |
22 * along with this program; if not, write to the Free Software | |
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
24 */ | |
25 #ifndef _GAIM_ICON_H_ | |
26 #define _GAIM_ICON_H_ | |
27 | |
28 typedef struct _GaimBuddyIcon GaimBuddyIcon; | |
29 | |
30 #include "account.h" | |
31 | |
32 struct _GaimBuddyIcon | |
33 { | |
34 GaimAccount *account; /**< The account the user is on. */ | |
35 char *username; /**< The username the icon belongs to. */ | |
36 | |
37 void *data; /**< The buddy icon data. */ | |
38 size_t len; /**< The length of the buddy icon data. */ | |
39 | |
40 int ref_count; /**< The buddy icon reference count. */ | |
41 }; | |
42 | |
43 /**************************************************************************/ | |
44 /** @name Buddy Icon API */ | |
45 /**************************************************************************/ | |
46 /*@{*/ | |
47 | |
48 /** | |
49 * Creates a new buddy icon structure. | |
50 * | |
51 * @param account The account the user is on. | |
52 * @param username The username the icon belongs to. | |
53 * @param icon_data The buddy icon data. | |
54 * @param icon_len The buddy icon length. | |
55 * | |
56 * @return The buddy icon structure. | |
57 */ | |
58 GaimBuddyIcon *gaim_buddy_icon_new(GaimAccount *account, const char *username, | |
59 void *icon_data, size_t icon_len); | |
60 | |
61 /** | |
62 * Destroys a buddy icon structure. | |
63 * | |
64 * If the buddy icon's reference count is greater than 1, this will | |
65 * just decrease the reference count and return. | |
66 * | |
67 * @param icon The buddy icon structure to destroy. | |
68 */ | |
69 void gaim_buddy_icon_destroy(GaimBuddyIcon *icon); | |
70 | |
71 /** | |
72 * Increments the reference count on a buddy icon. | |
73 * | |
74 * @param icon The buddy icon. | |
75 * | |
76 * @return @a icon. | |
77 */ | |
78 GaimBuddyIcon *gaim_buddy_icon_ref(GaimBuddyIcon *icon); | |
79 | |
80 /** | |
81 * Decrements the reference count on a buddy icon. | |
82 * | |
83 * If the reference count reaches 0, the icon will be destroyed. | |
84 * | |
85 * @param icon The buddy icon. | |
86 * | |
87 * @return @a icon, or @c NULL if the reference count reached 0. | |
88 */ | |
89 GaimBuddyIcon *gaim_buddy_icon_unref(GaimBuddyIcon *icon); | |
90 | |
91 /** | |
92 * Updates every instance of this icon. | |
93 * | |
94 * @param icon The buddy icon. | |
95 */ | |
96 void gaim_buddy_icon_update(GaimBuddyIcon *icon); | |
97 | |
98 /** | |
6886
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
99 * Caches a buddy icon associated with a specific buddy to disk. |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
100 * |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
101 * @param icon The buddy icon. |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
102 * @param buddy The buddy that this icon belongs to. |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
103 */ |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
104 void gaim_buddy_icon_cache(GaimBuddyIcon *icon, GaimBuddy *buddy); |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
105 |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
106 /** |
6846 | 107 * Sets the buddy icon's account. |
108 * | |
109 * @param icon The buddy icon. | |
110 * @param account The account. | |
111 */ | |
112 void gaim_buddy_icon_set_account(GaimBuddyIcon *icon, GaimAccount *account); | |
113 | |
114 /** | |
115 * Sets the buddy icon's username. | |
116 * | |
117 * @param icon The buddy icon. | |
118 * @param username The username. | |
119 */ | |
120 void gaim_buddy_icon_set_username(GaimBuddyIcon *icon, const char *username); | |
121 | |
122 /** | |
123 * Sets the buddy icon's icon data. | |
124 * | |
125 * @param icon The buddy icon. | |
126 * @param data The buddy icon data. | |
127 * @param len The length of the icon data. | |
128 */ | |
129 void gaim_buddy_icon_set_data(GaimBuddyIcon *icon, void *data, size_t len); | |
130 | |
131 /** | |
132 * Returns the buddy icon's account. | |
133 * | |
134 * @param icon The buddy icon. | |
135 * | |
136 * @return The account. | |
137 */ | |
138 GaimAccount *gaim_buddy_icon_get_account(const GaimBuddyIcon *icon); | |
139 | |
140 /** | |
141 * Returns the buddy icon's username. | |
142 * | |
143 * @param icon The buddy icon. | |
144 * | |
145 * @return The username. | |
146 */ | |
147 const char *gaim_buddy_icon_get_username(const GaimBuddyIcon *icon); | |
148 | |
149 /** | |
150 * Returns the buddy icon's data. | |
151 * | |
152 * @param icon The buddy icon. | |
153 * @param len The returned icon length. | |
154 * | |
155 * @return The icon data. | |
156 */ | |
157 const void *gaim_buddy_icon_get_data(const GaimBuddyIcon *icon, size_t *len); | |
158 | |
159 /*@}*/ | |
160 | |
161 /**************************************************************************/ | |
162 /** @name Buddy Icon Subsystem API */ | |
163 /**************************************************************************/ | |
164 /*@{*/ | |
165 | |
166 /** | |
167 * Sets a buddy icon for a user. | |
168 * | |
169 * @param account The account the user is on. | |
170 * @param username The username of the user. | |
171 * @param icon_data The icon data. | |
172 * @param icon_len The length of the icon data. | |
173 */ | |
174 void gaim_buddy_icons_set_for_user(GaimAccount *account, const char *username, | |
175 void *icon_data, size_t icon_len); | |
176 | |
177 /** | |
178 * Returns the buddy icon information for a user. | |
179 * | |
180 * @param account The account the user is on. | |
181 * @param username The username of the user. | |
182 * | |
183 * @return The icon data if found, or @c NULL if not found. | |
184 */ | |
9396 | 185 GaimBuddyIcon *gaim_buddy_icons_find(GaimAccount *account, |
6846 | 186 const char *username); |
187 | |
188 /** | |
6886
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
189 * Sets whether or not buddy icon caching is enabled. |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
190 * |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
191 * @param caching TRUE of buddy icon caching should be enabled, or |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
192 * FALSE otherwise. |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
193 */ |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
194 void gaim_buddy_icons_set_caching(gboolean caching); |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
195 |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
196 /** |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
197 * Returns whether or not buddy icon caching should be enabled. |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
198 * |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
199 * The default is TRUE, unless otherwise specified by |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
200 * gaim_buddy_icons_set_caching(). |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
201 * |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
202 * @return TRUE if buddy icon caching is enabled, or FALSE otherwise. |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
203 */ |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
204 gboolean gaim_buddy_icons_is_caching(void); |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
205 |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
206 /** |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
207 * Sets the directory used to store buddy icon cache files. |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
208 * |
7114
c47633e9e2a4
[gaim-migrate @ 7681]
Christian Hammond <chipx86@chipx86.com>
parents:
6886
diff
changeset
|
209 * @param cache_dir The directory to store buddy icon cache files to. |
6886
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
210 */ |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
211 void gaim_buddy_icons_set_cache_dir(const char *cache_dir); |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
212 |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
213 /** |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
214 * Returns the directory used to store buddy icon cache files. |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
215 * |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
216 * The default directory is GAIMDIR/icons, unless otherwise specified |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
217 * by gaim_buddy_icons_set_cache_dir(). |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
218 * |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
219 * @return The directory to store buddy icon cache files to. |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
220 */ |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
221 const char *gaim_buddy_icons_get_cache_dir(void); |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
222 |
b5fb1d5282e5
[gaim-migrate @ 7432]
Christian Hammond <chipx86@chipx86.com>
parents:
6869
diff
changeset
|
223 /** |
6846 | 224 * Returns the buddy icon subsystem handle. |
225 * | |
226 * @return The subsystem handle. | |
227 */ | |
228 void *gaim_buddy_icons_get_handle(); | |
229 | |
230 /** | |
231 * Initializes the buddy icon subsystem. | |
232 */ | |
233 void gaim_buddy_icons_init(); | |
234 | |
235 /** | |
236 * Uninitializes the buddy icon subsystem. | |
237 */ | |
238 void gaim_buddy_icons_uninit(); | |
239 | |
240 /*@}*/ | |
241 | |
242 #endif /* _GAIM_ICON_H_ */ |