src/gtklist.h

   1 /**
   2  * @file gtklist.h GTK+ Buddy List API
   3  * @ingroup gtkui
   4  *
   5  * gaim
   6  *
   7  * Copyright (C) 2002-2003, Sean Egan <sean.egan@binghamton.edu>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22  */
  23
  24 #ifndef _GAIM_GTK_LIST_H_
  25 #define _GAIM_GTK_LIST_H_
  26
  27 enum {
  28         STATUS_ICON_COLUMN,
  29         STATUS_ICON_VISIBLE_COLUMN,
  30         NAME_COLUMN,
  31         WARNING_COLUMN,
  32         IDLE_COLUMN,
  33         BUDDY_ICON_COLUMN,
  34         NODE_COLUMN,
  35         BLIST_COLUMNS
  36         };
  37
  38 typedef enum {
  39         GAIM_STATUS_ICON_LARGE,
  40         GAIM_STATUS_ICON_SMALL
  41 } GaimStatusIconSize;
  42 /**************************************************************************
  43  * @name Structures
  44  **************************************************************************/
  45 /**
  46  * Like, everything you need to know about the gtk buddy list
  47  */
  48 struct gaim_gtk_buddy_list {
  49         GtkWidget *window;
  50         GtkWidget *vbox;                /**< This is the vbox that everything gets packed into.  Your plugin might
  51                                            want to pack something in it itself.  Go, plugins! */
  52
  53         GtkWidget *treeview;            /**< It's a treeview... d'uh. */
  54         GtkTreeStore *treemodel;        /**< This is the treemodel.  */
  55         GtkTreeViewColumn *idle_column,
  56                 *warning_column,
  57                 *buddy_icon_column;
  58
  59         GtkWidget *bpmenu;              /**< The buddy pounce menu. */
  60
  61         GtkWidget *bbox;                /**< A Button Box. */
  62         GtkTooltips *tooltips;           /**< Tooltips for the buttons. */
  63
  64         guint refresh_timer;            /**< The timer for refreshing every 30 seconds */
  65
  66         guint      timeout;              /**< The timeout for the tooltip. */
  67         GdkRectangle rect;               /**< This is the bounding rectangle of the
  68                                                cell we're currently hovering over.  This is
  69                                                used for tooltips. */
  70         GtkWidget *tipwindow;            /**< The window used by the tooltip */
  71
  72         GaimBlistNode *selected_node;   /**< The currently selected node */
  73 };
  74
  75 #define GAIM_GTK_BLIST(list) ((struct gaim_gtk_buddy_list *)(list)->ui_data)
  76 #define GAIM_IS_GTK_BLIST(list) \
  77         ((list)->ui_ops == gaim_get_gtk_blist_ui_ops())
  78
  79 /**************************************************************************
  80  * @name GTK+ Conversation API
  81  **************************************************************************/
  82 /**
  83  * Returns the UI operations structure for the buddy list.
  84  *
  85  * @return The GTK list operations structure.
  86  */
  87 struct gaim_blist_ui_ops *gaim_get_gtk_blist_ui_ops(void);
  88
  89 /**
  90  * Returns the base image to represent the account, based on the currently selected theme
  91  *
  92  * @param account  The account.
  93  *
  94  * @return         The icon
  95  */
  96 GdkPixbuf *create_prpl_icon(struct gaim_account *account);
  97
  98 /**
  99  * Refreshes all the nodes of the buddy list.
 100  * This should only be called when something changes to affect most of the nodes (such as a ui preference changing)
 101  *
 102  * @param list   This is the core list that gets updated from
 103  */
 104 void gaim_gtk_blist_refresh(struct gaim_buddy_list *list);
 105
 106 /**
 107  * Tells the buddy list to update its toolbar based on the preferences
 108  *
 109  */
 110 void gaim_gtk_blist_update_toolbar();
 111
 112 /**
 113  * Useful for the docklet plugin and also for the win32 tray icon
 114  * This is called when one of those is clicked--it will show/hide the
 115  * buddy list/login window--depending on which is active
 116  */
 117 void gaim_gtk_blist_docklet_toggle();
 118 void gaim_gtk_blist_docklet_add();
 119 void gaim_gtk_blist_docklet_remove();
 120 void gaim_gtk_blist_update_columns();
 121
 122 #endif /* _GAIM_GTK_LIST_H_ */