comparison libpurple/conversation.h @ 32165:47f7b8ca6149

conversation: O(1) purple_conv_chat_cb_find I also deprecated what seems like a useless function. The ui_data is to implement constant-time lookups for the room list in Pidgin.
author Paul Aurich <paul@darkrain42.org>
date Mon, 20 Jun 2011 05:24:30 +0000
parents d72d728226dc
children 4dabe4bdfb29
comparison
equal deleted inserted replaced
32164:bb77a9ceca17 32165:47f7b8ca6149
269 */ 269 */
270 struct _PurpleConvChat 270 struct _PurpleConvChat
271 { 271 {
272 PurpleConversation *conv; /**< The parent conversation. */ 272 PurpleConversation *conv; /**< The parent conversation. */
273 273
274 GList *in_room; /**< The users in the room. */ 274 GList *in_room; /**< The users in the room.
275 * @deprecated Will be removed in 3.0.0
276 */
275 GList *ignored; /**< Ignored users. */ 277 GList *ignored; /**< Ignored users. */
276 char *who; /**< The person who set the topic. */ 278 char *who; /**< The person who set the topic. */
277 char *topic; /**< The topic. */ 279 char *topic; /**< The topic. */
278 int id; /**< The chat ID. */ 280 int id; /**< The chat ID. */
279 char *nick; /**< Your nick in this chat. */ 281 char *nick; /**< Your nick in this chat. */
280 282
281 gboolean left; /**< We left the chat and kept the window open */ 283 gboolean left; /**< We left the chat and kept the window open */
284 GHashTable *users; /**< Hash table of the users in the room.
285 * @since 2.9.0
286 */
287 GHashFunc user_hash_func; /**< Function used to hash entries into
288 * the users hash. Defaults to a
289 * case-insensitive collation function.
290 * @since 2.9.0
291 */
292 GEqualFunc user_eq_func; /**< Function used for equality in the
293 * users hash. Defaults to a wrapper
294 * around purple_utf8_strcasecmp.
295 * @since 2.9.0
296 */
282 }; 297 };
283 298
284 /** 299 /**
285 * Data for "Chat Buddies" 300 * Data for "Chat Buddies"
286 */ 301 */
302 * such as whether they are a channel operator. 317 * such as whether they are a channel operator.
303 */ 318 */
304 GHashTable *attributes; /**< A hash table of attributes about the user, such as 319 GHashTable *attributes; /**< A hash table of attributes about the user, such as
305 * real name, user@host, etc. 320 * real name, user@host, etc.
306 */ 321 */
322 gpointer ui_data; /** < The UI can put whatever it wants here. */
307 }; 323 };
308 324
309 /** 325 /**
310 * Description of a conversation message 326 * Description of a conversation message
311 * 327 *
1063 * 1079 *
1064 * @param chat The chat. 1080 * @param chat The chat.
1065 * @param users The list of users. 1081 * @param users The list of users.
1066 * 1082 *
1067 * @return The list passed. 1083 * @return The list passed.
1084 *
1085 * @deprecated This function will be removed in 3.0.0. You shouldn't be using it anyway.
1068 */ 1086 */
1069 GList *purple_conv_chat_set_users(PurpleConvChat *chat, GList *users); 1087 GList *purple_conv_chat_set_users(PurpleConvChat *chat, GList *users);
1070 1088
1071 /** 1089 /**
1072 * Returns a list of users in the chat room. The members of the list 1090 * Returns a list of users in the chat room. The members of the list