gtkblist.h

Go to the documentation of this file.

 
/* pidgin
 *
 * Pidgin 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 _PIDGINBLIST_H_
#define _PIDGINBLIST_H_
 
typedef struct _PidginBuddyList PidginBuddyList;
 
enum {
    STATUS_ICON_COLUMN,
    STATUS_ICON_VISIBLE_COLUMN,
    NAME_COLUMN,
    IDLE_COLUMN,
    IDLE_VISIBLE_COLUMN,
    BUDDY_ICON_COLUMN,
    BUDDY_ICON_VISIBLE_COLUMN,
    NODE_COLUMN,
    BGCOLOR_COLUMN,
    GROUP_EXPANDER_COLUMN,
    GROUP_EXPANDER_VISIBLE_COLUMN,
    CONTACT_EXPANDER_COLUMN,
    CONTACT_EXPANDER_VISIBLE_COLUMN,
    EMBLEM_COLUMN,
    EMBLEM_VISIBLE_COLUMN,
    PROTOCOL_ICON_COLUMN,
    PROTOCOL_ICON_VISIBLE_COLUMN,
    BLIST_COLUMNS
 
};
 
typedef enum {
    PIDGIN_STATUS_ICON_LARGE,
    PIDGIN_STATUS_ICON_SMALL
 
} PidginStatusIconSize;
 
#include "pidgin.h"
#include "blist.h"
#include "gtkblist-theme.h"
 
/**************************************************************************
 * @name Structures
 **************************************************************************/
struct _PidginBuddyList {
    GtkWidget *window;
    GtkWidget *notebook;            
    GtkWidget *main_vbox;           
    GtkWidget *vbox;                
    GtkWidget *treeview;            
    GtkTreeStore *treemodel;        
    GtkTreeViewColumn *text_column; 
    GtkCellRenderer *text_rend;
 
    GtkItemFactory *ift;
    GtkWidget *menutray;            
    GtkWidget *menutrayicon;        
    GHashTable *connection_errors;
 
    guint refresh_timer;            
    guint      timeout;              
    guint      drag_timeout;         
    GdkRectangle tip_rect;           
    GdkRectangle contact_rect;       
    PurpleBlistNode *mouseover_contact; 
    GtkWidget *tipwindow;            
    GList *tooltipdata;              
    PurpleBlistNode *selected_node;    
    GdkCursor *hand_cursor;         
    GdkCursor *arrow_cursor;        
    GtkWidget *scrollbook;          
    GtkWidget *headline_hbox;       
    GtkWidget *headline_label;  
    GtkWidget *headline_image;      
    GdkPixbuf *headline_close;      
    GCallback headline_callback;    
    gpointer headline_data;         
    GDestroyNotify headline_destroy; 
    gboolean changing_style;        
    GtkWidget *error_buttons;        
    GtkWidget *statusbox;            
    GdkPixbuf *empty_avatar;         
    gpointer priv;                   
};
 
#define PIDGIN_BLIST(list) ((PidginBuddyList *)purple_blist_get_ui_data())
#define PIDGIN_IS_PIDGIN_BLIST(list) \
    (purple_blist_get_ui_ops() == pidgin_blist_get_ui_ops())
 
/**************************************************************************
 * @name GTK+ Buddy List API
 **************************************************************************/
 
void *pidgin_blist_get_handle(void);
 
void pidgin_blist_init(void);
 
void pidgin_blist_uninit(void);
 
PurpleBlistUiOps *pidgin_blist_get_ui_ops(void);
 
PidginBuddyList *pidgin_blist_get_default_gtk_blist(void);
 
void pidgin_blist_make_buddy_menu(GtkWidget *menu, PurpleBuddy *buddy, gboolean sub);
 
void pidgin_blist_refresh(PurpleBuddyList *list);
 
void pidgin_blist_update_columns(void);
void pidgin_blist_update_refresh_timeout(void);
 
GdkPixbuf *
pidgin_blist_get_emblem(PurpleBlistNode *node);
 
GdkPixbuf *pidgin_blist_get_status_icon(PurpleBlistNode *node,
        PidginStatusIconSize size);
 
gboolean pidgin_blist_node_is_contact_expanded(PurpleBlistNode *node);
 
void pidgin_blist_toggle_visibility(void);
 
void pidgin_blist_visibility_manager_add(void);
 
void pidgin_blist_visibility_manager_remove(void);
 
void pidgin_blist_add_alert(GtkWidget *widget);
 
void pidgin_blist_set_theme(PidginBlistTheme *theme);
 
PidginBlistTheme *pidgin_blist_get_theme(void);
 
/**************************************************************************
 * @name GTK+ Buddy List sorting functions
 **************************************************************************/
 
typedef void (*pidgin_blist_sort_function)(PurpleBlistNode *new, PurpleBuddyList *blist, GtkTreeIter group, GtkTreeIter *cur, GtkTreeIter *iter);
 
GList *pidgin_blist_get_sort_methods(void);
 
struct pidgin_blist_sort_method {
    char *id;
    char *name;
    pidgin_blist_sort_function func;
};
 
typedef struct pidgin_blist_sort_method PidginBlistSortMethod;
 
void pidgin_blist_sort_method_reg(const char *id, const char *name, pidgin_blist_sort_function func);
 
void pidgin_blist_sort_method_unreg(const char *id);
 
void pidgin_blist_sort_method_set(const char *id);
 
void pidgin_blist_setup_sort_methods(void);
 
void pidgin_blist_update_accounts_menu(void);
 
void pidgin_blist_update_plugin_actions(void);
 
void pidgin_blist_update_sort_methods(void);
 
gboolean pidgin_blist_joinchat_is_showable(void);
 
void pidgin_blist_joinchat_show(void);
 
void pidgin_append_blist_node_privacy_menu(GtkWidget *menu, PurpleBlistNode *node);
 
void pidgin_append_blist_node_proto_menu (GtkWidget *menu, PurpleConnection *gc, PurpleBlistNode *node);
 
void pidgin_append_blist_node_extended_menu(GtkWidget *menu, PurpleBlistNode *node);
 
void pidgin_blist_update_account_error_state(PurpleAccount *account, const char *message);
 
void pidgin_blist_set_headline(const char *text, GdkPixbuf *pixbuf, GCallback callback, gpointer user_data,
        GDestroyNotify destroy);
 
gchar *pidgin_blist_get_name_markup(PurpleBuddy *buddy, gboolean selected, gboolean aliased);
 
void pidgin_blist_draw_tooltip(PurpleBlistNode *node, GtkWidget *widget);
 
void pidgin_blist_tooltip_destroy(void);
 
 
#endif /* _PIDGINBLIST_H_ */