Mercurial > pidgin.yaz
annotate src/gtkblist.h @ 11896:8aa6462e563c
[gaim-migrate @ 14187]
Change "Keep the dialog open" to "Close this window when all transfers finish". I think that's a lot clearer. I didn't change the underlying preference, just inverted the value when setting up the checkbox. That seemed like a lot of work for very little gain.
committer: Tailor Script <tailor@pidgin.im>
author | Richard Laager <rlaager@wiktel.com> |
---|---|
date | Sat, 29 Oct 2005 21:11:07 +0000 |
parents | fdb78734e2ae |
children | 2b6e0be024fb |
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 */ |
11890 | 86 GList *tooltipdata; /**< The data for each "chunk" of the tooltip */ |
5228 | 87 |
88 GaimBlistNode *selected_node; /**< The currently selected node */ | |
10643 | 89 GtkWidget *statusbox; /**< The status selector dropdown */ |
11732 | 90 GtkWidget *statusboxbox; /**< A box to hold per account status boxes */ |
91 GList *statusboxes; /**< A list of the per account status boxes */ | |
7304 | 92 GdkPixbuf *east, *south; /**< Drop shadow stuff */ |
93 GdkWindow *east_shadow, *south_shadow; /**< Drop shadow stuff */ | |
94 | |
10008 | 95 }; |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
96 |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
97 #define GAIM_GTK_BLIST(list) ((GaimGtkBuddyList *)(list)->ui_data) |
5228 | 98 #define GAIM_IS_GTK_BLIST(list) \ |
7035
feb3d21a7794
[gaim-migrate @ 7598]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
99 ((list)->ui_ops == gaim_gtk_blist_get_ui_ops()) |
5228 | 100 |
101 /************************************************************************** | |
5422 | 102 * @name GTK+ Buddy List API |
5228 | 103 **************************************************************************/ |
5906 | 104 |
105 /** | |
8815 | 106 * Get the handle for the GTK+ blist system. |
107 * | |
108 * @return the handle to the blist system | |
109 */ | |
110 void *gaim_gtk_blist_get_handle(); | |
111 | |
112 /** | |
5906 | 113 * Initializes the GTK+ blist system. |
114 */ | |
115 void gaim_gtk_blist_init(void); | |
116 | |
5228 | 117 /** |
8815 | 118 * Uninitializes the GTK+ blist system. |
119 */ | |
120 void gaim_gtk_blist_uninit(void); | |
121 | |
122 /** | |
5228 | 123 * Returns the UI operations structure for the buddy list. |
124 * | |
10814
364a2ef907ae
[gaim-migrate @ 12468]
Luke Schierer <lschiere@pidgin.im>
parents:
10643
diff
changeset
|
125 * @return The GTK+ list operations structure. |
5228 | 126 */ |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
127 GaimBlistUiOps *gaim_gtk_blist_get_ui_ops(void); |
5228 | 128 |
129 /** | |
10643 | 130 * Returns the default gtk buddy list |
11732 | 131 * |
10643 | 132 * There's normally only one buddy list window, but that isn't a necessity. This function |
133 * returns the GaimGtkBuddyList we're most likely wanting to work with. This is slightly | |
134 * cleaner than an externed global. | |
11732 | 135 * |
10814
364a2ef907ae
[gaim-migrate @ 12468]
Luke Schierer <lschiere@pidgin.im>
parents:
10643
diff
changeset
|
136 * @return The default GTK+ buddy list |
10643 | 137 */ |
138 GaimGtkBuddyList *gaim_gtk_blist_get_default_gtk_blist(); | |
139 | |
140 /** | |
5228 | 141 * Returns the base image to represent the account, based on the currently selected theme |
142 * | |
143 * @param account The account. | |
6695 | 144 * |
5228 | 145 * @return The icon |
146 */ | |
10884 | 147 GdkPixbuf *gaim_gtk_create_prpl_icon(GaimAccount *account); |
5228 | 148 |
149 /** | |
9774 | 150 * Populates a menu with the items shown on the buddy list for a buddy. |
151 * | |
152 * @param menu The menu to populate | |
153 * @param buddy The buddy who's menu to get | |
10484 | 154 * @param sub TRUE if this is a sub-menu, FALSE otherwise |
9774 | 155 */ |
10484 | 156 void gaim_gtk_blist_make_buddy_menu(GtkWidget *menu, GaimBuddy *buddy, gboolean sub); |
9774 | 157 |
158 /** | |
5228 | 159 * Refreshes all the nodes of the buddy list. |
160 * This should only be called when something changes to affect most of the nodes (such as a ui preference changing) | |
161 * | |
162 * @param list This is the core list that gets updated from | |
163 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
164 void gaim_gtk_blist_refresh(GaimBuddyList *list); |
5228 | 165 |
166 /** | |
167 * Tells the buddy list to update its toolbar based on the preferences | |
168 * | |
169 */ | |
170 void gaim_gtk_blist_update_toolbar(); | |
171 | |
172 void gaim_gtk_blist_update_columns(); | |
5411 | 173 void gaim_gtk_blist_update_refresh_timeout(); |
5228 | 174 |
175 /** | |
176 * Useful for the buddy ticker | |
177 */ | |
5234 | 178 GdkPixbuf *gaim_gtk_blist_get_status_icon(GaimBlistNode *node, |
5228 | 179 GaimStatusIconSize size); |
180 | |
11018 | 181 /** |
182 * Returns a boolean indicating if @a node is part of an expanded contact. | |
183 * | |
184 * This only makes sense for contact and buddy nodes. @c FALSE is returned | |
185 * for other types of nodes. | |
186 * | |
187 * @param node The node in question. | |
188 * @return A boolean indicating if @a node is part of an expanded contact. | |
189 */ | |
190 gboolean gaim_gtk_blist_node_is_contact_expanded(GaimBlistNode *node); | |
191 | |
5422 | 192 /************************************************************************** |
193 * @name GTK+ Buddy List sorting functions | |
194 **************************************************************************/ | |
195 | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
196 typedef GtkTreeIter (*gaim_gtk_blist_sort_function)(GaimBlistNode *new, GaimBuddyList *blist, GtkTreeIter group, GtkTreeIter *cur); |
5422 | 197 |
11796 | 198 /** |
199 * Gets the current list of sort methods. | |
200 * | |
201 * @return A GSlist of sort methods | |
202 */ | |
203 GList *gaim_gtk_blist_get_sort_methods(); | |
5422 | 204 |
205 struct gaim_gtk_blist_sort_method { | |
5631 | 206 char *id; |
5422 | 207 char *name; |
208 gaim_gtk_blist_sort_function func; | |
209 }; | |
210 | |
11796 | 211 typedef struct gaim_gtk_blist_sort_method GaimGtkBlistSortMethod; |
212 | |
5422 | 213 /** |
214 * Registers a buddy list sorting method. | |
215 * | |
5631 | 216 * @param id The unique ID of the sorting method |
5422 | 217 * @param name The method's name. |
218 * @param func A pointer to the function. | |
219 * | |
220 */ | |
5631 | 221 void gaim_gtk_blist_sort_method_reg(const char *id, const char *name, gaim_gtk_blist_sort_function func); |
5422 | 222 |
223 /** | |
224 * Unregisters a buddy list sorting method. | |
225 * | |
5631 | 226 * @param id The method's id |
5422 | 227 */ |
5631 | 228 void gaim_gtk_blist_sort_method_unreg(const char *id); |
5422 | 229 |
230 /** | |
231 * Sets a buddy list sorting method. | |
232 * | |
5631 | 233 * @param id The method's id. |
5422 | 234 */ |
5631 | 235 void gaim_gtk_blist_sort_method_set(const char *id); |
5422 | 236 |
237 /** | |
238 * Sets up the programs default sort methods | |
239 */ | |
240 void gaim_gtk_blist_setup_sort_methods(); | |
241 | |
5936
1b56a833d665
[gaim-migrate @ 6376]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
242 /** |
1b56a833d665
[gaim-migrate @ 6376]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
243 * Updates the protocol actions menu on the GTK+ buddy list window. |
1b56a833d665
[gaim-migrate @ 6376]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
244 */ |
1b56a833d665
[gaim-migrate @ 6376]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
245 void gaim_gtk_blist_update_protocol_actions(); |
5422 | 246 |
8305
57bdd25752c1
[gaim-migrate @ 9029]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
247 /** |
8986 | 248 * Updates the plugin actions menu on the GTK+ buddy list window. |
249 */ | |
250 void gaim_gtk_blist_update_plugin_actions(); | |
251 | |
252 /** | |
11796 | 253 * Updates the Sorting menu on the GTK+ buddy list window. |
254 */ | |
255 void gaim_gtk_blist_update_sort_methods(); | |
256 | |
257 /** | |
8940 | 258 * Determines if showing the join chat dialog is a valid action. |
259 * | |
260 * @return Returns TRUE if there are accounts online capable of | |
261 * joining chat rooms. Otherwise returns FALSE. | |
8305
57bdd25752c1
[gaim-migrate @ 9029]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
262 */ |
8940 | 263 gboolean gaim_gtk_blist_joinchat_is_showable(void); |
264 | |
265 /** | |
266 * Shows the join chat dialog. | |
267 */ | |
268 void gaim_gtk_blist_joinchat_show(void); | |
5422 | 269 |
9051 | 270 /** |
271 * Appends the protocol specific menu items for a GaimBlistNode | |
272 */ | |
273 void gaim_gtk_append_blist_node_proto_menu (GtkWidget *menu, GaimConnection *gc, GaimBlistNode *node); | |
274 | |
275 /** | |
276 * Appends the extended menu items for a GaimBlistNode | |
277 */ | |
278 void gaim_gtk_append_blist_node_extended_menu(GtkWidget *menu, GaimBlistNode *node); | |
279 | |
9713 | 280 #endif /* _GAIM_GTKBLIST_H_ */ |