Mercurial > pidgin
annotate src/conversation.h @ 6615:a3602428ff53
[gaim-migrate @ 7139]
Grr.
committer: Tailor Script <tailor@pidgin.im>
author | Christian Hammond <chipx86@chipx86.com> |
---|---|
date | Sun, 24 Aug 2003 20:36:41 +0000 |
parents | 943b03bcecf5 |
children | 42fdf16f1dad |
rev | line source |
---|---|
4359 | 1 /** |
2 * @file conversation.h Conversation API | |
5034
4691c5936c01
[gaim-migrate @ 5377]
Christian Hammond <chipx86@chipx86.com>
parents:
4890
diff
changeset
|
3 * @ingroup core |
4359 | 4 * |
5 * gaim | |
6 * | |
7 * Copyright (C) 2002-2003, Christian Hammond <chipx86@gnupdate.org> | |
6485
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
8 * |
4359 | 9 * This program is free software; you can redistribute it and/or modify |
10 * it under the terms of the GNU General Public License as published by | |
11 * the Free Software Foundation; either version 2 of the License, or | |
12 * (at your option) any later version. | |
13 * | |
14 * This program is distributed in the hope that it will be useful, | |
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 * GNU General Public License for more details. | |
18 * | |
19 * You should have received a copy of the GNU General Public License | |
20 * along with this program; if not, write to the Free Software | |
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
6488
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
22 * |
6605
943b03bcecf5
[gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
6585
diff
changeset
|
23 * @see @ref conversation-signals |
4359 | 24 */ |
4890
89cb14edf8cf
[gaim-migrate @ 5220]
Christian Hammond <chipx86@chipx86.com>
parents:
4877
diff
changeset
|
25 #ifndef _GAIM_CONVERSATION_H_ |
89cb14edf8cf
[gaim-migrate @ 5220]
Christian Hammond <chipx86@chipx86.com>
parents:
4877
diff
changeset
|
26 #define _GAIM_CONVERSATION_H_ |
4359 | 27 |
28 /**************************************************************************/ | |
29 /** Data Structures */ | |
30 /**************************************************************************/ | |
31 | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
32 typedef struct _GaimWindowUiOps GaimWindowUiOps; |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
33 typedef struct _GaimWindow GaimWindow; |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
34 typedef struct _GaimConversationUiOps GaimConversationUiOps; |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
35 typedef struct _GaimConversation GaimConversation; |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
36 typedef struct _GaimIm GaimIm; |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
37 typedef struct _GaimChat GaimChat; |
4359 | 38 |
39 /** | |
40 * A type of conversation. | |
41 */ | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
42 typedef enum |
4359 | 43 { |
44 GAIM_CONV_UNKNOWN = 0, /**< Unknown conversation type. */ | |
45 GAIM_CONV_IM, /**< Instant Message. */ | |
4378
194507c83612
[gaim-migrate @ 4644]
Christian Hammond <chipx86@chipx86.com>
parents:
4359
diff
changeset
|
46 GAIM_CONV_CHAT, /**< Chat room. */ |
194507c83612
[gaim-migrate @ 4644]
Christian Hammond <chipx86@chipx86.com>
parents:
4359
diff
changeset
|
47 GAIM_CONV_MISC /**< A misc. conversation. */ |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
48 |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
49 } GaimConversationType; |
4359 | 50 |
51 /** | |
52 * Unseen text states. | |
53 */ | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
54 typedef enum |
4359 | 55 { |
56 GAIM_UNSEEN_NONE = 0, /**< No unseen text in the conversation. */ | |
57 GAIM_UNSEEN_TEXT, /**< Unseen text in the conversation. */ | |
6405
96de6d9eb422
[gaim-migrate @ 6910]
Christian Hammond <chipx86@chipx86.com>
parents:
6311
diff
changeset
|
58 GAIM_UNSEEN_NICK, /**< Unseen text and the nick was said. */ |
96de6d9eb422
[gaim-migrate @ 6910]
Christian Hammond <chipx86@chipx86.com>
parents:
6311
diff
changeset
|
59 GAIM_UNSEEN_EVENT /**< Unseen events in the conversation. */ |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
60 |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
61 } GaimUnseenState; |
4359 | 62 |
63 /** | |
64 * Conversation update type. | |
65 */ | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
66 typedef enum |
4359 | 67 { |
68 GAIM_CONV_UPDATE_ADD = 0, /**< The buddy associated with the conversation | |
69 was added. */ | |
70 GAIM_CONV_UPDATE_REMOVE, /**< The buddy associated with the conversation | |
71 was removed. */ | |
4491 | 72 GAIM_CONV_UPDATE_ACCOUNT, /**< The gaim_account was changed. */ |
4359 | 73 GAIM_CONV_UPDATE_TYPING, /**< The typing state was updated. */ |
74 GAIM_CONV_UPDATE_UNSEEN, /**< The unseen state was updated. */ | |
75 GAIM_CONV_UPDATE_LOGGING, /**< Logging for this conversation was | |
76 enabled or disabled. */ | |
77 GAIM_CONV_UPDATE_TOPIC, /**< The topic for a chat was updated. */ | |
78 | |
79 /* | |
80 * XXX These need to go when we implement a more generic core/UI event | |
81 * system. | |
82 */ | |
4378
194507c83612
[gaim-migrate @ 4644]
Christian Hammond <chipx86@chipx86.com>
parents:
4359
diff
changeset
|
83 GAIM_CONV_ACCOUNT_ONLINE, /**< One of the user's accounts went online. */ |
194507c83612
[gaim-migrate @ 4644]
Christian Hammond <chipx86@chipx86.com>
parents:
4359
diff
changeset
|
84 GAIM_CONV_ACCOUNT_OFFLINE, /**< One of the user's accounts went offline. */ |
194507c83612
[gaim-migrate @ 4644]
Christian Hammond <chipx86@chipx86.com>
parents:
4359
diff
changeset
|
85 GAIM_CONV_UPDATE_AWAY /**< The other user went away. */ |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
86 |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
87 } GaimConvUpdateType; |
4359 | 88 |
89 /** | |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
90 * The typing state of a user. |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
91 */ |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
92 typedef enum |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
93 { |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
94 GAIM_NOT_TYPING = 0, /**< Not typing. */ |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
95 GAIM_TYPING, /**< Currently typing. */ |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
96 GAIM_TYPED /**< Stopped typing momentarily. */ |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
97 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
98 } GaimTypingState; |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
99 |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
100 #include "account.h" |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
101 #include "server.h" |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
102 |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
103 /** |
4359 | 104 * Conversation window operations. |
105 * | |
106 * Any UI representing a window must assign a filled-out gaim_window_ops | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
107 * structure to the GaimWindow. |
4359 | 108 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
109 struct _GaimWindowUiOps |
4359 | 110 { |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
111 GaimConversationUiOps *(*get_conversation_ui_ops)(void); |
4359 | 112 |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
113 void (*new_window)(GaimWindow *win); |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
114 void (*destroy_window)(GaimWindow *win); |
4359 | 115 |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
116 void (*show)(GaimWindow *win); |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
117 void (*hide)(GaimWindow *win); |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
118 void (*raise)(GaimWindow *win); |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
119 void (*flash)(GaimWindow *win); |
4359 | 120 |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
121 void (*switch_conversation)(GaimWindow *win, unsigned int index); |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
122 void (*add_conversation)(GaimWindow *win, GaimConversation *conv); |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
123 void (*remove_conversation)(GaimWindow *win, GaimConversation *conv); |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
124 void (*move_conversation)(GaimWindow *win, GaimConversation *conv, |
4359 | 125 unsigned int newIndex); |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
126 int (*get_active_index)(const GaimWindow *win); |
4359 | 127 }; |
128 | |
129 /** | |
130 * Conversation operations and events. | |
131 * | |
132 * Any UI representing a conversation must assign a filled-out | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
133 * GaimConversationUiOps structure to the GaimConversation. |
4359 | 134 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
135 struct _GaimConversationUiOps |
4359 | 136 { |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
137 void (*destroy_conversation)(GaimConversation *conv); |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
138 void (*write_chat)(GaimConversation *conv, const char *who, |
4359 | 139 const char *message, int flags, time_t mtime); |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
140 void (*write_im)(GaimConversation *conv, const char *who, |
4359 | 141 const char *message, size_t len, int flags, time_t mtime); |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
142 void (*write_conv)(GaimConversation *conv, const char *who, |
4359 | 143 const char *message, size_t length, int flags, |
144 time_t mtime); | |
145 | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
146 void (*chat_add_user)(GaimConversation *conv, const char *user); |
6407
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
147 void (*chat_add_users)(GaimConversation *conv, GList *users); |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
148 void (*chat_rename_user)(GaimConversation *conv, |
4359 | 149 const char *old_name, const char *new_name); |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
150 void (*chat_remove_user)(GaimConversation *conv, const char *user); |
6407
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
151 void (*chat_remove_users)(GaimConversation *conv, GList *users); |
4359 | 152 |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
153 void (*set_title)(GaimConversation *conv, const char *title); |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
154 void (*update_progress)(GaimConversation *conv, float percent); |
4359 | 155 |
156 /* Events */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
157 void (*updated)(GaimConversation *conv, GaimConvUpdateType type); |
4359 | 158 }; |
159 | |
160 /** | |
161 * A core representation of a graphical window containing one or more | |
162 * conversations. | |
163 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
164 struct _GaimWindow |
4359 | 165 { |
4465
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
166 GList *conversations; /**< The conversations in the window. */ |
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
167 size_t conversation_count; /**< The number of conversations. */ |
4359 | 168 |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
169 GaimWindowUiOps *ui_ops; /**< UI-specific window operations. */ |
4465
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
170 void *ui_data; /**< UI-specific data. */ |
4359 | 171 }; |
172 | |
173 /** | |
174 * Data specific to Instant Messages. | |
175 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
176 struct _GaimIm |
4359 | 177 { |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
178 GaimConversation *conv; /**< The parent conversation. */ |
4359 | 179 |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
180 GaimTypingState typing_state; /**< The current typing state. */ |
4465
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
181 guint typing_timeout; /**< The typing timer handle. */ |
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
182 time_t type_again; /**< The type again time. */ |
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
183 guint type_again_timeout; /**< The type again timer handle. */ |
4359 | 184 |
4465
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
185 GSList *images; /**< A list of images in the IM. */ |
4359 | 186 }; |
187 | |
188 /** | |
189 * Data specific to Chats. | |
190 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
191 struct _GaimChat |
4359 | 192 { |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
193 GaimConversation *conv; /**< The parent conversation. */ |
4359 | 194 |
4465
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
195 GList *in_room; /**< The users in the room. */ |
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
196 GList *ignored; /**< Ignored users. */ |
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
197 char *who; /**< The person who set the topic. */ |
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
198 char *topic; /**< The topic. */ |
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
199 int id; /**< The chat ID. */ |
4359 | 200 }; |
201 | |
202 /** | |
203 * A core representation of a conversation between two or more people. | |
204 * | |
205 * The conversation can be an IM or a chat. Each conversation is kept | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
206 * in a GaimWindow and has a UI representation. |
4359 | 207 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
208 struct _GaimConversation |
4359 | 209 { |
210 GaimConversationType type; /**< The type of conversation. */ | |
211 | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
212 GaimAccount *account; /**< The user using this conversation. */ |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
213 GaimWindow *window; /**< The parent window. */ |
4359 | 214 |
215 int conversation_pos; /**< The position in the window's list. */ | |
216 | |
217 char *name; /**< The name of the conversation. */ | |
218 char *title; /**< The window title. */ | |
219 | |
220 gboolean logging; /**< The status of logging. */ | |
221 | |
222 GList *send_history; /**< The send history. */ | |
223 GString *history; /**< The conversation history. */ | |
224 | |
225 GaimUnseenState unseen; /**< The unseen tab state. */ | |
226 | |
227 union | |
228 { | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
229 GaimIm *im; /**< IM-specific data. */ |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
230 GaimChat *chat; /**< Chat-specific data. */ |
4378
194507c83612
[gaim-migrate @ 4644]
Christian Hammond <chipx86@chipx86.com>
parents:
4359
diff
changeset
|
231 void *misc; /**< Misc. data. */ |
4359 | 232 |
233 } u; | |
4465
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
234 |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
235 GaimConversationUiOps *ui_ops; /**< UI-specific operations. */ |
4465
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
236 void *ui_data; /**< UI-specific data. */ |
4876
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
237 |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
238 GHashTable *data; /**< Plugin-specific data. */ |
4359 | 239 }; |
240 | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
241 typedef void (*GaimConvPlacementFunc)(GaimConversation *); |
4359 | 242 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
243 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
244 extern "C" { |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
245 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
246 |
4359 | 247 /**************************************************************************/ |
248 /** @name Conversation Window API */ | |
249 /**************************************************************************/ | |
250 /*@{*/ | |
251 | |
252 /** | |
253 * Creates a new conversation window. | |
254 * | |
255 * This window is added to the list of windows, but is not shown until | |
256 * gaim_window_show() is called. | |
257 * | |
258 * @return The new conversation window. | |
259 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
260 GaimWindow *gaim_window_new(void); |
4359 | 261 |
262 /** | |
263 * Destroys the specified conversation window and all conversations in it. | |
264 * | |
265 * @param win The window to destroy. | |
266 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
267 void gaim_window_destroy(GaimWindow *win); |
4359 | 268 |
269 /** | |
270 * Shows the specified conversation window. | |
271 * | |
272 * @param win The window. | |
273 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
274 void gaim_window_show(GaimWindow *win); |
4359 | 275 |
276 /** | |
277 * Hides the specified conversation window. | |
278 * | |
279 * @param win The window. | |
280 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
281 void gaim_window_hide(GaimWindow *win); |
4359 | 282 |
283 /** | |
284 * Raises the specified conversation window. | |
285 * | |
286 * @param win The window. | |
287 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
288 void gaim_window_raise(GaimWindow *win); |
4359 | 289 |
290 /** | |
291 * Causes the window to flash for IM notification, if the UI supports this. | |
6585
f30579b25253
[gaim-migrate @ 7107]
Christian Hammond <chipx86@chipx86.com>
parents:
6488
diff
changeset
|
292 * |
4359 | 293 * @param win The window. |
294 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
295 void gaim_window_flash(GaimWindow *win); |
4359 | 296 |
297 /** | |
298 * Sets the specified window's UI window operations structure. | |
299 * | |
300 * @param win The window. | |
301 * @param ops The UI window operations structure. | |
302 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
303 void gaim_window_set_ui_ops(GaimWindow *win, GaimWindowUiOps *ops); |
4359 | 304 |
305 /** | |
306 * Returns the specified window's UI window operations structure. | |
307 * | |
308 * @param win The window. | |
309 * | |
310 * @return The UI window operations structure. | |
311 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
312 GaimWindowUiOps *gaim_window_get_ui_ops(const GaimWindow *win); |
4359 | 313 |
314 /** | |
315 * Adds a conversation to this window. | |
316 * | |
317 * If the conversation already has a parent window, this will do nothing. | |
318 * | |
319 * @param win The window. | |
320 * @param conv The conversation. | |
321 * | |
322 * @return The new index of the conversation in the window. | |
323 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
324 int gaim_window_add_conversation(GaimWindow *win, GaimConversation *conv); |
4359 | 325 |
326 /** | |
327 * Removes the conversation at the specified index from the window. | |
328 * | |
329 * If there is no conversation at this index, this will do nothing. | |
330 * | |
331 * @param win The window. | |
332 * @param index The index of the conversation. | |
333 * | |
334 * @return The conversation removed. | |
335 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
336 GaimConversation *gaim_window_remove_conversation(GaimWindow *win, |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
337 unsigned int index); |
4359 | 338 |
339 /** | |
340 * Moves the conversation at the specified index in a window to a new index. | |
341 * | |
342 * @param win The window. | |
343 * @param index The index of the conversation to move. | |
344 * @param new_index The new index. | |
345 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
346 void gaim_window_move_conversation(GaimWindow *win, unsigned int index, |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
347 unsigned int new_index); |
4359 | 348 |
349 /** | |
350 * Returns the conversation in the window at the specified index. | |
351 * | |
352 * If the index is out of range, this returns @c NULL. | |
353 * | |
354 * @param win The window. | |
355 * @param index The index containing a conversation. | |
356 * | |
357 * @return The conversation at the specified index. | |
358 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
359 GaimConversation *gaim_window_get_conversation_at(const GaimWindow *win, |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
360 unsigned int index); |
4359 | 361 |
362 /** | |
363 * Returns the number of conversations in the window. | |
364 * | |
365 * @param win The window. | |
366 * | |
367 * @return The number of conversations. | |
368 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
369 size_t gaim_window_get_conversation_count(const GaimWindow *win); |
4359 | 370 |
371 /** | |
372 * Switches the active conversation to the one at the specified index. | |
373 * | |
374 * If @a index is out of range, this does nothing. | |
375 * | |
376 * @param win The window. | |
377 * @param index The new index. | |
378 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
379 void gaim_window_switch_conversation(GaimWindow *win, unsigned int index); |
4359 | 380 |
381 /** | |
382 * Returns the active conversation in the window. | |
383 * | |
384 * @param win The window. | |
385 * | |
386 * @return The active conversation. | |
387 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
388 GaimConversation *gaim_window_get_active_conversation(const GaimWindow *win); |
4359 | 389 |
390 /** | |
391 * Returns the list of conversations in the specified window. | |
392 * | |
393 * @param win The window. | |
394 * | |
395 * @return The list of conversations. | |
396 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
397 GList *gaim_window_get_conversations(const GaimWindow *win); |
4359 | 398 |
399 /** | |
400 * Returns a list of all windows. | |
401 * | |
402 * @return A list of windows. | |
403 */ | |
404 GList *gaim_get_windows(void); | |
405 | |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
406 /** |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
407 * Returns the first window containing a conversation of the specified type. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
408 * |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
409 * @param type The conversation type. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
410 * |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
411 * @return The window if found, or @c NULL if not found. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
412 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
413 GaimWindow *gaim_get_first_window_with_type(GaimConversationType type); |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
414 |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
415 /** |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
416 * Returns the last window containing a conversation of the specified type. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
417 * |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
418 * @param type The conversation type. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
419 * |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
420 * @return The window if found, or @c NULL if not found. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
421 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
422 GaimWindow *gaim_get_last_window_with_type(GaimConversationType type); |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
423 |
4359 | 424 /*@}*/ |
425 | |
426 /**************************************************************************/ | |
427 /** @name Conversation API */ | |
428 /**************************************************************************/ | |
429 /*@{*/ | |
430 | |
431 /** | |
432 * Creates a new conversation of the specified type. | |
433 * | |
434 * @param type The type of conversation. | |
4476
62c1e5e656d0
[gaim-migrate @ 4751]
Christian Hammond <chipx86@chipx86.com>
parents:
4469
diff
changeset
|
435 * @param user The account opening the conversation window on the gaim |
62c1e5e656d0
[gaim-migrate @ 4751]
Christian Hammond <chipx86@chipx86.com>
parents:
4469
diff
changeset
|
436 * user's end. |
4359 | 437 * @param name The name of the conversation. |
438 * | |
439 * @return The new conversation. | |
440 */ | |
6585
f30579b25253
[gaim-migrate @ 7107]
Christian Hammond <chipx86@chipx86.com>
parents:
6488
diff
changeset
|
441 GaimConversation *gaim_conversation_new(GaimConversationType type, |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
442 GaimAccount *account, |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
443 const char *name); |
4359 | 444 |
445 /** | |
446 * Destroys the specified conversation and removes it from the parent | |
447 * window. | |
448 * | |
449 * If this conversation is the only one contained in the parent window, | |
450 * that window is also destroyed. | |
451 * | |
452 * @param conv The conversation to destroy. | |
453 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
454 void gaim_conversation_destroy(GaimConversation *conv); |
4359 | 455 |
456 /** | |
457 * Returns the specified conversation's type. | |
458 * | |
459 * @param conv The conversation. | |
460 * | |
461 * @return The conversation's type. | |
462 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
463 GaimConversationType gaim_conversation_get_type(const GaimConversation *conv); |
4359 | 464 |
465 /** | |
466 * Sets the specified conversation's UI operations structure. | |
467 * | |
468 * @param conv The conversation. | |
469 * @param ops The UI conversation operations structure. | |
470 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
471 void gaim_conversation_set_ui_ops(GaimConversation *conv, |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
472 GaimConversationUiOps *ops); |
4359 | 473 |
474 /** | |
475 * Returns the specified conversation's UI operations structure. | |
6585
f30579b25253
[gaim-migrate @ 7107]
Christian Hammond <chipx86@chipx86.com>
parents:
6488
diff
changeset
|
476 * |
4359 | 477 * @param conv The conversation. |
478 * | |
479 * @return The operations structure. | |
480 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
481 GaimConversationUiOps *gaim_conversation_get_ui_ops( |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
482 const GaimConversation *conv); |
4359 | 483 |
484 /** | |
4491 | 485 * Sets the specified conversation's gaim_account. |
4359 | 486 * |
4491 | 487 * This gaim_account represents the user using gaim, not the person the user |
4359 | 488 * is having a conversation/chat/flame with. |
489 * | |
490 * @param conv The conversation. | |
4491 | 491 * @param account The gaim_account. |
4359 | 492 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
493 void gaim_conversation_set_account(GaimConversation *conv, |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
494 GaimAccount *account); |
4359 | 495 |
496 /** | |
4491 | 497 * Returns the specified conversation's gaim_account. |
4359 | 498 * |
4491 | 499 * This gaim_account represents the user using gaim, not the person the user |
4359 | 500 * is having a conversation/chat/flame with. |
501 * | |
502 * @param conv The conversation. | |
503 * | |
4491 | 504 * @return The conversation's gaim_account. |
4359 | 505 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
506 GaimAccount *gaim_conversation_get_account(const GaimConversation *conv); |
4359 | 507 |
508 /** | |
509 * Returns the specified conversation's gaim_connection. | |
510 * | |
511 * This is the same as gaim_conversation_get_user(conv)->gc. | |
512 * | |
513 * @param conv The conversation. | |
514 * | |
515 * @return The conversation's gaim_connection. | |
516 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
517 GaimConnection *gaim_conversation_get_gc(const GaimConversation *conv); |
4359 | 518 |
519 /** | |
520 * Sets the specified conversation's title. | |
521 * | |
522 * @param conv The conversation. | |
523 * @param title The title. | |
524 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
525 void gaim_conversation_set_title(GaimConversation *conv, const char *title); |
4359 | 526 |
527 /** | |
528 * Returns the specified conversation's title. | |
529 * | |
530 * @param win The conversation. | |
531 * | |
532 * @return The title. | |
533 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
534 const char *gaim_conversation_get_title(const GaimConversation *conv); |
4359 | 535 |
536 /** | |
537 * Automatically sets the specified conversation's title. | |
538 * | |
539 * This function takes OPT_IM_ALIAS_TAB into account, as well as the | |
540 * user's alias. | |
541 * | |
542 * @param conv The conversation. | |
543 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
544 void gaim_conversation_autoset_title(GaimConversation *conv); |
4359 | 545 |
546 /** | |
547 * Returns the specified conversation's index in the parent window. | |
548 * | |
549 * @param conv The conversation. | |
550 * | |
551 * @return The current index in the parent window. | |
552 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
553 int gaim_conversation_get_index(const GaimConversation *conv); |
4359 | 554 |
555 /** | |
556 * Sets the conversation's unseen state. | |
557 * | |
558 * @param conv The conversation. | |
559 * @param state The new unseen state. | |
560 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
561 void gaim_conversation_set_unseen(GaimConversation *conv, |
4359 | 562 GaimUnseenState state); |
563 | |
564 /** | |
565 * Returns the conversation's unseen state. | |
566 * | |
567 * @param conv The conversation. | |
568 * | |
569 * @param The conversation's unseen state. | |
570 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
571 GaimUnseenState gaim_conversation_get_unseen(const GaimConversation *conv); |
4359 | 572 |
573 /** | |
574 * Returns the specified conversation's name. | |
575 * | |
576 * @param conv The conversation. | |
577 * | |
578 * @return The conversation's name. | |
579 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
580 const char *gaim_conversation_get_name(const GaimConversation *conv); |
4359 | 581 |
582 /** | |
583 * Enables or disables logging for this conversation. | |
584 * | |
585 * @param log @c TRUE if logging should be enabled, or @c FALSE otherwise. | |
586 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
587 void gaim_conversation_set_logging(GaimConversation *conv, gboolean log); |
4359 | 588 |
589 /** | |
590 * Returns whether or not logging is enabled for this conversation. | |
591 * | |
592 * @return @c TRUE if logging is enabled, or @c FALSE otherwise. | |
593 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
594 gboolean gaim_conversation_is_logging(const GaimConversation *conv); |
4359 | 595 |
596 /** | |
597 * Returns the specified conversation's send history. | |
598 * | |
599 * @param conv The conversation. | |
600 * | |
601 * @return The conversation's send history. | |
602 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
603 GList *gaim_conversation_get_send_history(const GaimConversation *conv); |
4359 | 604 |
605 /** | |
606 * Sets the specified conversation's history. | |
607 * | |
608 * @param conv The conversation. | |
609 * @param history The history. | |
610 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
611 void gaim_conversation_set_history(GaimConversation *conv, GString *history); |
4359 | 612 |
613 /** | |
614 * Returns the specified conversation's history. | |
615 * | |
616 * @param conv The conversation. | |
617 * | |
618 * @return The conversation's history. | |
619 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
620 GString *gaim_conversation_get_history(const GaimConversation *conv); |
4359 | 621 |
622 /** | |
623 * Returns the specified conversation's parent window. | |
624 * | |
625 * @param conv The conversation. | |
626 * | |
627 * @return The conversation's parent window. | |
628 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
629 GaimWindow *gaim_conversation_get_window(const GaimConversation *conv); |
4359 | 630 |
631 /** | |
632 * Returns the specified conversation's IM-specific data. | |
633 * | |
634 * If the conversation type is not GAIM_CONV_IM, this will return @c NULL. | |
635 * | |
636 * @param conv The conversation. | |
637 * | |
638 * @return The IM-specific data. | |
639 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
640 GaimIm *gaim_conversation_get_im_data(const GaimConversation *conv); |
4359 | 641 |
642 #define GAIM_IM(c) (gaim_conversation_get_im_data(c)) | |
643 | |
644 /** | |
645 * Returns the specified conversation's chat-specific data. | |
646 * | |
647 * If the conversation type is not GAIM_CONV_CHAT, this will return @c NULL. | |
648 * | |
649 * @param conv The conversation. | |
650 * | |
651 * @return The chat-specific data. | |
652 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
653 GaimChat *gaim_conversation_get_chat_data(const GaimConversation *conv); |
4359 | 654 |
655 #define GAIM_CHAT(c) (gaim_conversation_get_chat_data(c)) | |
656 | |
657 /** | |
4877
249382064693
[gaim-migrate @ 5207]
Christian Hammond <chipx86@chipx86.com>
parents:
4876
diff
changeset
|
658 * Sets extra data for a conversation. |
6585
f30579b25253
[gaim-migrate @ 7107]
Christian Hammond <chipx86@chipx86.com>
parents:
6488
diff
changeset
|
659 * |
4876
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
660 * @param conv The conversation. |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
661 * @param key The unique key. |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
662 * @param data The data to assign. |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
663 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
664 void gaim_conversation_set_data(GaimConversation *conv, const char *key, |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
665 gpointer data); |
4876
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
666 |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
667 /** |
4877
249382064693
[gaim-migrate @ 5207]
Christian Hammond <chipx86@chipx86.com>
parents:
4876
diff
changeset
|
668 * Returns extra data in a conversation. |
4876
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
669 * |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
670 * @param conv The conversation. |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
671 * @param key The unqiue key. |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
672 * |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
673 * @return The data associated with the key. |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
674 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
675 gpointer gaim_conversation_get_data(GaimConversation *conv, const char *key); |
4876
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
676 |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
677 /** |
4359 | 678 * Returns a list of all conversations. |
679 * | |
680 * This list includes both IMs and chats. | |
681 * | |
682 * @return A GList of all conversations. | |
683 */ | |
684 GList *gaim_get_conversations(void); | |
685 | |
686 /** | |
687 * Returns a list of all IMs. | |
688 * | |
689 * @return A GList of all IMs. | |
690 */ | |
691 GList *gaim_get_ims(void); | |
692 | |
693 /** | |
694 * Returns a list of all chats. | |
695 * | |
696 * @return A GList of all chats. | |
697 */ | |
698 GList *gaim_get_chats(void); | |
699 | |
700 /** | |
701 * Finds the conversation with the specified name. | |
702 * | |
703 * @param name The name of the conversation. | |
704 * | |
705 * @return The conversation if found, or @c NULL otherwise. | |
706 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
707 GaimConversation *gaim_find_conversation(const char *name); |
4359 | 708 |
709 /** | |
710 * Finds a conversation with the specified name and user. | |
711 * | |
712 * @param name The name of the conversation. | |
4491 | 713 * @param account The gaim_account associated with the conversation. |
4359 | 714 * |
715 * @return The conversation if found, or @c NULL otherwise. | |
716 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
717 GaimConversation *gaim_find_conversation_with_account( |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5207
diff
changeset
|
718 const char *name, const GaimAccount *account); |
4359 | 719 |
720 /** | |
721 * Writes to a conversation window. | |
722 * | |
723 * This function should not be used to write IM or chat messages. Use | |
724 * gaim_im_write() and gaim_chat_write() instead. Those functions will | |
725 * most likely call this anyway, but they may do their own formatting, | |
726 * sound playback, etc. | |
727 * | |
728 * This can be used to write generic messages, such as "so and so closed | |
729 * the conversation window." | |
730 * | |
731 * @param conv The conversation. | |
732 * @param who The user who sent the message. | |
733 * @param message The message. | |
734 * @param length The length of the message. | |
735 * @param flags The flags. | |
736 * @param mtime The time the message was sent. | |
737 * | |
738 * @see gaim_im_write() | |
739 * @see gaim_chat_write() | |
740 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
741 void gaim_conversation_write(GaimConversation *conv, const char *who, |
4359 | 742 const char *message, size_t length, int flags, |
743 time_t mtime); | |
744 | |
745 /** | |
746 * Updates the progress bar on a conversation window | |
747 * (if one exists in the UI). | |
748 * | |
749 * This is used for loading images typically. | |
750 * | |
751 * @param conv The conversation. | |
752 * @param percent The percentage. | |
753 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
754 void gaim_conversation_update_progress(GaimConversation *conv, float percent); |
4359 | 755 |
756 /** | |
757 * Updates the visual status and UI of a conversation. | |
758 * | |
759 * @param conv The conversation. | |
760 * @param type The update type. | |
761 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
762 void gaim_conversation_update(GaimConversation *conv, GaimConvUpdateType type); |
4359 | 763 |
764 /** | |
765 * Calls a function on each conversation. | |
766 * | |
767 * @param func The function. | |
768 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
769 void gaim_conversation_foreach(void (*func)(GaimConversation *conv)); |
4359 | 770 |
771 /*@}*/ | |
772 | |
773 | |
774 /**************************************************************************/ | |
775 /** @name IM Conversation API */ | |
776 /**************************************************************************/ | |
777 /*@{*/ | |
778 | |
779 /** | |
780 * Gets an IM's parent conversation. | |
781 * | |
782 * @param im The IM. | |
783 * | |
784 * @return The parent conversation. | |
785 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
786 GaimConversation *gaim_im_get_conversation(const GaimIm *im); |
4359 | 787 |
788 /** | |
789 * Sets the IM's typing state. | |
790 * | |
791 * @param im The IM. | |
792 * @param state The typing state. | |
793 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
794 void gaim_im_set_typing_state(GaimIm *im, int state); |
4359 | 795 |
796 /** | |
797 * Returns the IM's typing state. | |
798 * | |
799 * @param im The IM. | |
800 * | |
801 * @return The IM's typing state. | |
802 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
803 int gaim_im_get_typing_state(const GaimIm *im); |
4359 | 804 |
805 /** | |
806 * Starts the IM's typing timeout. | |
807 * | |
808 * @param im The IM. | |
809 * @param timeout The timeout. | |
810 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
811 void gaim_im_start_typing_timeout(GaimIm *im, int timeout); |
4359 | 812 |
813 /** | |
814 * Stops the IM's typing timeout. | |
815 * | |
816 * @param im The IM. | |
817 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
818 void gaim_im_stop_typing_timeout(GaimIm *im); |
4359 | 819 |
820 /** | |
821 * Returns the IM's typing timeout. | |
822 * | |
823 * @param im The IM. | |
824 * | |
825 * @return The timeout. | |
826 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
827 guint gaim_im_get_typing_timeout(const GaimIm *im); |
4359 | 828 |
829 /** | |
830 * Sets the IM's time until it should send another typing notification. | |
831 * | |
832 * @param im The IM. | |
833 * @param val The time. | |
834 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
835 void gaim_im_set_type_again(GaimIm *im, time_t val); |
4359 | 836 |
837 /** | |
838 * Returns the IM's time until it should send another typing notification. | |
839 * | |
840 * @param im The IM. | |
841 * | |
842 * @return The time. | |
843 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
844 time_t gaim_im_get_type_again(const GaimIm *im); |
4359 | 845 |
846 /** | |
847 * Starts the IM's type again timeout. | |
848 * | |
849 * @param im The IM. | |
850 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
851 void gaim_im_start_type_again_timeout(GaimIm *im); |
4359 | 852 |
853 /** | |
854 * Stops the IM's type again timeout. | |
855 * | |
856 * @param im The IM. | |
857 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
858 void gaim_im_stop_type_again_timeout(GaimIm *im); |
4359 | 859 |
860 /** | |
861 * Returns the IM's type again timeout interval. | |
862 * | |
863 * @param im The IM. | |
864 * | |
865 * @return The type again timeout interval. | |
866 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
867 guint gaim_im_get_type_again_timeout(const GaimIm *im); |
4359 | 868 |
869 /** | |
870 * Updates the visual typing notification for an IM conversation. | |
871 * | |
872 * @param im The IM. | |
873 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
874 void gaim_im_update_typing(GaimIm *im); |
4359 | 875 |
876 /** | |
877 * Writes to an IM. | |
878 * | |
879 * The @a len parameter is used for writing binary data, such as an | |
880 * image. If @c message is text, specify -1 for @a len. | |
881 * | |
882 * @param im The IM. | |
883 * @param who The user who sent the message. | |
884 * @param message The message to write. | |
885 * @param len The length of the message, or -1 to specify the length | |
886 * of @a message. | |
887 * @param flag The flags. | |
888 * @param mtime The time the message was sent. | |
889 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
890 void gaim_im_write(GaimIm *im, const char *who, |
4359 | 891 const char *message, size_t len, int flag, time_t mtime); |
892 | |
893 /** | |
894 * Sends a message to this IM conversation. | |
895 * | |
896 * @param im The IM. | |
897 * @param message The message to send. | |
898 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
899 void gaim_im_send(GaimIm *im, const char *message); |
4359 | 900 |
901 /*@}*/ | |
902 | |
903 | |
904 /**************************************************************************/ | |
905 /** @name Chat Conversation API */ | |
906 /**************************************************************************/ | |
907 /*@{*/ | |
908 | |
909 /** | |
910 * Gets a chat's parent conversation. | |
911 * | |
912 * @param chat The chat. | |
913 * | |
914 * @return The parent conversation. | |
915 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
916 GaimConversation *gaim_chat_get_conversation(const GaimChat *chat); |
4359 | 917 |
918 /** | |
919 * Sets the list of users in the chat room. | |
920 * | |
6407
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
921 * @note Calling this function will not update the display of the users. |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
922 * Please use gaim_chat_add_user(), gaim_chat_add_users(), |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
923 * gaim_chat_remove_user(), and gaim_chat_remove_users() instead. |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
924 * |
4359 | 925 * @param chat The chat. |
926 * @param users The list of users. | |
927 * | |
928 * @return The list passed. | |
929 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
930 GList *gaim_chat_set_users(GaimChat *chat, GList *users); |
4359 | 931 |
932 /** | |
933 * Returns a list of users in the chat room. | |
934 * | |
935 * @param chat The chat. | |
936 * | |
937 * @return The list of users. | |
938 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
939 GList *gaim_chat_get_users(const GaimChat *chat); |
4359 | 940 |
941 /** | |
942 * Ignores a user in a chat room. | |
943 * | |
944 * @param chat The chat. | |
945 * @param name The name of the user. | |
946 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
947 void gaim_chat_ignore(GaimChat *chat, const char *name); |
4359 | 948 |
949 /** | |
950 * Unignores a user in a chat room. | |
951 * | |
952 * @param chat The chat. | |
953 * @param name The name of the user. | |
954 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
955 void gaim_chat_unignore(GaimChat *chat, const char *name); |
4359 | 956 |
957 /** | |
958 * Sets the list of ignored users in the chat room. | |
959 * | |
960 * @param chat The chat. | |
961 * @param ignored The list of ignored users. | |
962 * | |
963 * @return The list passed. | |
964 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
965 GList *gaim_chat_set_ignored(GaimChat *chat, GList *ignored); |
4359 | 966 |
967 /** | |
968 * Returns the list of ignored users in the chat room. | |
969 * | |
970 * @param chat The chat. | |
971 * | |
972 * @return The list of ignored users. | |
973 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
974 GList *gaim_chat_get_ignored(const GaimChat *chat); |
4359 | 975 |
976 /** | |
977 * Returns the actual name of the specified ignored user, if it exists in | |
978 * the ignore list. | |
979 * | |
980 * If the user found contains a prefix, such as '+' or '\@', this is also | |
981 * returned. The username passed to the function does not have to have this | |
982 * formatting. | |
983 * | |
984 * @param chat The chat. | |
985 * @param user The user to check in the ignore list. | |
986 * | |
987 * @return The ignored user if found, complete with prefixes, or @c NULL | |
988 * if not found. | |
989 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
990 const char *gaim_chat_get_ignored_user(const GaimChat *chat, |
4359 | 991 const char *user); |
992 | |
993 /** | |
994 * Returns @c TRUE if the specified user is ignored. | |
995 * | |
996 * @param chat The chat. | |
997 * @param user The user. | |
998 * | |
999 * @return @c TRUE if the user is in the ignore list; @c FALSE otherwise. | |
1000 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1001 gboolean gaim_chat_is_user_ignored(const GaimChat *chat, |
4359 | 1002 const char *user); |
1003 | |
1004 /** | |
1005 * Sets the chat room's topic. | |
1006 * | |
1007 * @param chat The chat. | |
1008 * @param who The user that set the topic. | |
1009 * @param topic The topic. | |
1010 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1011 void gaim_chat_set_topic(GaimChat *chat, const char *who, |
4359 | 1012 const char *topic); |
1013 | |
1014 /** | |
1015 * Returns the chat room's topic. | |
1016 * | |
1017 * @param chat The chat. | |
1018 * | |
1019 * @return The chat's topic. | |
1020 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1021 const char *gaim_chat_get_topic(const GaimChat *chat); |
4359 | 1022 |
1023 /** | |
1024 * Sets the chat room's ID. | |
1025 * | |
1026 * @param chat The chat. | |
1027 * @param id The ID. | |
1028 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1029 void gaim_chat_set_id(GaimChat *chat, int id); |
4359 | 1030 |
1031 /** | |
1032 * Returns the chat room's ID. | |
1033 * | |
1034 * @param chat The chat. | |
1035 * | |
1036 * @return The ID. | |
1037 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1038 int gaim_chat_get_id(const GaimChat *chat); |
4359 | 1039 |
1040 /** | |
1041 * Writes to a chat. | |
1042 * | |
1043 * @param chat The chat. | |
1044 * @param who The user who sent the message. | |
1045 * @param message The message to write. | |
1046 * @param flag The flags. | |
1047 * @param mtime The time the message was sent. | |
1048 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1049 void gaim_chat_write(GaimChat *chat, const char *who, |
4359 | 1050 const char *message, int flag, time_t mtime); |
1051 | |
1052 /** | |
1053 * Sends a message to this chat conversation. | |
1054 * | |
1055 * @param chat The chat. | |
1056 * @param message The message to send. | |
1057 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1058 void gaim_chat_send(GaimChat *chat, const char *message); |
4359 | 1059 |
1060 /** | |
1061 * Adds a user to a chat. | |
1062 * | |
1063 * @param chat The chat. | |
1064 * @param user The user to add. | |
1065 * @param extra_msg An extra message to display with the join message. | |
1066 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1067 void gaim_chat_add_user(GaimChat *chat, const char *user, |
4359 | 1068 const char *extra_msg); |
1069 | |
1070 /** | |
6407
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1071 * Adds a list of users to a chat. |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1072 * |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1073 * The data is copied from @a users, so it is up to the developer to |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1074 * free this list after calling this function. |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1075 * |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1076 * @param chat The chat. |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1077 * @param users The list of users to add. |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1078 */ |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1079 void gaim_chat_add_users(GaimChat *chat, GList *users); |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1080 |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1081 /** |
4359 | 1082 * Renames a user in a chat. |
1083 * | |
1084 * @param chat The chat. | |
1085 * @param old_user The old username. | |
1086 * @param new_user The new username. | |
1087 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1088 void gaim_chat_rename_user(GaimChat *chat, const char *old_user, |
4359 | 1089 const char *new_user); |
1090 | |
1091 /** | |
1092 * Removes a user from a chat, optionally with a reason. | |
1093 * | |
6407
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1094 * It is up to the developer to free this list after calling this function. |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1095 * |
4359 | 1096 * @param chat The chat. |
1097 * @param user The user that is being removed. | |
1098 * @param reason The optional reason given for the removal. Can be @c NULL. | |
1099 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1100 void gaim_chat_remove_user(GaimChat *chat, const char *user, |
4359 | 1101 const char *reason); |
1102 | |
1103 /** | |
6407
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1104 * Removes a list of users from a chat, optionally with a single reason. |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1105 * |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1106 * @param chat The chat. |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1107 * @param users The users that are being removed. |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1108 * @param reason The optional reason given for the removal. Can be @c NULL. |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1109 */ |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1110 void gaim_chat_remove_users(GaimChat *chat, GList *users, const char *reason); |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1111 |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1112 /** |
6414
874a5c9f4eb8
[gaim-migrate @ 6921]
Christian Hammond <chipx86@chipx86.com>
parents:
6407
diff
changeset
|
1113 * Clears all users from a chat. |
874a5c9f4eb8
[gaim-migrate @ 6921]
Christian Hammond <chipx86@chipx86.com>
parents:
6407
diff
changeset
|
1114 * |
874a5c9f4eb8
[gaim-migrate @ 6921]
Christian Hammond <chipx86@chipx86.com>
parents:
6407
diff
changeset
|
1115 * @param chat The chat. |
874a5c9f4eb8
[gaim-migrate @ 6921]
Christian Hammond <chipx86@chipx86.com>
parents:
6407
diff
changeset
|
1116 */ |
874a5c9f4eb8
[gaim-migrate @ 6921]
Christian Hammond <chipx86@chipx86.com>
parents:
6407
diff
changeset
|
1117 void gaim_chat_clear_users(GaimChat *chat); |
874a5c9f4eb8
[gaim-migrate @ 6921]
Christian Hammond <chipx86@chipx86.com>
parents:
6407
diff
changeset
|
1118 |
874a5c9f4eb8
[gaim-migrate @ 6921]
Christian Hammond <chipx86@chipx86.com>
parents:
6407
diff
changeset
|
1119 /** |
4359 | 1120 * Finds a chat with the specified chat ID. |
1121 * | |
1122 * @param gc The gaim_connection. | |
1123 * @param id The chat ID. | |
1124 * | |
1125 * @return The chat conversation. | |
1126 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1127 GaimConversation *gaim_find_chat(const GaimConnection *gc, int id); |
4359 | 1128 |
1129 /*@}*/ | |
1130 | |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1131 /**************************************************************************/ |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1132 /** @name Conversation Placement Functions */ |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1133 /**************************************************************************/ |
4481
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1134 /*@{*/ |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1135 |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1136 /** |
5858 | 1137 * Returns a GList containing the IDs and Names of the registered placement |
1138 * functions. | |
1139 * | |
1140 * @return The list of IDs and names. | |
1141 */ | |
1142 GList *gaim_conv_placement_get_options(void); | |
1143 | |
1144 /** | |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1145 * Adds a conversation placement function to the list of possible functions. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1146 * |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1147 * @param name The name of the function. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1148 * @param fnc A pointer to the function. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1149 */ |
6311
eaeac660c17c
[gaim-migrate @ 6810]
Christian Hammond <chipx86@chipx86.com>
parents:
6063
diff
changeset
|
1150 void gaim_conv_placement_add_fnc(const char *id, const char *name, |
eaeac660c17c
[gaim-migrate @ 6810]
Christian Hammond <chipx86@chipx86.com>
parents:
6063
diff
changeset
|
1151 GaimConvPlacementFunc fnc); |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1152 |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1153 /** |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1154 * Removes a conversation placement function from the list of possible |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1155 * functions. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1156 * |
5858 | 1157 * @param id The id of the function. |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1158 */ |
5858 | 1159 void gaim_conv_placement_remove_fnc(const char *id); |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1160 |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1161 /** |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1162 * Returns the name of the conversation placement function at the |
5858 | 1163 * specified id. |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1164 * |
5858 | 1165 * @param id The id. |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1166 * |
5858 | 1167 * @return The name of the function, or @c NULL if this id is invalid. |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1168 */ |
5858 | 1169 const char *gaim_conv_placement_get_name(const char *id); |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1170 |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1171 /** |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1172 * Returns a pointer to the conversation placement function at the |
5858 | 1173 * specified id. |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1174 * |
5858 | 1175 * @param id The id. |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1176 * |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1177 * @return A pointer to the function. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1178 */ |
5858 | 1179 GaimConvPlacementFunc gaim_conv_placement_get_fnc(const char *id); |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1180 |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1181 /** |
5858 | 1182 * Returns the id of the specified conversation placement function. |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1183 * |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1184 * @param fnc A pointer to the registered function. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1185 * |
5858 | 1186 * @return The id of the conversation, or NULL if the function is not |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1187 * registered. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1188 */ |
5858 | 1189 const char *gaim_conv_placement_get_fnc_id(GaimConvPlacementFunc fnc); |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1190 |
4481
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1191 /*@}*/ |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1192 |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1193 /**************************************************************************/ |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1194 /** @name UI Registration Functions */ |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1195 /**************************************************************************/ |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1196 /*@{*/ |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1197 |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1198 /** |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1199 * Sets the UI operations structure to be used in all gaim conversation |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1200 * windows. |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1201 * |
5207
2819f90a20ba
[gaim-migrate @ 5575]
Christian Hammond <chipx86@chipx86.com>
parents:
5034
diff
changeset
|
1202 * @param ops The UI operations structure. |
4481
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1203 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1204 void gaim_set_win_ui_ops(GaimWindowUiOps *ops); |
4481
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1205 |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1206 /** |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1207 * Returns the gaim window UI operations structure to be used in |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1208 * new windows. |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1209 * |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1210 * @return A filled-out GaimWindowUiOps structure. |
4481
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1211 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1212 GaimWindowUiOps *gaim_get_win_ui_ops(void); |
4481
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1213 |
6485
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1214 /*@}*/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1215 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1216 /**************************************************************************/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1217 /** @name Conversations Subsystem */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1218 /**************************************************************************/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1219 /*@{*/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1220 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1221 /** |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1222 * Returns the conversation subsystem handle. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1223 * |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1224 * @return The conversation subsystem handle. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1225 */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1226 void *gaim_conversations_get_handle(void); |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1227 |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
1228 /** |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
1229 * Initializes the conversation subsystem. |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
1230 */ |
6485
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1231 void gaim_conversations_init(void); |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1232 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1233 /** |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1234 * Uninitializes the conversation subsystem. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1235 */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1236 void gaim_conversations_uninit(void); |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
1237 |
4481
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1238 /*@}*/ |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1239 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
1240 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
1241 } |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
1242 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
1243 |
4890
89cb14edf8cf
[gaim-migrate @ 5220]
Christian Hammond <chipx86@chipx86.com>
parents:
4877
diff
changeset
|
1244 #endif /* _GAIM_CONVERSATION_H_ */ |