Mercurial > pidgin.yaz
annotate src/gtkblist.h @ 12849:c0fbdea8828b
[gaim-migrate @ 15199]
SF Patch #1230429 from Jean-Yves Lefort
"Block instant messages in core if a prpl does not
support privacy."
I modified this to use the gaim_privacy_check() Sadrul added a while back. I
also cleaned up the loose end, rather than leaving a function that always
returned TRUE. Finally, I added the same check to the chat invite handler.
committer: Tailor Script <tailor@pidgin.im>
author | Richard Laager <rlaager@wiktel.com> |
---|---|
date | Thu, 12 Jan 2006 06:44:23 +0000 |
parents | 301e9f0841d7 |
children | 2d71d4081e06 |
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; |
12116
e75ef7aa913e
[gaim-migrate @ 14416]
Luke Schierer <lschiere@pidgin.im>
parents:
12080
diff
changeset
|
71 GtkWidget *menutray; /**< The menu tray widget. */ |
e75ef7aa913e
[gaim-migrate @ 14416]
Luke Schierer <lschiere@pidgin.im>
parents:
12080
diff
changeset
|
72 GtkWidget *menutrayicon; /**< The menu tray icon. */ |
5228 | 73 |
74 guint refresh_timer; /**< The timer for refreshing every 30 seconds */ | |
75 | |
76 guint timeout; /**< The timeout for the tooltip. */ | |
10354 | 77 guint drag_timeout; /**< The timeout for expanding contacts on drags */ |
7636 | 78 GdkRectangle tip_rect; /**< This is the bounding rectangle of the |
79 cell we're currently hovering over. This is | |
80 used for tooltips. */ | |
81 GdkRectangle contact_rect; /**< This is the bounding rectangle of the contact node | |
82 and its children. This is used for auto-expand on | |
83 mouseover. */ | |
84 GaimBlistNode *mouseover_contact; /**< This is the contact currently mouse-over expanded */ | |
85 | |
5228 | 86 GtkWidget *tipwindow; /**< The window used by the tooltip */ |
11890 | 87 GList *tooltipdata; /**< The data for each "chunk" of the tooltip */ |
5228 | 88 |
89 GaimBlistNode *selected_node; /**< The currently selected node */ | |
10643 | 90 GtkWidget *statusbox; /**< The status selector dropdown */ |
7304 | 91 GdkPixbuf *east, *south; /**< Drop shadow stuff */ |
92 GdkWindow *east_shadow, *south_shadow; /**< Drop shadow stuff */ | |
93 | |
10008 | 94 }; |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
95 |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
96 #define GAIM_GTK_BLIST(list) ((GaimGtkBuddyList *)(list)->ui_data) |
5228 | 97 #define GAIM_IS_GTK_BLIST(list) \ |
7035
feb3d21a7794
[gaim-migrate @ 7598]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
98 ((list)->ui_ops == gaim_gtk_blist_get_ui_ops()) |
5228 | 99 |
100 /************************************************************************** | |
5422 | 101 * @name GTK+ Buddy List API |
5228 | 102 **************************************************************************/ |
5906 | 103 |
104 /** | |
8815 | 105 * Get the handle for the GTK+ blist system. |
106 * | |
107 * @return the handle to the blist system | |
108 */ | |
12323
fc464a0abccc
[gaim-migrate @ 14627]
Richard Laager <rlaager@wiktel.com>
parents:
12296
diff
changeset
|
109 void *gaim_gtk_blist_get_handle(void); |
8815 | 110 |
111 /** | |
5906 | 112 * Initializes the GTK+ blist system. |
113 */ | |
114 void gaim_gtk_blist_init(void); | |
115 | |
5228 | 116 /** |
8815 | 117 * Uninitializes the GTK+ blist system. |
118 */ | |
119 void gaim_gtk_blist_uninit(void); | |
120 | |
121 /** | |
5228 | 122 * Returns the UI operations structure for the buddy list. |
123 * | |
10814
364a2ef907ae
[gaim-migrate @ 12468]
Luke Schierer <lschiere@pidgin.im>
parents:
10643
diff
changeset
|
124 * @return The GTK+ list operations structure. |
5228 | 125 */ |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
126 GaimBlistUiOps *gaim_gtk_blist_get_ui_ops(void); |
5228 | 127 |
128 /** | |
10643 | 129 * Returns the default gtk buddy list |
11732 | 130 * |
10643 | 131 * There's normally only one buddy list window, but that isn't a necessity. This function |
132 * returns the GaimGtkBuddyList we're most likely wanting to work with. This is slightly | |
133 * cleaner than an externed global. | |
11732 | 134 * |
10814
364a2ef907ae
[gaim-migrate @ 12468]
Luke Schierer <lschiere@pidgin.im>
parents:
10643
diff
changeset
|
135 * @return The default GTK+ buddy list |
10643 | 136 */ |
12323
fc464a0abccc
[gaim-migrate @ 14627]
Richard Laager <rlaager@wiktel.com>
parents:
12296
diff
changeset
|
137 GaimGtkBuddyList *gaim_gtk_blist_get_default_gtk_blist(void); |
10643 | 138 |
139 /** | |
9774 | 140 * Populates a menu with the items shown on the buddy list for a buddy. |
141 * | |
142 * @param menu The menu to populate | |
143 * @param buddy The buddy who's menu to get | |
10484 | 144 * @param sub TRUE if this is a sub-menu, FALSE otherwise |
9774 | 145 */ |
10484 | 146 void gaim_gtk_blist_make_buddy_menu(GtkWidget *menu, GaimBuddy *buddy, gboolean sub); |
9774 | 147 |
148 /** | |
5228 | 149 * Refreshes all the nodes of the buddy list. |
150 * This should only be called when something changes to affect most of the nodes (such as a ui preference changing) | |
151 * | |
152 * @param list This is the core list that gets updated from | |
153 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
154 void gaim_gtk_blist_refresh(GaimBuddyList *list); |
5228 | 155 |
156 /** | |
157 * Tells the buddy list to update its toolbar based on the preferences | |
158 * | |
159 */ | |
12323
fc464a0abccc
[gaim-migrate @ 14627]
Richard Laager <rlaager@wiktel.com>
parents:
12296
diff
changeset
|
160 void gaim_gtk_blist_update_toolbar(void); |
5228 | 161 |
12323
fc464a0abccc
[gaim-migrate @ 14627]
Richard Laager <rlaager@wiktel.com>
parents:
12296
diff
changeset
|
162 void gaim_gtk_blist_update_columns(void); |
fc464a0abccc
[gaim-migrate @ 14627]
Richard Laager <rlaager@wiktel.com>
parents:
12296
diff
changeset
|
163 void gaim_gtk_blist_update_refresh_timeout(void); |
5228 | 164 |
165 /** | |
166 * Useful for the buddy ticker | |
167 */ | |
5234 | 168 GdkPixbuf *gaim_gtk_blist_get_status_icon(GaimBlistNode *node, |
5228 | 169 GaimStatusIconSize size); |
170 | |
11018 | 171 /** |
172 * Returns a boolean indicating if @a node is part of an expanded contact. | |
173 * | |
174 * This only makes sense for contact and buddy nodes. @c FALSE is returned | |
175 * for other types of nodes. | |
176 * | |
177 * @param node The node in question. | |
178 * @return A boolean indicating if @a node is part of an expanded contact. | |
179 */ | |
180 gboolean gaim_gtk_blist_node_is_contact_expanded(GaimBlistNode *node); | |
181 | |
12017
2b6e0be024fb
[gaim-migrate @ 14310]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
11890
diff
changeset
|
182 /** |
2b6e0be024fb
[gaim-migrate @ 14310]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
11890
diff
changeset
|
183 * Intelligently toggles the visibility of the buddy list. If the buddy |
2b6e0be024fb
[gaim-migrate @ 14310]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
11890
diff
changeset
|
184 * list is obscured, it is brought to the front. If it is not obscured, |
2b6e0be024fb
[gaim-migrate @ 14310]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
11890
diff
changeset
|
185 * it is hidden. If it is hidden it is shown. |
2b6e0be024fb
[gaim-migrate @ 14310]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
11890
diff
changeset
|
186 */ |
12323
fc464a0abccc
[gaim-migrate @ 14627]
Richard Laager <rlaager@wiktel.com>
parents:
12296
diff
changeset
|
187 void gaim_gtk_blist_toggle_visibility(void); |
12017
2b6e0be024fb
[gaim-migrate @ 14310]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
11890
diff
changeset
|
188 |
2b6e0be024fb
[gaim-migrate @ 14310]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
11890
diff
changeset
|
189 /** |
2b6e0be024fb
[gaim-migrate @ 14310]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
11890
diff
changeset
|
190 * Increases the reference count of visibility managers. Callers should |
2b6e0be024fb
[gaim-migrate @ 14310]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
11890
diff
changeset
|
191 * call the complementary remove function when no longer managing |
2b6e0be024fb
[gaim-migrate @ 14310]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
11890
diff
changeset
|
192 * visibility. |
2b6e0be024fb
[gaim-migrate @ 14310]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
11890
diff
changeset
|
193 * |
2b6e0be024fb
[gaim-migrate @ 14310]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
11890
diff
changeset
|
194 * A visibility manager is something that provides some method for |
2b6e0be024fb
[gaim-migrate @ 14310]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
11890
diff
changeset
|
195 * showing the buddy list after it is hidden (e.g. docklet plugin). |
2b6e0be024fb
[gaim-migrate @ 14310]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
11890
diff
changeset
|
196 */ |
12323
fc464a0abccc
[gaim-migrate @ 14627]
Richard Laager <rlaager@wiktel.com>
parents:
12296
diff
changeset
|
197 void gaim_gtk_blist_visibility_manager_add(void); |
12017
2b6e0be024fb
[gaim-migrate @ 14310]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
11890
diff
changeset
|
198 |
2b6e0be024fb
[gaim-migrate @ 14310]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
11890
diff
changeset
|
199 /** |
2b6e0be024fb
[gaim-migrate @ 14310]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
11890
diff
changeset
|
200 * Decreases the reference count of visibility managers. If the count |
2b6e0be024fb
[gaim-migrate @ 14310]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
11890
diff
changeset
|
201 * drops below zero, the buddy list is shown. |
2b6e0be024fb
[gaim-migrate @ 14310]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
11890
diff
changeset
|
202 */ |
12323
fc464a0abccc
[gaim-migrate @ 14627]
Richard Laager <rlaager@wiktel.com>
parents:
12296
diff
changeset
|
203 void gaim_gtk_blist_visibility_manager_remove(void); |
12017
2b6e0be024fb
[gaim-migrate @ 14310]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
11890
diff
changeset
|
204 |
2b6e0be024fb
[gaim-migrate @ 14310]
Daniel Atallah <daniel.atallah@gmail.com>
parents:
11890
diff
changeset
|
205 |
5422 | 206 /************************************************************************** |
207 * @name GTK+ Buddy List sorting functions | |
208 **************************************************************************/ | |
209 | |
12413
0332daad85ae
[gaim-migrate @ 14720]
Richard Laager <rlaager@wiktel.com>
parents:
12323
diff
changeset
|
210 typedef void (*gaim_gtk_blist_sort_function)(GaimBlistNode *new, GaimBuddyList *blist, GtkTreeIter group, GtkTreeIter *cur, GtkTreeIter *iter); |
5422 | 211 |
11796 | 212 /** |
213 * Gets the current list of sort methods. | |
214 * | |
215 * @return A GSlist of sort methods | |
216 */ | |
12323
fc464a0abccc
[gaim-migrate @ 14627]
Richard Laager <rlaager@wiktel.com>
parents:
12296
diff
changeset
|
217 GList *gaim_gtk_blist_get_sort_methods(void); |
5422 | 218 |
219 struct gaim_gtk_blist_sort_method { | |
5631 | 220 char *id; |
5422 | 221 char *name; |
222 gaim_gtk_blist_sort_function func; | |
223 }; | |
224 | |
11796 | 225 typedef struct gaim_gtk_blist_sort_method GaimGtkBlistSortMethod; |
226 | |
5422 | 227 /** |
228 * Registers a buddy list sorting method. | |
229 * | |
5631 | 230 * @param id The unique ID of the sorting method |
5422 | 231 * @param name The method's name. |
232 * @param func A pointer to the function. | |
233 * | |
234 */ | |
5631 | 235 void gaim_gtk_blist_sort_method_reg(const char *id, const char *name, gaim_gtk_blist_sort_function func); |
5422 | 236 |
237 /** | |
238 * Unregisters a buddy list sorting method. | |
239 * | |
5631 | 240 * @param id The method's id |
5422 | 241 */ |
5631 | 242 void gaim_gtk_blist_sort_method_unreg(const char *id); |
5422 | 243 |
244 /** | |
245 * Sets a buddy list sorting method. | |
246 * | |
5631 | 247 * @param id The method's id. |
5422 | 248 */ |
5631 | 249 void gaim_gtk_blist_sort_method_set(const char *id); |
5422 | 250 |
251 /** | |
252 * Sets up the programs default sort methods | |
253 */ | |
12323
fc464a0abccc
[gaim-migrate @ 14627]
Richard Laager <rlaager@wiktel.com>
parents:
12296
diff
changeset
|
254 void gaim_gtk_blist_setup_sort_methods(void); |
5422 | 255 |
5936
1b56a833d665
[gaim-migrate @ 6376]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
256 /** |
12296
2f4577ae3810
[gaim-migrate @ 14600]
Etan Reisner <pidgin@unreliablesource.net>
parents:
12136
diff
changeset
|
257 * Updates the accounts menu on the GTK+ buddy list window. |
5936
1b56a833d665
[gaim-migrate @ 6376]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
258 */ |
12323
fc464a0abccc
[gaim-migrate @ 14627]
Richard Laager <rlaager@wiktel.com>
parents:
12296
diff
changeset
|
259 void gaim_gtk_blist_update_accounts_menu(void); |
5422 | 260 |
8305
57bdd25752c1
[gaim-migrate @ 9029]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
261 /** |
8986 | 262 * Updates the plugin actions menu on the GTK+ buddy list window. |
263 */ | |
12323
fc464a0abccc
[gaim-migrate @ 14627]
Richard Laager <rlaager@wiktel.com>
parents:
12296
diff
changeset
|
264 void gaim_gtk_blist_update_plugin_actions(void); |
8986 | 265 |
266 /** | |
11796 | 267 * Updates the Sorting menu on the GTK+ buddy list window. |
268 */ | |
12323
fc464a0abccc
[gaim-migrate @ 14627]
Richard Laager <rlaager@wiktel.com>
parents:
12296
diff
changeset
|
269 void gaim_gtk_blist_update_sort_methods(void); |
11796 | 270 |
271 /** | |
8940 | 272 * Determines if showing the join chat dialog is a valid action. |
273 * | |
274 * @return Returns TRUE if there are accounts online capable of | |
275 * joining chat rooms. Otherwise returns FALSE. | |
8305
57bdd25752c1
[gaim-migrate @ 9029]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
276 */ |
8940 | 277 gboolean gaim_gtk_blist_joinchat_is_showable(void); |
278 | |
279 /** | |
280 * Shows the join chat dialog. | |
281 */ | |
282 void gaim_gtk_blist_joinchat_show(void); | |
5422 | 283 |
9051 | 284 /** |
285 * Appends the protocol specific menu items for a GaimBlistNode | |
286 */ | |
287 void gaim_gtk_append_blist_node_proto_menu (GtkWidget *menu, GaimConnection *gc, GaimBlistNode *node); | |
288 | |
289 /** | |
290 * Appends the extended menu items for a GaimBlistNode | |
291 */ | |
292 void gaim_gtk_append_blist_node_extended_menu(GtkWidget *menu, GaimBlistNode *node); | |
293 | |
9713 | 294 #endif /* _GAIM_GTKBLIST_H_ */ |