Mercurial > pidgin
annotate src/gtkblist.h @ 11709:cae2fb7e8594
[gaim-migrate @ 14000]
This is a patch from Casey Harkins to significantly overhaul the docklet plugin. I'm pretty happy about this because it enables us to remove a win32 GTK+ dependency on the core and all the prpls.
committer: Tailor Script <tailor@pidgin.im>
author | Daniel Atallah <daniel.atallah@gmail.com> |
---|---|
date | Sat, 22 Oct 2005 01:18:08 +0000 |
parents | cedd48571c90 |
children | 03c813a42c76 |
rev | line source |
---|---|
5228 | 1 /** |
5248 | 2 * @file gtkblist.h GTK+ Buddy List API |
5228 | 3 * @ingroup gtkui |
4 * | |
5 * gaim | |
6 * | |
8046 | 7 * Gaim is the legal property of its developers, whose names are too numerous |
8 * to list here. Please refer to the COPYRIGHT file distributed with this | |
9 * source distribution. | |
5906 | 10 * |
5228 | 11 * This program is free software; you can redistribute it and/or modify |
12 * it under the terms of the GNU General Public License as published by | |
13 * the Free Software Foundation; either version 2 of the License, or | |
14 * (at your option) any later version. | |
15 * | |
16 * This program is distributed in the hope that it will be useful, | |
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 * GNU General Public License for more details. | |
20 * | |
21 * You should have received a copy of the GNU General Public License | |
22 * along with this program; if not, write to the Free Software | |
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
24 */ | |
9713 | 25 #ifndef _GAIM_GTKBLIST_H_ |
26 #define _GAIM_GTKBLIST_H_ | |
5228 | 27 |
10008 | 28 typedef struct _GaimGtkBuddyList GaimGtkBuddyList; |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5631
diff
changeset
|
29 |
5228 | 30 enum { |
31 STATUS_ICON_COLUMN, | |
32 STATUS_ICON_VISIBLE_COLUMN, | |
33 NAME_COLUMN, | |
34 IDLE_COLUMN, | |
35 BUDDY_ICON_COLUMN, | |
36 NODE_COLUMN, | |
37 BLIST_COLUMNS | |
10008 | 38 |
39 }; | |
5228 | 40 |
41 typedef enum { | |
42 GAIM_STATUS_ICON_LARGE, | |
43 GAIM_STATUS_ICON_SMALL | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
44 |
5228 | 45 } GaimStatusIconSize; |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
46 |
10008 | 47 #include "gtkgaim.h" |
48 #include "blist.h" | |
49 | |
5228 | 50 /************************************************************************** |
51 * @name Structures | |
52 **************************************************************************/ | |
53 /** | |
54 * Like, everything you need to know about the gtk buddy list | |
55 */ | |
10008 | 56 struct _GaimGtkBuddyList { |
5228 | 57 GtkWidget *window; |
58 GtkWidget *vbox; /**< This is the vbox that everything gets packed into. Your plugin might | |
59 want to pack something in it itself. Go, plugins! */ | |
60 | |
61 GtkWidget *treeview; /**< It's a treeview... d'uh. */ | |
62 GtkTreeStore *treemodel; /**< This is the treemodel. */ | |
6695 | 63 GtkTreeViewColumn *idle_column, |
64 *warning_column, | |
11016 | 65 *buddy_icon_column, |
66 *text_column; | |
67 | |
68 GtkCellRenderer *text_rend; | |
5228 | 69 |
5427 | 70 GtkItemFactory *ift; |
5228 | 71 GtkWidget *bpmenu; /**< The buddy pounce menu. */ |
72 | |
73 guint refresh_timer; /**< The timer for refreshing every 30 seconds */ | |
74 | |
75 guint timeout; /**< The timeout for the tooltip. */ | |
10354 | 76 guint drag_timeout; /**< The timeout for expanding contacts on drags */ |
7636 | 77 GdkRectangle tip_rect; /**< This is the bounding rectangle of the |
78 cell we're currently hovering over. This is | |
79 used for tooltips. */ | |
80 GdkRectangle contact_rect; /**< This is the bounding rectangle of the contact node | |
81 and its children. This is used for auto-expand on | |
82 mouseover. */ | |
83 GaimBlistNode *mouseover_contact; /**< This is the contact currently mouse-over expanded */ | |
84 | |
5228 | 85 GtkWidget *tipwindow; /**< The window used by the tooltip */ |
11637 | 86 char *tooltiptext; /**< The text displayed in tipwindow */ |
5228 | 87 |
88 GaimBlistNode *selected_node; /**< The currently selected node */ | |
10643 | 89 GtkWidget *statusbox; /**< The status selector dropdown */ |
7304 | 90 GdkPixbuf *east, *south; /**< Drop shadow stuff */ |
91 GdkWindow *east_shadow, *south_shadow; /**< Drop shadow stuff */ | |
92 | |
10008 | 93 }; |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
94 |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
95 #define GAIM_GTK_BLIST(list) ((GaimGtkBuddyList *)(list)->ui_data) |
5228 | 96 #define GAIM_IS_GTK_BLIST(list) \ |
7035
feb3d21a7794
[gaim-migrate @ 7598]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
97 ((list)->ui_ops == gaim_gtk_blist_get_ui_ops()) |
5228 | 98 |
99 /************************************************************************** | |
5422 | 100 * @name GTK+ Buddy List API |
5228 | 101 **************************************************************************/ |
5906 | 102 |
103 /** | |
8815 | 104 * Get the handle for the GTK+ blist system. |
105 * | |
106 * @return the handle to the blist system | |
107 */ | |
108 void *gaim_gtk_blist_get_handle(); | |
109 | |
110 /** | |
5906 | 111 * Initializes the GTK+ blist system. |
112 */ | |
113 void gaim_gtk_blist_init(void); | |
114 | |
5228 | 115 /** |
8815 | 116 * Uninitializes the GTK+ blist system. |
117 */ | |
118 void gaim_gtk_blist_uninit(void); | |
119 | |
120 /** | |
5228 | 121 * Returns the UI operations structure for the buddy list. |
122 * | |
10814
364a2ef907ae
[gaim-migrate @ 12468]
Luke Schierer <lschiere@pidgin.im>
parents:
10643
diff
changeset
|
123 * @return The GTK+ list operations structure. |
5228 | 124 */ |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
125 GaimBlistUiOps *gaim_gtk_blist_get_ui_ops(void); |
5228 | 126 |
127 /** | |
10643 | 128 * Returns the default gtk buddy list |
129 * | |
130 * There's normally only one buddy list window, but that isn't a necessity. This function | |
131 * returns the GaimGtkBuddyList we're most likely wanting to work with. This is slightly | |
132 * cleaner than an externed global. | |
133 * | |
10814
364a2ef907ae
[gaim-migrate @ 12468]
Luke Schierer <lschiere@pidgin.im>
parents:
10643
diff
changeset
|
134 * @return The default GTK+ buddy list |
10643 | 135 */ |
136 GaimGtkBuddyList *gaim_gtk_blist_get_default_gtk_blist(); | |
137 | |
138 /** | |
5228 | 139 * Returns the base image to represent the account, based on the currently selected theme |
140 * | |
141 * @param account The account. | |
6695 | 142 * |
5228 | 143 * @return The icon |
144 */ | |
10884 | 145 GdkPixbuf *gaim_gtk_create_prpl_icon(GaimAccount *account); |
5228 | 146 |
147 /** | |
9774 | 148 * Populates a menu with the items shown on the buddy list for a buddy. |
149 * | |
150 * @param menu The menu to populate | |
151 * @param buddy The buddy who's menu to get | |
10484 | 152 * @param sub TRUE if this is a sub-menu, FALSE otherwise |
9774 | 153 */ |
10484 | 154 void gaim_gtk_blist_make_buddy_menu(GtkWidget *menu, GaimBuddy *buddy, gboolean sub); |
9774 | 155 |
156 /** | |
5228 | 157 * Refreshes all the nodes of the buddy list. |
158 * This should only be called when something changes to affect most of the nodes (such as a ui preference changing) | |
159 * | |
160 * @param list This is the core list that gets updated from | |
161 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
162 void gaim_gtk_blist_refresh(GaimBuddyList *list); |
5228 | 163 |
164 /** | |
165 * Tells the buddy list to update its toolbar based on the preferences | |
166 * | |
167 */ | |
168 void gaim_gtk_blist_update_toolbar(); | |
169 | |
170 void gaim_gtk_blist_update_columns(); | |
5411 | 171 void gaim_gtk_blist_update_refresh_timeout(); |
5228 | 172 |
173 /** | |
174 * Useful for the buddy ticker | |
175 */ | |
5234 | 176 GdkPixbuf *gaim_gtk_blist_get_status_icon(GaimBlistNode *node, |
5228 | 177 GaimStatusIconSize size); |
178 | |
11018 | 179 /** |
180 * Returns a boolean indicating if @a node is part of an expanded contact. | |
181 * | |
182 * This only makes sense for contact and buddy nodes. @c FALSE is returned | |
183 * for other types of nodes. | |
184 * | |
185 * @param node The node in question. | |
186 * @return A boolean indicating if @a node is part of an expanded contact. | |
187 */ | |
188 gboolean gaim_gtk_blist_node_is_contact_expanded(GaimBlistNode *node); | |
189 | |
5422 | 190 /************************************************************************** |
191 * @name GTK+ Buddy List sorting functions | |
192 **************************************************************************/ | |
193 | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
194 typedef GtkTreeIter (*gaim_gtk_blist_sort_function)(GaimBlistNode *new, GaimBuddyList *blist, GtkTreeIter group, GtkTreeIter *cur); |
5422 | 195 |
196 extern GSList *gaim_gtk_blist_sort_methods; | |
197 | |
198 struct gaim_gtk_blist_sort_method { | |
5631 | 199 char *id; |
5422 | 200 char *name; |
201 gaim_gtk_blist_sort_function func; | |
202 }; | |
203 | |
204 /** | |
205 * Registers a buddy list sorting method. | |
206 * | |
5631 | 207 * @param id The unique ID of the sorting method |
5422 | 208 * @param name The method's name. |
209 * @param func A pointer to the function. | |
210 * | |
211 */ | |
5631 | 212 void gaim_gtk_blist_sort_method_reg(const char *id, const char *name, gaim_gtk_blist_sort_function func); |
5422 | 213 |
214 /** | |
215 * Unregisters a buddy list sorting method. | |
216 * | |
5631 | 217 * @param id The method's id |
5422 | 218 */ |
5631 | 219 void gaim_gtk_blist_sort_method_unreg(const char *id); |
5422 | 220 |
221 /** | |
222 * Sets a buddy list sorting method. | |
223 * | |
5631 | 224 * @param id The method's id. |
5422 | 225 */ |
5631 | 226 void gaim_gtk_blist_sort_method_set(const char *id); |
5422 | 227 |
228 /** | |
229 * Sets up the programs default sort methods | |
230 */ | |
231 void gaim_gtk_blist_setup_sort_methods(); | |
232 | |
5936
1b56a833d665
[gaim-migrate @ 6376]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
233 /** |
1b56a833d665
[gaim-migrate @ 6376]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
234 * Updates the protocol actions menu on the GTK+ buddy list window. |
1b56a833d665
[gaim-migrate @ 6376]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
235 */ |
1b56a833d665
[gaim-migrate @ 6376]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
236 void gaim_gtk_blist_update_protocol_actions(); |
5422 | 237 |
8305
57bdd25752c1
[gaim-migrate @ 9029]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
238 /** |
8986 | 239 * Updates the plugin actions menu on the GTK+ buddy list window. |
240 */ | |
241 void gaim_gtk_blist_update_plugin_actions(); | |
242 | |
243 /** | |
8940 | 244 * Determines if showing the join chat dialog is a valid action. |
245 * | |
246 * @return Returns TRUE if there are accounts online capable of | |
247 * joining chat rooms. Otherwise returns FALSE. | |
8305
57bdd25752c1
[gaim-migrate @ 9029]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
248 */ |
8940 | 249 gboolean gaim_gtk_blist_joinchat_is_showable(void); |
250 | |
251 /** | |
252 * Shows the join chat dialog. | |
253 */ | |
254 void gaim_gtk_blist_joinchat_show(void); | |
5422 | 255 |
9051 | 256 /** |
257 * Appends the protocol specific menu items for a GaimBlistNode | |
258 */ | |
259 void gaim_gtk_append_blist_node_proto_menu (GtkWidget *menu, GaimConnection *gc, GaimBlistNode *node); | |
260 | |
261 /** | |
262 * Appends the extended menu items for a GaimBlistNode | |
263 */ | |
264 void gaim_gtk_append_blist_node_extended_menu(GtkWidget *menu, GaimBlistNode *node); | |
265 | |
9713 | 266 #endif /* _GAIM_GTKBLIST_H_ */ |