Mercurial > pidgin.yaz
annotate src/gtkblist.h @ 8986:8cf32769ba1b
[gaim-migrate @ 9761]
" This patch adds a Plugin Actions menu item after the
Account Actions menu. The Plugin Actions menu is
populated from the added 'actions' slot in
GaimPluginInfo. As a demonstration, the Idle Maker
plugin has been converted to no longer require GTK code
and the Preferences interface just to perform its
actions. Instead, it uses a Plugin Action to spawn a
Fields Request.
There's also a minor fix for consistency in the menu
building for buddy actions. The pre-existing method for
instructing a menu list to display a separator was to
insert a NULL rather than a proto_buddy_menu into the
GList of actions. The code for the buddy menus was
instead checking for a proto_buddy_menu with a '-'
label. This has been fixed, and it now correctly uses
NULL to indicate a separator."
"Date: 2004-05-16 02:25
Sender: taliesein
Logged In: YES
user_id=77326
I need to add a callback to this patch to watch for
loading/unloading of plugins (to determine when to rebuild
the menu). Since the appropriate way to handle Plugin
Actions is still mildly up for debate, I'm holding of on
correcting the patch until I know for sure whether I should
fix this patch, or scrap it and write a new one using a
different method."
"Date: 2004-05-18 12:26
Sender: taliesein
Logged In: YES
user_id=77326
I've completed changes to this patch to also add plugin load
and unload signals (it looks like plugin.c actually had
pre-signal callbacks in place, but they were never used or
converted to signals)
This patch now will correctly update the Plugin Action menu
as plugins load and unload."
I'm not entirely sure i like the ui of a plugins actions menu, but i think
that having some way for plugins to add actions on an account is a good
thing, and i'm not sure that every viable action fits under the accounts
actions menu. we may want to merge the two (the existing accounts actions
and this plugins actions), but both times it came up in #gaim no one seemed
to want to comment, and on one commented to the gaim-devel post either.
committer: Tailor Script <tailor@pidgin.im>
author | Luke Schierer <lschiere@pidgin.im> |
---|---|
date | Thu, 20 May 2004 05:11:44 +0000 |
parents | b875f5d57b81 |
children | 826013efffcb |
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 */ | |
25 | |
26 #ifndef _GAIM_GTK_LIST_H_ | |
27 #define _GAIM_GTK_LIST_H_ | |
28 | |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5631
diff
changeset
|
29 #include "blist.h" |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5631
diff
changeset
|
30 |
5228 | 31 enum { |
32 STATUS_ICON_COLUMN, | |
33 STATUS_ICON_VISIBLE_COLUMN, | |
34 NAME_COLUMN, | |
35 WARNING_COLUMN, | |
36 IDLE_COLUMN, | |
37 BUDDY_ICON_COLUMN, | |
38 NODE_COLUMN, | |
39 BLIST_COLUMNS | |
40 }; | |
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 |
5228 | 48 /************************************************************************** |
49 * @name Structures | |
50 **************************************************************************/ | |
51 /** | |
52 * Like, everything you need to know about the gtk buddy list | |
53 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
54 typedef struct { |
5228 | 55 GtkWidget *window; |
56 GtkWidget *vbox; /**< This is the vbox that everything gets packed into. Your plugin might | |
57 want to pack something in it itself. Go, plugins! */ | |
58 | |
59 GtkWidget *treeview; /**< It's a treeview... d'uh. */ | |
60 GtkTreeStore *treemodel; /**< This is the treemodel. */ | |
6695 | 61 GtkTreeViewColumn *idle_column, |
62 *warning_column, | |
5228 | 63 *buddy_icon_column; |
64 | |
5427 | 65 GtkItemFactory *ift; |
5228 | 66 GtkWidget *bpmenu; /**< The buddy pounce menu. */ |
67 | |
68 GtkWidget *bbox; /**< A Button Box. */ | |
69 GtkTooltips *tooltips; /**< Tooltips for the buttons. */ | |
70 | |
71 guint refresh_timer; /**< The timer for refreshing every 30 seconds */ | |
72 | |
73 guint timeout; /**< The timeout for the tooltip. */ | |
7636 | 74 GdkRectangle tip_rect; /**< This is the bounding rectangle of the |
75 cell we're currently hovering over. This is | |
76 used for tooltips. */ | |
77 GdkRectangle contact_rect; /**< This is the bounding rectangle of the contact node | |
78 and its children. This is used for auto-expand on | |
79 mouseover. */ | |
80 GaimBlistNode *mouseover_contact; /**< This is the contact currently mouse-over expanded */ | |
81 | |
5228 | 82 GtkWidget *tipwindow; /**< The window used by the tooltip */ |
83 | |
84 GaimBlistNode *selected_node; /**< The currently selected node */ | |
85 | |
7304 | 86 GdkPixbuf *east, *south; /**< Drop shadow stuff */ |
87 GdkWindow *east_shadow, *south_shadow; /**< Drop shadow stuff */ | |
88 | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
89 } GaimGtkBuddyList; |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
90 |
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
91 #define GAIM_GTK_BLIST(list) ((GaimGtkBuddyList *)(list)->ui_data) |
5228 | 92 #define GAIM_IS_GTK_BLIST(list) \ |
7035
feb3d21a7794
[gaim-migrate @ 7598]
Christian Hammond <chipx86@chipx86.com>
parents:
6695
diff
changeset
|
93 ((list)->ui_ops == gaim_gtk_blist_get_ui_ops()) |
5228 | 94 |
95 /************************************************************************** | |
5422 | 96 * @name GTK+ Buddy List API |
5228 | 97 **************************************************************************/ |
5906 | 98 |
99 /** | |
8815 | 100 * Get the handle for the GTK+ blist system. |
101 * | |
102 * @return the handle to the blist system | |
103 */ | |
104 void *gaim_gtk_blist_get_handle(); | |
105 | |
106 /** | |
5906 | 107 * Initializes the GTK+ blist system. |
108 */ | |
109 void gaim_gtk_blist_init(void); | |
110 | |
5228 | 111 /** |
8815 | 112 * Uninitializes the GTK+ blist system. |
113 */ | |
114 void gaim_gtk_blist_uninit(void); | |
115 | |
116 /** | |
5228 | 117 * Returns the UI operations structure for the buddy list. |
118 * | |
119 * @return The GTK list operations structure. | |
120 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
121 GaimBlistUiOps *gaim_gtk_blist_get_ui_ops(void); |
5228 | 122 |
123 /** | |
124 * Returns the base image to represent the account, based on the currently selected theme | |
125 * | |
126 * @param account The account. | |
6695 | 127 * |
5228 | 128 * @return The icon |
129 */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5427
diff
changeset
|
130 GdkPixbuf *create_prpl_icon(GaimAccount *account); |
5228 | 131 |
132 /** | |
133 * Refreshes all the nodes of the buddy list. | |
134 * This should only be called when something changes to affect most of the nodes (such as a ui preference changing) | |
135 * | |
136 * @param list This is the core list that gets updated from | |
137 */ | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
138 void gaim_gtk_blist_refresh(GaimBuddyList *list); |
5228 | 139 |
140 /** | |
141 * Tells the buddy list to update its toolbar based on the preferences | |
142 * | |
143 */ | |
144 void gaim_gtk_blist_update_toolbar(); | |
145 | |
146 /** | |
147 * Useful for the docklet plugin and also for the win32 tray icon | |
6695 | 148 * This is called when one of those is clicked--it will show/hide the |
149 * buddy list/login window--depending on which is active | |
5228 | 150 */ |
151 void gaim_gtk_blist_docklet_toggle(); | |
152 void gaim_gtk_blist_docklet_add(); | |
153 void gaim_gtk_blist_docklet_remove(); | |
154 void gaim_gtk_blist_update_columns(); | |
5411 | 155 void gaim_gtk_blist_update_refresh_timeout(); |
5228 | 156 |
157 /** | |
158 * Useful for the buddy ticker | |
159 */ | |
5234 | 160 GdkPixbuf *gaim_gtk_blist_get_status_icon(GaimBlistNode *node, |
5228 | 161 GaimStatusIconSize size); |
162 | |
5422 | 163 /************************************************************************** |
164 * @name GTK+ Buddy List sorting functions | |
165 **************************************************************************/ | |
166 | |
7098
770233dad86c
[gaim-migrate @ 7663]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
167 typedef GtkTreeIter (*gaim_gtk_blist_sort_function)(GaimBlistNode *new, GaimBuddyList *blist, GtkTreeIter group, GtkTreeIter *cur); |
5422 | 168 |
169 extern GSList *gaim_gtk_blist_sort_methods; | |
170 | |
171 struct gaim_gtk_blist_sort_method { | |
5631 | 172 char *id; |
5422 | 173 char *name; |
174 gaim_gtk_blist_sort_function func; | |
175 }; | |
176 | |
177 /** | |
178 * Registers a buddy list sorting method. | |
179 * | |
5631 | 180 * @param id The unique ID of the sorting method |
5422 | 181 * @param name The method's name. |
182 * @param func A pointer to the function. | |
183 * | |
184 */ | |
5631 | 185 void gaim_gtk_blist_sort_method_reg(const char *id, const char *name, gaim_gtk_blist_sort_function func); |
5422 | 186 |
187 /** | |
188 * Unregisters a buddy list sorting method. | |
189 * | |
5631 | 190 * @param id The method's id |
5422 | 191 */ |
5631 | 192 void gaim_gtk_blist_sort_method_unreg(const char *id); |
5422 | 193 |
194 /** | |
195 * Sets a buddy list sorting method. | |
196 * | |
5631 | 197 * @param id The method's id. |
5422 | 198 */ |
5631 | 199 void gaim_gtk_blist_sort_method_set(const char *id); |
5422 | 200 |
201 /** | |
202 * Sets up the programs default sort methods | |
203 */ | |
204 void gaim_gtk_blist_setup_sort_methods(); | |
205 | |
5936
1b56a833d665
[gaim-migrate @ 6376]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
206 /** |
1b56a833d665
[gaim-migrate @ 6376]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
207 * Updates the protocol actions menu on the GTK+ buddy list window. |
1b56a833d665
[gaim-migrate @ 6376]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
208 */ |
1b56a833d665
[gaim-migrate @ 6376]
Christian Hammond <chipx86@chipx86.com>
parents:
5906
diff
changeset
|
209 void gaim_gtk_blist_update_protocol_actions(); |
5422 | 210 |
8305
57bdd25752c1
[gaim-migrate @ 9029]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
211 /** |
8986 | 212 * Updates the plugin actions menu on the GTK+ buddy list window. |
213 */ | |
214 void gaim_gtk_blist_update_plugin_actions(); | |
215 | |
216 /** | |
8940 | 217 * Determines if showing the join chat dialog is a valid action. |
218 * | |
219 * @return Returns TRUE if there are accounts online capable of | |
220 * joining chat rooms. Otherwise returns FALSE. | |
8305
57bdd25752c1
[gaim-migrate @ 9029]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
221 */ |
8940 | 222 gboolean gaim_gtk_blist_joinchat_is_showable(void); |
223 | |
224 /** | |
225 * Shows the join chat dialog. | |
226 */ | |
227 void gaim_gtk_blist_joinchat_show(void); | |
5422 | 228 |
5228 | 229 #endif /* _GAIM_GTK_LIST_H_ */ |