Mercurial > pidgin.yaz
annotate src/gtkblist.h @ 10513:ab7dd4d50936
[gaim-migrate @ 11812]
make dist might be a bit happier with this
committer: Tailor Script <tailor@pidgin.im>
author | Stu Tomlinson <stu@nosnilmot.com> |
---|---|
date | Thu, 13 Jan 2005 19:33:10 +0000 |
parents | ec82cbb21fe8 |
children | 868aafbe859b |
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 WARNING_COLUMN, | |
35 IDLE_COLUMN, | |
36 BUDDY_ICON_COLUMN, | |
37 NODE_COLUMN, | |
38 BLIST_COLUMNS | |
10008 | 39 |
40 }; | |
5228 | 41 |
42 typedef enum { | |
43 GAIM_STATUS_ICON_LARGE, | |
44 GAIM_STATUS_ICON_SMALL | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
45 |
5228 | 46 } GaimStatusIconSize; |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
47 |
10008 | 48 #include "gtkgaim.h" |
49 #include "blist.h" | |
50 | |
5228 | 51 /************************************************************************** |
52 * @name Structures | |
53 **************************************************************************/ | |
54 /** | |
55 * Like, everything you need to know about the gtk buddy list | |
56 */ | |
10008 | 57 struct _GaimGtkBuddyList { |
5228 | 58 GtkWidget *window; |
59 GtkWidget *vbox; /**< This is the vbox that everything gets packed into. Your plugin might | |
60 want to pack something in it itself. Go, plugins! */ | |
61 | |
62 GtkWidget *treeview; /**< It's a treeview... d'uh. */ | |
63 GtkTreeStore *treemodel; /**< This is the treemodel. */ | |
6695 | 64 GtkTreeViewColumn *idle_column, |
65 *warning_column, | |
5228 | 66 *buddy_icon_column; |
67 | |
5427 | 68 GtkItemFactory *ift; |
5228 | 69 GtkWidget *bpmenu; /**< The buddy pounce menu. */ |
70 | |
71 guint refresh_timer; /**< The timer for refreshing every 30 seconds */ | |
72 | |
73 guint timeout; /**< The timeout for the tooltip. */ | |
10354 | 74 guint drag_timeout; /**< The timeout for expanding contacts on drags */ |
7636 | 75 GdkRectangle tip_rect; /**< This is the bounding rectangle of the |
76 cell we're currently hovering over. This is | |
77 used for tooltips. */ | |
78 GdkRectangle contact_rect; /**< This is the bounding rectangle of the contact node | |
79 and its children. This is used for auto-expand on | |
80 mouseover. */ | |
81 GaimBlistNode *mouseover_contact; /**< This is the contact currently mouse-over expanded */ | |
82 | |
5228 | 83 GtkWidget *tipwindow; /**< The window used by the tooltip */ |
84 | |
85 GaimBlistNode *selected_node; /**< The currently selected node */ | |
86 | |
7304 | 87 GdkPixbuf *east, *south; /**< Drop shadow stuff */ |
88 GdkWindow *east_shadow, *south_shadow; /**< Drop shadow stuff */ | |
89 | |
10008 | 90 }; |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
91 |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
92 #define GAIM_GTK_BLIST(list) ((GaimGtkBuddyList *)(list)->ui_data) |
5228 | 93 #define GAIM_IS_GTK_BLIST(list) \ |
7035
feb3d21a7794
[gaim-migrate @ 7598]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
94 ((list)->ui_ops == gaim_gtk_blist_get_ui_ops()) |
5228 | 95 |
96 /************************************************************************** | |
5422 | 97 * @name GTK+ Buddy List API |
5228 | 98 **************************************************************************/ |
5906 | 99 |
100 /** | |
8815 | 101 * Get the handle for the GTK+ blist system. |
102 * | |
103 * @return the handle to the blist system | |
104 */ | |
105 void *gaim_gtk_blist_get_handle(); | |
106 | |
107 /** | |
5906 | 108 * Initializes the GTK+ blist system. |
109 */ | |
110 void gaim_gtk_blist_init(void); | |
111 | |
5228 | 112 /** |
8815 | 113 * Uninitializes the GTK+ blist system. |
114 */ | |
115 void gaim_gtk_blist_uninit(void); | |
116 | |
117 /** | |
5228 | 118 * Returns the UI operations structure for the buddy list. |
119 * | |
120 * @return The GTK list operations structure. | |
121 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
122 GaimBlistUiOps *gaim_gtk_blist_get_ui_ops(void); |
5228 | 123 |
124 /** | |
125 * Returns the base image to represent the account, based on the currently selected theme | |
126 * | |
127 * @param account The account. | |
6695 | 128 * |
5228 | 129 * @return The icon |
130 */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5427
diff
changeset
|
131 GdkPixbuf *create_prpl_icon(GaimAccount *account); |
5228 | 132 |
133 /** | |
9774 | 134 * Populates a menu with the items shown on the buddy list for a buddy. |
135 * | |
136 * @param menu The menu to populate | |
137 * @param buddy The buddy who's menu to get | |
10484 | 138 * @param sub TRUE if this is a sub-menu, FALSE otherwise |
9774 | 139 */ |
10484 | 140 void gaim_gtk_blist_make_buddy_menu(GtkWidget *menu, GaimBuddy *buddy, gboolean sub); |
9774 | 141 |
142 /** | |
5228 | 143 * Refreshes all the nodes of the buddy list. |
144 * This should only be called when something changes to affect most of the nodes (such as a ui preference changing) | |
145 * | |
146 * @param list This is the core list that gets updated from | |
147 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
148 void gaim_gtk_blist_refresh(GaimBuddyList *list); |
5228 | 149 |
150 /** | |
151 * Tells the buddy list to update its toolbar based on the preferences | |
152 * | |
153 */ | |
154 void gaim_gtk_blist_update_toolbar(); | |
155 | |
156 /** | |
157 * Useful for the docklet plugin and also for the win32 tray icon | |
6695 | 158 * This is called when one of those is clicked--it will show/hide the |
159 * buddy list/login window--depending on which is active | |
5228 | 160 */ |
161 void gaim_gtk_blist_docklet_toggle(); | |
162 void gaim_gtk_blist_docklet_add(); | |
163 void gaim_gtk_blist_docklet_remove(); | |
164 void gaim_gtk_blist_update_columns(); | |
5411 | 165 void gaim_gtk_blist_update_refresh_timeout(); |
5228 | 166 |
167 /** | |
168 * Useful for the buddy ticker | |
169 */ | |
5234 | 170 GdkPixbuf *gaim_gtk_blist_get_status_icon(GaimBlistNode *node, |
5228 | 171 GaimStatusIconSize size); |
172 | |
5422 | 173 /************************************************************************** |
174 * @name GTK+ Buddy List sorting functions | |
175 **************************************************************************/ | |
176 | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
177 typedef GtkTreeIter (*gaim_gtk_blist_sort_function)(GaimBlistNode *new, GaimBuddyList *blist, GtkTreeIter group, GtkTreeIter *cur); |
5422 | 178 |
179 extern GSList *gaim_gtk_blist_sort_methods; | |
180 | |
181 struct gaim_gtk_blist_sort_method { | |
5631 | 182 char *id; |
5422 | 183 char *name; |
184 gaim_gtk_blist_sort_function func; | |
185 }; | |
186 | |
187 /** | |
188 * Registers a buddy list sorting method. | |
189 * | |
5631 | 190 * @param id The unique ID of the sorting method |
5422 | 191 * @param name The method's name. |
192 * @param func A pointer to the function. | |
193 * | |
194 */ | |
5631 | 195 void gaim_gtk_blist_sort_method_reg(const char *id, const char *name, gaim_gtk_blist_sort_function func); |
5422 | 196 |
197 /** | |
198 * Unregisters a buddy list sorting method. | |
199 * | |
5631 | 200 * @param id The method's id |
5422 | 201 */ |
5631 | 202 void gaim_gtk_blist_sort_method_unreg(const char *id); |
5422 | 203 |
204 /** | |
205 * Sets a buddy list sorting method. | |
206 * | |
5631 | 207 * @param id The method's id. |
5422 | 208 */ |
5631 | 209 void gaim_gtk_blist_sort_method_set(const char *id); |
5422 | 210 |
211 /** | |
212 * Sets up the programs default sort methods | |
213 */ | |
214 void gaim_gtk_blist_setup_sort_methods(); | |
215 | |
5936
1b56a833d665
[gaim-migrate @ 6376]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
216 /** |
1b56a833d665
[gaim-migrate @ 6376]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
217 * Updates the protocol actions menu on the GTK+ buddy list window. |
1b56a833d665
[gaim-migrate @ 6376]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
218 */ |
1b56a833d665
[gaim-migrate @ 6376]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
219 void gaim_gtk_blist_update_protocol_actions(); |
5422 | 220 |
8305
57bdd25752c1
[gaim-migrate @ 9029]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
221 /** |
8986 | 222 * Updates the plugin actions menu on the GTK+ buddy list window. |
223 */ | |
224 void gaim_gtk_blist_update_plugin_actions(); | |
225 | |
226 /** | |
8940 | 227 * Determines if showing the join chat dialog is a valid action. |
228 * | |
229 * @return Returns TRUE if there are accounts online capable of | |
230 * joining chat rooms. Otherwise returns FALSE. | |
8305
57bdd25752c1
[gaim-migrate @ 9029]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
231 */ |
8940 | 232 gboolean gaim_gtk_blist_joinchat_is_showable(void); |
233 | |
234 /** | |
235 * Shows the join chat dialog. | |
236 */ | |
237 void gaim_gtk_blist_joinchat_show(void); | |
5422 | 238 |
9051 | 239 /** |
240 * Appends the protocol specific menu items for a GaimBlistNode | |
241 */ | |
242 void gaim_gtk_append_blist_node_proto_menu (GtkWidget *menu, GaimConnection *gc, GaimBlistNode *node); | |
243 | |
244 /** | |
245 * Appends the extended menu items for a GaimBlistNode | |
246 */ | |
247 void gaim_gtk_append_blist_node_extended_menu(GtkWidget *menu, GaimBlistNode *node); | |
248 | |
9713 | 249 #endif /* _GAIM_GTKBLIST_H_ */ |