Mercurial > pidgin
annotate src/gtkblist.h @ 5864:417b1001d2b1
[gaim-migrate @ 6295]
Rewrote the pounce API again. Now it's even MORE core/UI-split, and will
allow for loading/saving.
committer: Tailor Script <tailor@pidgin.im>
author | Christian Hammond <chipx86@chipx86.com> |
---|---|
date | Sat, 14 Jun 2003 11:14:49 +0000 |
parents | 960fe32ea9b7 |
children | 059d95c67cda |
rev | line source |
---|---|
5228 | 1 /** |
5248 | 2 * @file gtkblist.h GTK+ Buddy List API |
5228 | 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 | |
5427 | 59 GtkItemFactory *ift; |
5228 | 60 GtkWidget *bpmenu; /**< The buddy pounce menu. */ |
61 | |
62 GtkWidget *bbox; /**< A Button Box. */ | |
63 GtkTooltips *tooltips; /**< Tooltips for the buttons. */ | |
64 | |
65 guint refresh_timer; /**< The timer for refreshing every 30 seconds */ | |
66 | |
67 guint timeout; /**< The timeout for the tooltip. */ | |
68 GdkRectangle rect; /**< This is the bounding rectangle of the | |
69 cell we're currently hovering over. This is | |
70 used for tooltips. */ | |
71 GtkWidget *tipwindow; /**< The window used by the tooltip */ | |
72 | |
73 GaimBlistNode *selected_node; /**< The currently selected node */ | |
74 }; | |
75 | |
76 #define GAIM_GTK_BLIST(list) ((struct gaim_gtk_buddy_list *)(list)->ui_data) | |
77 #define GAIM_IS_GTK_BLIST(list) \ | |
78 ((list)->ui_ops == gaim_get_gtk_blist_ui_ops()) | |
79 | |
80 /************************************************************************** | |
5422 | 81 * @name GTK+ Buddy List API |
5228 | 82 **************************************************************************/ |
83 /** | |
84 * Returns the UI operations structure for the buddy list. | |
85 * | |
86 * @return The GTK list operations structure. | |
87 */ | |
88 struct gaim_blist_ui_ops *gaim_get_gtk_blist_ui_ops(void); | |
89 | |
90 /** | |
91 * Returns the base image to represent the account, based on the currently selected theme | |
92 * | |
93 * @param account The account. | |
94 * | |
95 * @return The icon | |
96 */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5427
diff
changeset
|
97 GdkPixbuf *create_prpl_icon(GaimAccount *account); |
5228 | 98 |
99 /** | |
100 * Refreshes all the nodes of the buddy list. | |
101 * This should only be called when something changes to affect most of the nodes (such as a ui preference changing) | |
102 * | |
103 * @param list This is the core list that gets updated from | |
104 */ | |
105 void gaim_gtk_blist_refresh(struct gaim_buddy_list *list); | |
106 | |
107 /** | |
108 * Tells the buddy list to update its toolbar based on the preferences | |
109 * | |
110 */ | |
111 void gaim_gtk_blist_update_toolbar(); | |
112 | |
113 /** | |
114 * Useful for the docklet plugin and also for the win32 tray icon | |
115 * This is called when one of those is clicked--it will show/hide the | |
116 * buddy list/login window--depending on which is active | |
117 */ | |
118 void gaim_gtk_blist_docklet_toggle(); | |
119 void gaim_gtk_blist_docklet_add(); | |
120 void gaim_gtk_blist_docklet_remove(); | |
121 void gaim_gtk_blist_update_columns(); | |
5411 | 122 void gaim_gtk_blist_update_refresh_timeout(); |
5228 | 123 |
124 /** | |
125 * Useful for the buddy ticker | |
126 */ | |
5234 | 127 GdkPixbuf *gaim_gtk_blist_get_status_icon(GaimBlistNode *node, |
5228 | 128 GaimStatusIconSize size); |
129 | |
5422 | 130 /************************************************************************** |
131 * @name GTK+ Buddy List sorting functions | |
132 **************************************************************************/ | |
133 | |
134 typedef GtkTreeIter (*gaim_gtk_blist_sort_function)(GaimBlistNode *new, struct gaim_buddy_list *blist, GtkTreeIter group, GtkTreeIter *cur); | |
135 | |
136 extern GSList *gaim_gtk_blist_sort_methods; | |
137 | |
138 struct gaim_gtk_blist_sort_method { | |
5631 | 139 char *id; |
5422 | 140 char *name; |
141 gaim_gtk_blist_sort_function func; | |
142 }; | |
143 | |
144 /** | |
145 * Registers a buddy list sorting method. | |
146 * | |
5631 | 147 * @param id The unique ID of the sorting method |
5422 | 148 * @param name The method's name. |
149 * @param func A pointer to the function. | |
150 * | |
151 */ | |
5631 | 152 void gaim_gtk_blist_sort_method_reg(const char *id, const char *name, gaim_gtk_blist_sort_function func); |
5422 | 153 |
154 /** | |
155 * Unregisters a buddy list sorting method. | |
156 * | |
5631 | 157 * @param id The method's id |
5422 | 158 */ |
5631 | 159 void gaim_gtk_blist_sort_method_unreg(const char *id); |
5422 | 160 |
161 /** | |
162 * Sets a buddy list sorting method. | |
163 * | |
5631 | 164 * @param id The method's id. |
5422 | 165 */ |
5631 | 166 void gaim_gtk_blist_sort_method_set(const char *id); |
5422 | 167 |
168 /** | |
169 * Sets up the programs default sort methods | |
170 */ | |
171 void gaim_gtk_blist_setup_sort_methods(); | |
172 | |
173 | |
174 | |
5228 | 175 #endif /* _GAIM_GTK_LIST_H_ */ |