Mercurial > pidgin.yaz
annotate src/gtkconv.h @ 9033:4ef4d3220f81
[gaim-migrate @ 9809]
Kevin went and documented gtkimhtml.h for us. Now you have no excuse.
Read Kevin's documentation. Start fixing imhtml bugs.
committer: Tailor Script <tailor@pidgin.im>
author | Tim Ringenbach <marv@pidgin.im> |
---|---|
date | Sun, 23 May 2004 18:15:15 +0000 |
parents | b24967757d46 |
children | b6e3dcb23de0 |
rev | line source |
---|---|
4359 | 1 /** |
2 * @file gtkconv.h GTK+ Conversation API | |
5034
4691c5936c01
[gaim-migrate @ 5377]
Christian Hammond <chipx86@chipx86.com>
parents:
4736
diff
changeset
|
3 * @ingroup gtkui |
4359 | 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. | |
7326
00a9ab26d607
[gaim-migrate @ 7912]
Christian Hammond <chipx86@chipx86.com>
parents:
7295
diff
changeset
|
10 * |
4359 | 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_CONVERSATION_H_ | |
27 #define _GAIM_GTK_CONVERSATION_H_ | |
28 | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
29 #include "conversation.h" |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
30 |
4359 | 31 /************************************************************************** |
32 * @name Structures | |
33 **************************************************************************/ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
34 /*@{*/ |
4359 | 35 |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
36 typedef struct _GaimGtkWindow GaimGtkWindow; |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
37 typedef struct _GaimGtkImPane GaimGtkImPane; |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
38 typedef struct _GaimGtkChatPane GaimGtkChatPane; |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
39 typedef struct _GaimGtkConversation GaimGtkConversation; |
4359 | 40 |
41 /** | |
42 * A GTK+ representation of a graphical window containing one or more | |
43 * conversations. | |
44 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
45 struct _GaimGtkWindow |
4359 | 46 { |
47 GtkWidget *window; /**< The window. */ | |
48 GtkWidget *notebook; /**< The notebook of conversations. */ | |
49 | |
50 struct | |
51 { | |
52 GtkWidget *menubar; | |
53 | |
5167 | 54 GtkWidget *view_log; |
5908
ed8a9a3bf7e2
[gaim-migrate @ 6340]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
55 |
ed8a9a3bf7e2
[gaim-migrate @ 6340]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
56 GtkWidget *add_pounce; |
7887 | 57 GtkWidget *get_info; |
58 GtkWidget *warn; | |
59 GtkWidget *invite; | |
60 | |
5908
ed8a9a3bf7e2
[gaim-migrate @ 6340]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
61 GtkWidget *alias; |
7887 | 62 GtkWidget *block; |
63 GtkWidget *add; | |
64 GtkWidget *remove; | |
5908
ed8a9a3bf7e2
[gaim-migrate @ 6340]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
65 |
7859 | 66 GtkWidget *insert_link; |
67 GtkWidget *insert_image; | |
68 | |
4359 | 69 GtkWidget *logging; |
70 GtkWidget *sounds; | |
7326
00a9ab26d607
[gaim-migrate @ 7912]
Christian Hammond <chipx86@chipx86.com>
parents:
7295
diff
changeset
|
71 GtkWidget *show_formatting_toolbar; |
5908
ed8a9a3bf7e2
[gaim-migrate @ 6340]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
72 |
4359 | 73 GtkWidget *send_as; |
5908
ed8a9a3bf7e2
[gaim-migrate @ 6340]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
74 |
4736 | 75 GtkWidget *typing_icon; |
4359 | 76 |
4630 | 77 GtkItemFactory *item_factory; |
78 | |
4359 | 79 } menu; |
80 | |
81 /* Tab dragging stuff. */ | |
82 gboolean in_drag; | |
83 gboolean in_predrag; | |
84 | |
85 gint drag_min_x, drag_max_x, drag_min_y, drag_max_y; | |
86 | |
87 gint drag_motion_signal; | |
88 gint drag_leave_signal; | |
89 }; | |
90 | |
91 /** | |
7820 | 92 * A GTK+ Instant Message pane. |
4359 | 93 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
94 struct _GaimGtkImPane |
4359 | 95 { |
96 GtkWidget *warn; | |
97 GtkWidget *block; | |
98 GtkWidget *sep1; | |
99 GtkWidget *sep2; | |
100 GtkWidget *check; | |
101 GtkWidget *progress; | |
102 | |
103 gboolean a_virgin; | |
104 | |
105 /* Buddy icon stuff */ | |
106 GtkWidget *icon; | |
8189 | 107 gboolean animate; |
4359 | 108 GdkPixbufAnimation *anim; |
109 GdkPixbufAnimationIter *iter; | |
110 guint32 icon_timer; | |
111 GtkWidget *save_icon; | |
112 }; | |
113 | |
114 /** | |
115 * GTK+ Chat panes. | |
116 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
117 struct _GaimGtkChatPane |
4359 | 118 { |
119 GtkWidget *count; | |
120 GtkWidget *list; | |
121 GtkWidget *invite; | |
122 GtkWidget *topic_text; | |
7996
334ab1319406
[gaim-migrate @ 8673]
Christian Hammond <chipx86@chipx86.com>
parents:
7930
diff
changeset
|
123 GtkWidget *sep; |
4359 | 124 }; |
125 | |
126 /** | |
127 * A GTK+ conversation pane. | |
128 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
129 struct _GaimGtkConversation |
4359 | 130 { |
131 gboolean make_sound; | |
7326
00a9ab26d607
[gaim-migrate @ 7912]
Christian Hammond <chipx86@chipx86.com>
parents:
7295
diff
changeset
|
132 gboolean show_formatting_toolbar; |
4359 | 133 |
134 GtkTooltips *tooltips; | |
135 | |
136 GtkWidget *tab_cont; | |
137 GtkWidget *tabby; | |
6771
8eebba08b44b
[gaim-migrate @ 7308]
Christian Hammond <chipx86@chipx86.com>
parents:
6392
diff
changeset
|
138 GtkWidget *menu_tabby; |
4359 | 139 |
140 GtkWidget *imhtml; | |
141 GtkTextBuffer *entry_buffer; | |
142 GtkWidget *entry; | |
143 | |
7930 | 144 GtkWidget *add; |
145 GtkWidget *remove; | |
4359 | 146 GtkWidget *info; |
7930 | 147 GtkWidget *send; |
148 GtkWidget *close; /* "x" on the tab */ | |
6392
e9974608b319
[gaim-migrate @ 6897]
Christian Hammond <chipx86@chipx86.com>
parents:
5908
diff
changeset
|
149 GtkWidget *icon; |
4359 | 150 GtkWidget *tab_label; |
6771
8eebba08b44b
[gaim-migrate @ 7308]
Christian Hammond <chipx86@chipx86.com>
parents:
6392
diff
changeset
|
151 GtkWidget *menu_icon; |
8eebba08b44b
[gaim-migrate @ 7308]
Christian Hammond <chipx86@chipx86.com>
parents:
6392
diff
changeset
|
152 GtkWidget *menu_label; |
4359 | 153 GtkSizeGroup *sg; |
154 | |
155 GtkWidget *bbox; | |
156 GtkWidget *sw; | |
8821 | 157 GtkWidget *entrybox; |
4359 | 158 |
8317 | 159 GtkWidget *toolbar; |
4359 | 160 |
161 struct | |
162 { | |
5106 | 163 GtkWidget *image; |
4359 | 164 GtkWidget *log; |
7295 | 165 GtkWidget *search; |
4359 | 166 |
167 } dialogs; | |
168 | |
169 union | |
170 { | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
171 GaimGtkImPane *im; |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
172 GaimGtkChatPane *chat; |
4359 | 173 |
174 } u; | |
175 }; | |
176 | |
177 #define GAIM_GTK_WINDOW(win) \ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
178 ((GaimGtkWindow *)(win)->ui_data) |
4359 | 179 |
180 #define GAIM_GTK_CONVERSATION(conv) \ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
181 ((GaimGtkConversation *)(conv)->ui_data) |
4359 | 182 |
4384
8f633419c837
[gaim-migrate @ 4650]
Christian Hammond <chipx86@chipx86.com>
parents:
4359
diff
changeset
|
183 #define GAIM_IS_GTK_WINDOW(win) \ |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
184 (gaim_conv_window_get_ui_ops(win) == gaim_gtk_conversations_get_win_ui_ops()) |
4384
8f633419c837
[gaim-migrate @ 4650]
Christian Hammond <chipx86@chipx86.com>
parents:
4359
diff
changeset
|
185 |
8f633419c837
[gaim-migrate @ 4650]
Christian Hammond <chipx86@chipx86.com>
parents:
4359
diff
changeset
|
186 #define GAIM_IS_GTK_CONVERSATION(conv) \ |
7035
feb3d21a7794
[gaim-migrate @ 7598]
Christian Hammond <chipx86@chipx86.com>
parents:
6771
diff
changeset
|
187 (gaim_conversation_get_ui_ops(conv) == \ |
feb3d21a7794
[gaim-migrate @ 7598]
Christian Hammond <chipx86@chipx86.com>
parents:
6771
diff
changeset
|
188 gaim_gtk_conversations_get_conv_ui_ops()) |
4359 | 189 |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
190 /*@}*/ |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
191 |
4359 | 192 /************************************************************************** |
193 * @name GTK+ Conversation API | |
194 **************************************************************************/ | |
5673
62f57ec16f29
[gaim-migrate @ 6091]
Christian Hammond <chipx86@chipx86.com>
parents:
5167
diff
changeset
|
195 /*@{*/ |
62f57ec16f29
[gaim-migrate @ 6091]
Christian Hammond <chipx86@chipx86.com>
parents:
5167
diff
changeset
|
196 |
62f57ec16f29
[gaim-migrate @ 6091]
Christian Hammond <chipx86@chipx86.com>
parents:
5167
diff
changeset
|
197 /** |
4359 | 198 * Returns the UI operations structure for GTK windows. |
199 * | |
200 * @return The GTK window operations structure. | |
201 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
202 GaimConvWindowUiOps *gaim_gtk_conversations_get_win_ui_ops(void); |
4359 | 203 |
204 /** | |
205 * Returns the UI operations structure for GTK conversations. | |
206 * | |
207 * @return The GTK conversation operations structure. | |
208 */ | |
7035
feb3d21a7794
[gaim-migrate @ 7598]
Christian Hammond <chipx86@chipx86.com>
parents:
6771
diff
changeset
|
209 GaimConversationUiOps *gaim_gtk_conversations_get_conv_ui_ops(void); |
4359 | 210 |
211 /** | |
212 * Updates the buddy icon on a conversation. | |
213 * | |
214 * @param conv The conversation. | |
215 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
216 void gaim_gtkconv_update_buddy_icon(GaimConversation *conv); |
4359 | 217 |
218 /** | |
219 * Updates the tab positions on all conversation windows to reflect any | |
220 * changed preferences. | |
221 */ | |
222 void gaim_gtkconv_update_tabs(void); | |
223 | |
224 /** | |
225 * Updates the button style on chat windows to reflect any | |
226 * changed preferences. | |
227 */ | |
228 void gaim_gtkconv_update_chat_button_style(); | |
229 | |
230 /** | |
231 * Updates the button style on IM windows to reflect any | |
232 * changed preferences. | |
233 */ | |
234 void gaim_gtkconv_update_im_button_style(); | |
235 | |
236 /** | |
237 * Updates conversation buttons by protocol. | |
238 * | |
239 * @param conv The conversation. | |
240 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
241 void gaim_gtkconv_update_buttons_by_protocol(GaimConversation *conv); |
4359 | 242 |
243 /** | |
244 * Returns the window at the specified X, Y location. | |
245 * | |
246 * If the window is not a GTK+ window, @c NULL is returned. | |
247 * | |
248 * @param x The X coordinate. | |
249 * @param y The Y coordinate. | |
250 * | |
251 * @return The GTK+ window at the location, if it exists, or @c NULL otherwise. | |
252 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
253 GaimConvWindow *gaim_gtkwin_get_at_xy(int x, int y); |
4359 | 254 |
255 /** | |
256 * Returns the index of the tab at the specified X, Y location in a notebook. | |
257 * | |
258 * @param win The GTK+ window containing the notebook. | |
259 * @param x The X coordinate. | |
260 * @param y The Y coordinate. | |
261 * | |
262 * @return The index of the tab at the location. | |
263 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
264 int gaim_gtkconv_get_tab_at_xy(GaimConvWindow *win, int x, int y); |
4359 | 265 |
266 /** | |
267 * Returns the index of the destination tab at the | |
268 * specified X, Y location in a notebook. | |
269 * | |
270 * This is used for drag-and-drop functions when the tab at the index | |
271 * is a destination tab. | |
272 * | |
273 * @param win The GTK+ window containing the notebook. | |
274 * @param x The X coordinate. | |
275 * @param y The Y coordinate. | |
276 * | |
277 * @return The index of the tab at the location. | |
278 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
279 int gaim_gtkconv_get_dest_tab_at_xy(GaimConvWindow *win, int x, int y); |
4359 | 280 |
5673
62f57ec16f29
[gaim-migrate @ 6091]
Christian Hammond <chipx86@chipx86.com>
parents:
5167
diff
changeset
|
281 /*@}*/ |
62f57ec16f29
[gaim-migrate @ 6091]
Christian Hammond <chipx86@chipx86.com>
parents:
5167
diff
changeset
|
282 |
8582
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
283 /**************************************************************************/ |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
284 /** @name GTK+ Conversations Subsystem */ |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
285 /**************************************************************************/ |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
286 /*@{*/ |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
287 |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
288 /** |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
289 * Returns the gtk conversations subsystem handle. |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
290 * |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
291 * @return The conversations subsystem handle. |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
292 */ |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
293 void *gaim_gtk_conversations_get_handle(void); |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
294 |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
295 /** |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
296 * Initializes the GTK+ conversations subsystem. |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
297 */ |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
298 void gaim_gtk_conversations_init(void); |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
299 |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
300 /** |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
301 * Uninitialized the GTK+ conversation subsystem. |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
302 */ |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
303 void gaim_gtk_conversations_uninit(void); |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
304 |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
305 /*@}*/ |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
306 |
4359 | 307 #endif /* _GAIM_GTK_CONVERSATION_H_ */ |