src/gtklist.h

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