roomlist.h

00001
00006 /* purple
00007  *
00008  * Purple is the legal property of its developers, whose names are too numerous
00009  * to list here.  Please refer to the COPYRIGHT file distributed with this
00010  * source distribution.
00011  *
00012  * This program is free software; you can redistribute it and/or modify
00013  * it under the terms of the GNU General Public License as published by
00014  * the Free Software Foundation; either version 2 of the License, or
00015  * (at your option) any later version.
00016  *
00017  * This program is distributed in the hope that it will be useful,
00018  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00019  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00020  * GNU General Public License for more details.
00021  *
00022  * You should have received a copy of the GNU General Public License
00023  * along with this program; if not, write to the Free Software
00024  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
00025  */
00026
00027 #ifndef _PURPLE_ROOMLIST_H_
00028 #define _PURPLE_ROOMLIST_H_
00029 
00030 typedef struct _PurpleRoomlist PurpleRoomlist;
00031 typedef struct _PurpleRoomlistRoom PurpleRoomlistRoom;
00032 typedef struct _PurpleRoomlistField PurpleRoomlistField;
00034 typedef struct _PurpleRoomlistUiOps PurpleRoomlistUiOps;
00035
00041 typedef enum
00042 {
00043     PURPLE_ROOMLIST_ROOMTYPE_CATEGORY = 0x01,
00044     PURPLE_ROOMLIST_ROOMTYPE_ROOM = 0x02
00046 } PurpleRoomlistRoomType;
00047
00051 typedef enum
00052 {
00053     PURPLE_ROOMLIST_FIELD_BOOL,
00054     PURPLE_ROOMLIST_FIELD_INT,
00055     PURPLE_ROOMLIST_FIELD_STRING
00057 } PurpleRoomlistFieldType;
00058
00059 #include "account.h"
00060 #include "glib.h"
00061
00062 /**************************************************************************/
00064 /**************************************************************************/
00065
00069 struct _PurpleRoomlist {
00070     PurpleAccount *account;
00071     GList *fields;
00072     GList *rooms;
00073     gboolean in_progress;
00074     gpointer ui_data;
00075     gpointer proto_data;
00076     guint ref;
00077 };
00078
00082 struct _PurpleRoomlistRoom {
00083     PurpleRoomlistRoomType type;
00084     gchar *name;
00085     GList *fields;
00086     PurpleRoomlistRoom *parent;
00087     gboolean expanded_once;
00088 };
00089
00093 struct _PurpleRoomlistField {
00094     PurpleRoomlistFieldType type;
00095     gchar *label;
00096     gchar *name;
00097     gboolean hidden;
00098 };
00099
00103 struct _PurpleRoomlistUiOps {
00104     void (*show_with_account)(PurpleAccount *account);
00105     void (*create)(PurpleRoomlist *list);
00106     void (*set_fields)(PurpleRoomlist *list, GList *fields);
00107     void (*add_room)(PurpleRoomlist *list, PurpleRoomlistRoom *room);
00108     void (*in_progress)(PurpleRoomlist *list, gboolean flag);
00109     void (*destroy)(PurpleRoomlist *list);
00111     void (*_purple_reserved1)(void);
00112     void (*_purple_reserved2)(void);
00113     void (*_purple_reserved3)(void);
00114     void (*_purple_reserved4)(void);
00115 };
00116
00117
00118 #ifdef __cplusplus
00119 extern "C" {
00120 #endif
00121 
00122 /**************************************************************************/
00124 /**************************************************************************/
00136 void purple_roomlist_show_with_account(PurpleAccount *account);
00137
00146 PurpleRoomlist *purple_roomlist_new(PurpleAccount *account);
00147
00153 void purple_roomlist_ref(PurpleRoomlist *list);
00154
00163 void purple_roomlist_unref(PurpleRoomlist *list);
00164
00174 void purple_roomlist_set_fields(PurpleRoomlist *list, GList *fields);
00175
00185 void purple_roomlist_set_in_progress(PurpleRoomlist *list, gboolean in_progress);
00186
00196 gboolean purple_roomlist_get_in_progress(PurpleRoomlist *list);
00197
00205 void purple_roomlist_room_add(PurpleRoomlist *list, PurpleRoomlistRoom *room);
00206
00216 PurpleRoomlist *purple_roomlist_get_list(PurpleConnection *gc);
00217
00226 void purple_roomlist_cancel_get_list(PurpleRoomlist *list);
00227
00239 void purple_roomlist_expand_category(PurpleRoomlist *list, PurpleRoomlistRoom *category);
00240
00248 GList * purple_roomlist_get_fields(PurpleRoomlist *roomlist);
00249
00252 /**************************************************************************/
00254 /**************************************************************************/
00266 PurpleRoomlistRoom *purple_roomlist_room_new(PurpleRoomlistRoomType type, const gchar *name,
00267                                          PurpleRoomlistRoom *parent);
00268
00276 void purple_roomlist_room_add_field(PurpleRoomlist *list, PurpleRoomlistRoom *room, gconstpointer field);
00277
00284 void purple_roomlist_room_join(PurpleRoomlist *list, PurpleRoomlistRoom *room);
00285
00292 PurpleRoomlistRoomType purple_roomlist_room_get_type(PurpleRoomlistRoom *room);
00293
00300 const char * purple_roomlist_room_get_name(PurpleRoomlistRoom *room);
00301
00308 PurpleRoomlistRoom * purple_roomlist_room_get_parent(PurpleRoomlistRoom *room);
00309
00317 GList * purple_roomlist_room_get_fields(PurpleRoomlistRoom *room);
00318
00321 /**************************************************************************/
00323 /**************************************************************************/
00337 PurpleRoomlistField *purple_roomlist_field_new(PurpleRoomlistFieldType type,
00338                                            const gchar *label, const gchar *name,
00339                                            gboolean hidden);
00340
00349 PurpleRoomlistFieldType purple_roomlist_field_get_type(PurpleRoomlistField *field);
00350
00359 const char * purple_roomlist_field_get_label(PurpleRoomlistField *field);
00360
00368 gboolean purple_roomlist_field_get_hidden(PurpleRoomlistField *field);
00369
00372 /**************************************************************************/
00374 /**************************************************************************/
00382 void purple_roomlist_set_ui_ops(PurpleRoomlistUiOps *ops);
00383
00390 PurpleRoomlistUiOps *purple_roomlist_get_ui_ops(void);
00391
00394 #ifdef __cplusplus
00395 }
00396 #endif
00397 
00398 #endif /* _PURPLE_ROOMLIST_H_ */