roomlist.h

Go to the documentation of this file.

 
/* purple
 *
 * Purple is the legal property of its developers, whose names are too numerous
 * to list here.  Please refer to the COPYRIGHT file distributed with this
 * source distribution.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
 */
 
#ifndef _PURPLE_ROOMLIST_H_
#define _PURPLE_ROOMLIST_H_
 
typedef struct _PurpleRoomlist PurpleRoomlist;
typedef struct _PurpleRoomlistRoom PurpleRoomlistRoom;
typedef struct _PurpleRoomlistField PurpleRoomlistField;
typedef struct _PurpleRoomlistUiOps PurpleRoomlistUiOps;
 
typedef enum
{
    PURPLE_ROOMLIST_ROOMTYPE_CATEGORY = 0x01, 
    PURPLE_ROOMLIST_ROOMTYPE_ROOM = 0x02      
} PurpleRoomlistRoomType;
 
typedef enum
{
    PURPLE_ROOMLIST_FIELD_BOOL,
    PURPLE_ROOMLIST_FIELD_INT,
    PURPLE_ROOMLIST_FIELD_STRING 
} PurpleRoomlistFieldType;
 
#include "account.h"
#include <glib.h>
 
/**************************************************************************/
/**************************************************************************/
 
struct _PurpleRoomlist {
    PurpleAccount *account; 
    GList *fields; 
    GList *rooms; 
    gboolean in_progress; 
    gpointer ui_data; 
    gpointer proto_data; 
    guint ref; 
};
 
struct _PurpleRoomlistRoom {
    PurpleRoomlistRoomType type; 
    gchar *name; 
    GList *fields; 
    PurpleRoomlistRoom *parent; 
    gboolean expanded_once; 
};
 
struct _PurpleRoomlistField {
    PurpleRoomlistFieldType type; 
    gchar *label; 
    gchar *name; 
    gboolean hidden; 
};
 
struct _PurpleRoomlistUiOps {
    void (*show_with_account)(PurpleAccount *account); 
    void (*create)(PurpleRoomlist *list); 
    void (*set_fields)(PurpleRoomlist *list, GList *fields); 
    void (*add_room)(PurpleRoomlist *list, PurpleRoomlistRoom *room); 
    void (*in_progress)(PurpleRoomlist *list, gboolean flag); 
    void (*destroy)(PurpleRoomlist *list); 
    void (*_purple_reserved1)(void);
    void (*_purple_reserved2)(void);
    void (*_purple_reserved3)(void);
    void (*_purple_reserved4)(void);
};
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
/**************************************************************************/
/**************************************************************************/
void purple_roomlist_show_with_account(PurpleAccount *account);
 
PurpleRoomlist *purple_roomlist_new(PurpleAccount *account);
 
void purple_roomlist_ref(PurpleRoomlist *list);
 
void purple_roomlist_unref(PurpleRoomlist *list);
 
void purple_roomlist_set_fields(PurpleRoomlist *list, GList *fields);
 
void purple_roomlist_set_in_progress(PurpleRoomlist *list, gboolean in_progress);
 
gboolean purple_roomlist_get_in_progress(PurpleRoomlist *list);
 
void purple_roomlist_room_add(PurpleRoomlist *list, PurpleRoomlistRoom *room);
 
PurpleRoomlist *purple_roomlist_get_list(PurpleConnection *gc);
 
void purple_roomlist_cancel_get_list(PurpleRoomlist *list);
 
void purple_roomlist_expand_category(PurpleRoomlist *list, PurpleRoomlistRoom *category);
 
GList * purple_roomlist_get_fields(PurpleRoomlist *roomlist);
 
/**************************************************************************/
/**************************************************************************/
PurpleRoomlistRoom *purple_roomlist_room_new(PurpleRoomlistRoomType type, const gchar *name,
                                         PurpleRoomlistRoom *parent);
 
void purple_roomlist_room_add_field(PurpleRoomlist *list, PurpleRoomlistRoom *room, gconstpointer field);
 
void purple_roomlist_room_join(PurpleRoomlist *list, PurpleRoomlistRoom *room);
 
PurpleRoomlistRoomType purple_roomlist_room_get_type(PurpleRoomlistRoom *room);
 
const char * purple_roomlist_room_get_name(PurpleRoomlistRoom *room);
 
PurpleRoomlistRoom * purple_roomlist_room_get_parent(PurpleRoomlistRoom *room);
 
GList * purple_roomlist_room_get_fields(PurpleRoomlistRoom *room);
 
/**************************************************************************/
/**************************************************************************/
PurpleRoomlistField *purple_roomlist_field_new(PurpleRoomlistFieldType type,
                                           const gchar *label, const gchar *name,
                                           gboolean hidden);
 
PurpleRoomlistFieldType purple_roomlist_field_get_type(PurpleRoomlistField *field);
 
const char * purple_roomlist_field_get_label(PurpleRoomlistField *field);
 
gboolean purple_roomlist_field_get_hidden(PurpleRoomlistField *field);
 
/**************************************************************************/
/**************************************************************************/
void purple_roomlist_set_ui_ops(PurpleRoomlistUiOps *ops);
 
PurpleRoomlistUiOps *purple_roomlist_get_ui_ops(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _PURPLE_ROOMLIST_H_ */