Mercurial > pidgin.yaz
comparison libpurple/roomlist.h @ 22004:f9dcdc0e89a5
A list of accessor functions to the roomlist API.
author | Sadrul Habib Chowdhury <imadil@gmail.com> |
---|---|
date | Sun, 06 Jan 2008 18:52:15 +0000 |
parents | 6bf32c9e15a7 |
children | 0efa36fe7d7c |
comparison
equal
deleted
inserted
replaced
22000:af0426c34c27 | 22004:f9dcdc0e89a5 |
---|---|
235 * (category->type & PURPLE_ROOMLIST_ROOMTYPE_CATEGORY) | 235 * (category->type & PURPLE_ROOMLIST_ROOMTYPE_CATEGORY) |
236 * must be true. | 236 * must be true. |
237 */ | 237 */ |
238 void purple_roomlist_expand_category(PurpleRoomlist *list, PurpleRoomlistRoom *category); | 238 void purple_roomlist_expand_category(PurpleRoomlist *list, PurpleRoomlistRoom *category); |
239 | 239 |
240 /** | |
241 * Get the list of fields for a roomlist. | |
242 * | |
243 * @param roomlist The roomlist, which must not be @c NULL. | |
244 * @constreturn A list of fields | |
245 * @since 2.4.0 | |
246 */ | |
247 GList * purple_roomlist_get_fields(PurpleRoomlist *roomlist); | |
248 | |
240 /*@}*/ | 249 /*@}*/ |
241 | 250 |
242 /**************************************************************************/ | 251 /**************************************************************************/ |
243 /** @name Room API */ | 252 /** @name Room API */ |
244 /**************************************************************************/ | 253 /**************************************************************************/ |
270 * | 279 * |
271 * @param list The room list the room belongs to. | 280 * @param list The room list the room belongs to. |
272 * @param room The room to join. | 281 * @param room The room to join. |
273 */ | 282 */ |
274 void purple_roomlist_room_join(PurpleRoomlist *list, PurpleRoomlistRoom *room); | 283 void purple_roomlist_room_join(PurpleRoomlist *list, PurpleRoomlistRoom *room); |
284 | |
285 /** | |
286 * Get the type of a room. | |
287 * @param room The room, which must not be @c NULL. | |
288 * @return The type of the room. | |
289 * @since 2.4.0 | |
290 */ | |
291 PurpleRoomlistRoomType purple_roomlist_room_get_type(PurpleRoomlistRoom *room); | |
292 | |
293 /** | |
294 * Get the name of a room. | |
295 * @param room The room, which must not be @c NULL. | |
296 * @return The name of the room. | |
297 * @since 2.4.0 | |
298 */ | |
299 const char * purple_roomlist_room_get_name(PurpleRoomlistRoom *room); | |
300 | |
301 /** | |
302 * Get the parent of a room. | |
303 * @param room The room, which must not be @c NULL. | |
304 * @return The parent of the room, which can be @c NULL. | |
305 * @since 2.4.0 | |
306 */ | |
307 PurpleRoomlistRoom * purple_roomlist_room_get_parent(PurpleRoomlistRoom *room); | |
308 | |
309 /** | |
310 * Get the list of fields for a room. | |
311 * | |
312 * @param room The room, which must not be @c NULL. | |
313 * @constreturn A list of fields | |
314 * @since 2.4.0 | |
315 */ | |
316 GList * purple_roomlist_room_get_fields(PurpleRoomlistRoom *room); | |
275 | 317 |
276 /*@}*/ | 318 /*@}*/ |
277 | 319 |
278 /**************************************************************************/ | 320 /**************************************************************************/ |
279 /** @name Room Field API */ | 321 /** @name Room Field API */ |
292 * purple_roomlist_set_fields(). | 334 * purple_roomlist_set_fields(). |
293 */ | 335 */ |
294 PurpleRoomlistField *purple_roomlist_field_new(PurpleRoomlistFieldType type, | 336 PurpleRoomlistField *purple_roomlist_field_new(PurpleRoomlistFieldType type, |
295 const gchar *label, const gchar *name, | 337 const gchar *label, const gchar *name, |
296 gboolean hidden); | 338 gboolean hidden); |
339 | |
340 /** | |
341 * Get the type of a field. | |
342 * | |
343 * @param field A PurpleRoomlistField, which must not be @c NULL. | |
344 * | |
345 * @return The type of the field. | |
346 * @since 2.4.0 | |
347 */ | |
348 PurpleRoomlistFieldType purple_roomlist_field_get_type(PurpleRoomlistField *field); | |
349 | |
350 /** | |
351 * Get the label of a field. | |
352 * | |
353 * @param field A PurpleRoomlistField, which must not be @c NULL. | |
354 * | |
355 * @return The label of the field. | |
356 * @since 2.4.0 | |
357 */ | |
358 const char * purple_roomlist_field_get_label(PurpleRoomlistField *field); | |
359 | |
360 /** | |
361 * Check whether a roomlist-field is hidden. | |
362 * @param field A PurpleRoomlistField, which must not be @c NULL. | |
363 * | |
364 * @return @c TRUE if the field is hidden, @c FALSE otherwise. | |
365 * @since 2.4.0 | |
366 */ | |
367 gboolean purple_roomlist_field_get_hidden(PurpleRoomlistField *field); | |
368 | |
297 /*@}*/ | 369 /*@}*/ |
298 | 370 |
299 /**************************************************************************/ | 371 /**************************************************************************/ |
300 /** @name UI Registration Functions */ | 372 /** @name UI Registration Functions */ |
301 /**************************************************************************/ | 373 /**************************************************************************/ |