Mercurial > pidgin.yaz
annotate src/gtkconv.h @ 11963:d8787960e398
[gaim-migrate @ 14254]
Documentation
committer: Tailor Script <tailor@pidgin.im>
author | Mark Doliner <mark@kingant.net> |
---|---|
date | Fri, 04 Nov 2005 01:29:58 +0000 |
parents | fe12abd6b879 |
children | 1a86417abfc8 |
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 */ | |
9713 | 25 #ifndef _GAIM_GTKCONVERSATION_H_ |
26 #define _GAIM_GTKCONVERSATION_H_ | |
4359 | 27 |
10008 | 28 typedef struct _GaimGtkImPane GaimGtkImPane; |
29 typedef struct _GaimGtkChatPane GaimGtkChatPane; | |
30 typedef struct _GaimGtkConversation GaimGtkConversation; | |
9709 | 31 |
11664
38bbb0f15453
[gaim-migrate @ 13949]
Luke Schierer <lschiere@pidgin.im>
parents:
11614
diff
changeset
|
32 /** |
38bbb0f15453
[gaim-migrate @ 13949]
Luke Schierer <lschiere@pidgin.im>
parents:
11614
diff
changeset
|
33 * Unseen text states. |
38bbb0f15453
[gaim-migrate @ 13949]
Luke Schierer <lschiere@pidgin.im>
parents:
11614
diff
changeset
|
34 */ |
38bbb0f15453
[gaim-migrate @ 13949]
Luke Schierer <lschiere@pidgin.im>
parents:
11614
diff
changeset
|
35 typedef enum |
38bbb0f15453
[gaim-migrate @ 13949]
Luke Schierer <lschiere@pidgin.im>
parents:
11614
diff
changeset
|
36 { |
38bbb0f15453
[gaim-migrate @ 13949]
Luke Schierer <lschiere@pidgin.im>
parents:
11614
diff
changeset
|
37 GAIM_UNSEEN_NONE = 0, /**< No unseen text in the conversation. */ |
38bbb0f15453
[gaim-migrate @ 13949]
Luke Schierer <lschiere@pidgin.im>
parents:
11614
diff
changeset
|
38 GAIM_UNSEEN_TEXT, /**< Unseen text in the conversation. */ |
38bbb0f15453
[gaim-migrate @ 13949]
Luke Schierer <lschiere@pidgin.im>
parents:
11614
diff
changeset
|
39 GAIM_UNSEEN_NICK, /**< Unseen text and the nick was said. */ |
38bbb0f15453
[gaim-migrate @ 13949]
Luke Schierer <lschiere@pidgin.im>
parents:
11614
diff
changeset
|
40 GAIM_UNSEEN_EVENT /**< Unseen events in the conversation. */ |
38bbb0f15453
[gaim-migrate @ 13949]
Luke Schierer <lschiere@pidgin.im>
parents:
11614
diff
changeset
|
41 |
38bbb0f15453
[gaim-migrate @ 13949]
Luke Schierer <lschiere@pidgin.im>
parents:
11614
diff
changeset
|
42 } GaimUnseenState; |
38bbb0f15453
[gaim-migrate @ 13949]
Luke Schierer <lschiere@pidgin.im>
parents:
11614
diff
changeset
|
43 |
9498 | 44 enum { |
45 CHAT_USERS_ICON_COLUMN, | |
11454
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11280
diff
changeset
|
46 CHAT_USERS_ALIAS_COLUMN, |
9498 | 47 CHAT_USERS_NAME_COLUMN, |
9554 | 48 CHAT_USERS_FLAGS_COLUMN, |
11454
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11280
diff
changeset
|
49 CHAT_USERS_COLOR_COLUMN, |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11280
diff
changeset
|
50 CHAT_USERS_BUDDY_COLUMN, |
9498 | 51 CHAT_USERS_COLUMNS |
52 }; | |
53 | |
10008 | 54 #define GAIM_GTK_CONVERSATION(conv) \ |
55 ((GaimGtkConversation *)(conv)->ui_data) | |
56 | |
57 #define GAIM_IS_GTK_CONVERSATION(conv) \ | |
58 (gaim_conversation_get_ui_ops(conv) == \ | |
59 gaim_gtk_conversations_get_conv_ui_ops()) | |
60 | |
61 #include "gtkgaim.h" | |
62 #include "conversation.h" | |
11581 | 63 #include "gtkconvwin.h" |
10008 | 64 |
4359 | 65 /************************************************************************** |
66 * @name Structures | |
67 **************************************************************************/ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
68 /*@{*/ |
4359 | 69 |
70 /** | |
71 * A GTK+ representation of a graphical window containing one or more | |
72 * conversations. | |
73 */ | |
74 | |
75 /** | |
7820 | 76 * A GTK+ Instant Message pane. |
4359 | 77 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
78 struct _GaimGtkImPane |
4359 | 79 { |
80 GtkWidget *block; | |
9468 | 81 GtkWidget *send_file; |
4359 | 82 GtkWidget *sep1; |
83 GtkWidget *sep2; | |
84 GtkWidget *check; | |
85 GtkWidget *progress; | |
86 | |
87 /* Buddy icon stuff */ | |
9885 | 88 GtkWidget *icon_container; |
4359 | 89 GtkWidget *icon; |
9687 | 90 gboolean show_icon; |
8189 | 91 gboolean animate; |
4359 | 92 GdkPixbufAnimation *anim; |
93 GdkPixbufAnimationIter *iter; | |
94 guint32 icon_timer; | |
95 }; | |
96 | |
97 /** | |
98 * GTK+ Chat panes. | |
99 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
100 struct _GaimGtkChatPane |
4359 | 101 { |
102 GtkWidget *count; | |
103 GtkWidget *list; | |
104 GtkWidget *topic_text; | |
10500 | 105 GtkWidget *userlist_im; |
106 GtkWidget *userlist_ignore; | |
107 GtkWidget *userlist_info; | |
4359 | 108 }; |
109 | |
110 /** | |
111 * A GTK+ conversation pane. | |
112 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
113 struct _GaimGtkConversation |
4359 | 114 { |
10810 | 115 GaimConversation *active_conv; |
116 GList *convs; | |
11581 | 117 |
118 GaimGtkWindow *win; | |
119 | |
4359 | 120 gboolean make_sound; |
7326
00a9ab26d607
[gaim-migrate @ 7912]
Christian Hammond <chipx86@chipx86.com>
parents:
7295
diff
changeset
|
121 gboolean show_formatting_toolbar; |
9188 | 122 gboolean show_timestamps; |
4359 | 123 |
124 GtkTooltips *tooltips; | |
125 | |
126 GtkWidget *tab_cont; | |
127 GtkWidget *tabby; | |
6771
8eebba08b44b
[gaim-migrate @ 7308]
Christian Hammond <chipx86@chipx86.com>
parents:
6392
diff
changeset
|
128 GtkWidget *menu_tabby; |
4359 | 129 |
130 GtkWidget *imhtml; | |
131 GtkTextBuffer *entry_buffer; | |
132 GtkWidget *entry; | |
133 | |
7930 | 134 GtkWidget *close; /* "x" on the tab */ |
6392
e9974608b319
[gaim-migrate @ 6897]
Christian Hammond <chipx86@chipx86.com>
parents:
5908
diff
changeset
|
135 GtkWidget *icon; |
4359 | 136 GtkWidget *tab_label; |
6771
8eebba08b44b
[gaim-migrate @ 7308]
Christian Hammond <chipx86@chipx86.com>
parents:
6392
diff
changeset
|
137 GtkWidget *menu_icon; |
8eebba08b44b
[gaim-migrate @ 7308]
Christian Hammond <chipx86@chipx86.com>
parents:
6392
diff
changeset
|
138 GtkWidget *menu_label; |
4359 | 139 GtkSizeGroup *sg; |
140 | |
9332 | 141 GtkWidget *lower_hbox; |
4359 | 142 |
8317 | 143 GtkWidget *toolbar; |
4359 | 144 |
11664
38bbb0f15453
[gaim-migrate @ 13949]
Luke Schierer <lschiere@pidgin.im>
parents:
11614
diff
changeset
|
145 GaimUnseenState unseen_state; |
38bbb0f15453
[gaim-migrate @ 13949]
Luke Schierer <lschiere@pidgin.im>
parents:
11614
diff
changeset
|
146 |
4359 | 147 struct |
148 { | |
5106 | 149 GtkWidget *image; |
7295 | 150 GtkWidget *search; |
4359 | 151 |
152 } dialogs; | |
153 | |
154 union | |
155 { | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
156 GaimGtkImPane *im; |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
157 GaimGtkChatPane *chat; |
4359 | 158 |
159 } u; | |
160 }; | |
161 | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
162 /*@}*/ |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
163 |
4359 | 164 /************************************************************************** |
165 * @name GTK+ Conversation API | |
166 **************************************************************************/ | |
5673
62f57ec16f29
[gaim-migrate @ 6091]
Christian Hammond <chipx86@chipx86.com>
parents:
5167
diff
changeset
|
167 /*@{*/ |
62f57ec16f29
[gaim-migrate @ 6091]
Christian Hammond <chipx86@chipx86.com>
parents:
5167
diff
changeset
|
168 |
62f57ec16f29
[gaim-migrate @ 6091]
Christian Hammond <chipx86@chipx86.com>
parents:
5167
diff
changeset
|
169 /** |
10814
364a2ef907ae
[gaim-migrate @ 12468]
Luke Schierer <lschiere@pidgin.im>
parents:
10810
diff
changeset
|
170 * Returns the UI operations structure for GTK+ conversations. |
4359 | 171 * |
10814
364a2ef907ae
[gaim-migrate @ 12468]
Luke Schierer <lschiere@pidgin.im>
parents:
10810
diff
changeset
|
172 * @return The GTK+ conversation operations structure. |
4359 | 173 */ |
7035
feb3d21a7794
[gaim-migrate @ 7598]
Christian Hammond <chipx86@chipx86.com>
parents:
6771
diff
changeset
|
174 GaimConversationUiOps *gaim_gtk_conversations_get_conv_ui_ops(void); |
4359 | 175 |
176 /** | |
177 * Updates the buddy icon on a conversation. | |
178 * | |
179 * @param conv The conversation. | |
180 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
181 void gaim_gtkconv_update_buddy_icon(GaimConversation *conv); |
4359 | 182 |
183 /** | |
11911
fe12abd6b879
[gaim-migrate @ 14202]
Richard Laager <rlaager@wiktel.com>
parents:
11690
diff
changeset
|
184 * Sets the active conversation within a GTK-conversation. |
fe12abd6b879
[gaim-migrate @ 14202]
Richard Laager <rlaager@wiktel.com>
parents:
11690
diff
changeset
|
185 * |
fe12abd6b879
[gaim-migrate @ 14202]
Richard Laager <rlaager@wiktel.com>
parents:
11690
diff
changeset
|
186 * @param conv The conversation |
fe12abd6b879
[gaim-migrate @ 14202]
Richard Laager <rlaager@wiktel.com>
parents:
11690
diff
changeset
|
187 */ |
fe12abd6b879
[gaim-migrate @ 14202]
Richard Laager <rlaager@wiktel.com>
parents:
11690
diff
changeset
|
188 void gaim_gtkconv_switch_active_conversation(GaimConversation *conv); |
fe12abd6b879
[gaim-migrate @ 14202]
Richard Laager <rlaager@wiktel.com>
parents:
11690
diff
changeset
|
189 |
fe12abd6b879
[gaim-migrate @ 14202]
Richard Laager <rlaager@wiktel.com>
parents:
11690
diff
changeset
|
190 /** |
4359 | 191 * Updates the tab positions on all conversation windows to reflect any |
192 * changed preferences. | |
193 */ | |
194 void gaim_gtkconv_update_tabs(void); | |
195 | |
196 /** | |
197 * Updates conversation buttons by protocol. | |
198 * | |
199 * @param conv The conversation. | |
200 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5674
diff
changeset
|
201 void gaim_gtkconv_update_buttons_by_protocol(GaimConversation *conv); |
4359 | 202 |
11581 | 203 GaimGtkWindow *gaim_gtkconv_get_window(GaimGtkConversation *gtkconv); |
204 GdkPixbuf *gaim_gtkconv_get_tab_icon(GaimConversation *conv, gboolean small_icon); | |
205 void gaim_gtkconv_new(GaimConversation *conv); | |
11614 | 206 int gaim_gtkconv_get_tab_at_xy(GaimGtkWindow *win, int x, int y, gboolean *to_right); |
5673
62f57ec16f29
[gaim-migrate @ 6091]
Christian Hammond <chipx86@chipx86.com>
parents:
5167
diff
changeset
|
207 /*@}*/ |
62f57ec16f29
[gaim-migrate @ 6091]
Christian Hammond <chipx86@chipx86.com>
parents:
5167
diff
changeset
|
208 |
8582
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
209 /**************************************************************************/ |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
210 /** @name GTK+ Conversations Subsystem */ |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
211 /**************************************************************************/ |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
212 /*@{*/ |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
213 |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
214 /** |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
215 * Returns the gtk conversations subsystem handle. |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
216 * |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
217 * @return The conversations subsystem handle. |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
218 */ |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
219 void *gaim_gtk_conversations_get_handle(void); |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
220 |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
221 /** |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
222 * Initializes the GTK+ conversations subsystem. |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
223 */ |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
224 void gaim_gtk_conversations_init(void); |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
225 |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
226 /** |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
227 * Uninitialized the GTK+ conversation subsystem. |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
228 */ |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
229 void gaim_gtk_conversations_uninit(void); |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
230 |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
231 /*@}*/ |
d7c85220c685
[gaim-migrate @ 9332]
Christian Hammond <chipx86@chipx86.com>
parents:
8317
diff
changeset
|
232 |
9713 | 233 #endif /* _GAIM_GTKCONVERSATION_H_ */ |