Mercurial > pidgin
annotate src/conversation.h @ 12820:cb3cbd69284d
[gaim-migrate @ 15168]
Oops, typos.
committer: Tailor Script <tailor@pidgin.im>
author | Etan Reisner <pidgin@unreliablesource.net> |
---|---|
date | Wed, 11 Jan 2006 05:01:45 +0000 |
parents | eda1572c788b |
children | cf3540702d21 |
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 * | |
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. | |
6485
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
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 | |
6488
e5e8d21bd4d8
[gaim-migrate @ 7002]
Christian Hammond <chipx86@chipx86.com>
parents:
6485
diff
changeset
|
24 * |
6605
943b03bcecf5
[gaim-migrate @ 7129]
Christian Hammond <chipx86@chipx86.com>
parents:
6585
diff
changeset
|
25 * @see @ref conversation-signals |
4359 | 26 */ |
4890
89cb14edf8cf
[gaim-migrate @ 5220]
Christian Hammond <chipx86@chipx86.com>
parents:
4877
diff
changeset
|
27 #ifndef _GAIM_CONVERSATION_H_ |
89cb14edf8cf
[gaim-migrate @ 5220]
Christian Hammond <chipx86@chipx86.com>
parents:
4877
diff
changeset
|
28 #define _GAIM_CONVERSATION_H_ |
4359 | 29 |
30 /**************************************************************************/ | |
31 /** Data Structures */ | |
32 /**************************************************************************/ | |
33 | |
11581 | 34 |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
35 typedef struct _GaimConversationUiOps GaimConversationUiOps; |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
36 typedef struct _GaimConversation GaimConversation; |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
37 typedef struct _GaimConvIm GaimConvIm; |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
38 typedef struct _GaimConvChat GaimConvChat; |
9554 | 39 typedef struct _GaimConvChatBuddy GaimConvChatBuddy; |
4359 | 40 |
41 /** | |
42 * A type of conversation. | |
43 */ | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
44 typedef enum |
4359 | 45 { |
11338 | 46 GAIM_CONV_TYPE_UNKNOWN = 0, /**< Unknown conversation type. */ |
47 GAIM_CONV_TYPE_IM, /**< Instant Message. */ | |
48 GAIM_CONV_TYPE_CHAT, /**< Chat room. */ | |
49 GAIM_CONV_TYPE_MISC, /**< A misc. conversation. */ | |
50 GAIM_CONV_TYPE_ANY /**< Any type of conversation. */ | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
51 |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
52 } GaimConversationType; |
4359 | 53 |
54 /** | |
55 * Conversation update type. | |
56 */ | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
57 typedef enum |
4359 | 58 { |
59 GAIM_CONV_UPDATE_ADD = 0, /**< The buddy associated with the conversation | |
8155
77d1252b3803
[gaim-migrate @ 8867]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
60 was added. */ |
4359 | 61 GAIM_CONV_UPDATE_REMOVE, /**< The buddy associated with the conversation |
8155
77d1252b3803
[gaim-migrate @ 8867]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
62 was removed. */ |
4491 | 63 GAIM_CONV_UPDATE_ACCOUNT, /**< The gaim_account was changed. */ |
4359 | 64 GAIM_CONV_UPDATE_TYPING, /**< The typing state was updated. */ |
65 GAIM_CONV_UPDATE_UNSEEN, /**< The unseen state was updated. */ | |
66 GAIM_CONV_UPDATE_LOGGING, /**< Logging for this conversation was | |
8155
77d1252b3803
[gaim-migrate @ 8867]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
67 enabled or disabled. */ |
4359 | 68 GAIM_CONV_UPDATE_TOPIC, /**< The topic for a chat was updated. */ |
69 /* | |
70 * XXX These need to go when we implement a more generic core/UI event | |
71 * system. | |
72 */ | |
4378
194507c83612
[gaim-migrate @ 4644]
Christian Hammond <chipx86@chipx86.com>
parents:
4359
diff
changeset
|
73 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
|
74 GAIM_CONV_ACCOUNT_OFFLINE, /**< One of the user's accounts went offline. */ |
6846
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
75 GAIM_CONV_UPDATE_AWAY, /**< The other user went away. */ |
8155
77d1252b3803
[gaim-migrate @ 8867]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
76 GAIM_CONV_UPDATE_ICON, /**< The other user's buddy icon changed. */ |
8256
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
77 GAIM_CONV_UPDATE_TITLE, |
10665 | 78 GAIM_CONV_UPDATE_CHATLEFT, |
79 | |
80 GAIM_CONV_UPDATE_FEATURES, /**< The features for a chat have changed */ | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
81 |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
82 } GaimConvUpdateType; |
4359 | 83 |
84 /** | |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
85 * The typing state of a user. |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
86 */ |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
87 typedef enum |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
88 { |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
89 GAIM_NOT_TYPING = 0, /**< Not typing. */ |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
90 GAIM_TYPING, /**< Currently typing. */ |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
91 GAIM_TYPED /**< Stopped typing momentarily. */ |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
92 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
93 } GaimTypingState; |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
94 |
6621 | 95 /** |
96 * Flags applicable to a message. Most will have send, recv or system. | |
97 */ | |
98 typedef enum | |
99 { | |
6982 | 100 GAIM_MESSAGE_SEND = 0x0001, /**< Outgoing message. */ |
101 GAIM_MESSAGE_RECV = 0x0002, /**< Incoming message. */ | |
102 GAIM_MESSAGE_SYSTEM = 0x0004, /**< System message. */ | |
103 GAIM_MESSAGE_AUTO_RESP = 0x0008, /**< Auto response. */ | |
104 GAIM_MESSAGE_COLORIZE = 0x0010, /**< Colorize nicks. */ | |
105 GAIM_MESSAGE_NICK = 0x0020, /**< Contains your nick. */ | |
106 GAIM_MESSAGE_NO_LOG = 0x0040, /**< Do not log. */ | |
107 GAIM_MESSAGE_WHISPER = 0x0080, /**< Whispered message. */ | |
9584 | 108 GAIM_MESSAGE_ERROR = 0x0200, /**< Error message. */ |
10346 | 109 GAIM_MESSAGE_DELAYED = 0x0400, /**< Delayed message. */ |
12216 | 110 GAIM_MESSAGE_RAW = 0x0800, /**< "Raw" message - don't apply formatting */ |
111 GAIM_MESSAGE_IMAGES = 0x1000 /**< Message contains images */ | |
10008 | 112 |
6621 | 113 } GaimMessageFlags; |
114 | |
9554 | 115 /** |
116 * Flags applicable to users in Chats. | |
117 */ | |
118 typedef enum | |
119 { | |
120 GAIM_CBFLAGS_NONE = 0x0000, /**< No flags */ | |
121 GAIM_CBFLAGS_VOICE = 0x0001, /**< Voiced user or "Participant" */ | |
122 GAIM_CBFLAGS_HALFOP = 0x0002, /**< Half-op */ | |
123 GAIM_CBFLAGS_OP = 0x0004, /**< Channel Op or Moderator */ | |
10665 | 124 GAIM_CBFLAGS_FOUNDER = 0x0008, /**< Channel Founder */ |
125 GAIM_CBFLAGS_TYPING = 0x0010, /**< Currently typing */ | |
11581 | 126 |
10008 | 127 |
9554 | 128 } GaimConvChatBuddyFlags; |
129 | |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
130 #include "account.h" |
9718 | 131 #include "buddyicon.h" |
7431 | 132 #include "log.h" |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
133 #include "server.h" |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
134 |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
135 /** |
4359 | 136 * Conversation operations and events. |
137 * | |
138 * Any UI representing a conversation must assign a filled-out | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
139 * GaimConversationUiOps structure to the GaimConversation. |
4359 | 140 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
141 struct _GaimConversationUiOps |
4359 | 142 { |
11581 | 143 void (*create_conversation)(GaimConversation *conv); |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
144 void (*destroy_conversation)(GaimConversation *conv); |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
145 void (*write_chat)(GaimConversation *conv, const char *who, |
8155
77d1252b3803
[gaim-migrate @ 8867]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
146 const char *message, GaimMessageFlags flags, |
77d1252b3803
[gaim-migrate @ 8867]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
147 time_t mtime); |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
148 void (*write_im)(GaimConversation *conv, const char *who, |
8155
77d1252b3803
[gaim-migrate @ 8867]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
149 const char *message, GaimMessageFlags flags, |
77d1252b3803
[gaim-migrate @ 8867]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
150 time_t mtime); |
11454
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11338
diff
changeset
|
151 void (*write_conv)(GaimConversation *conv, const char *name, const char *alias, |
8155
77d1252b3803
[gaim-migrate @ 8867]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
152 const char *message, GaimMessageFlags flags, |
77d1252b3803
[gaim-migrate @ 8867]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
153 time_t mtime); |
4359 | 154 |
12463
b1717befbb26
[gaim-migrate @ 14773]
Richard Laager <rlaager@wiktel.com>
parents:
12216
diff
changeset
|
155 void (*chat_add_users)(GaimConversation *conv, GList *users, |
b1717befbb26
[gaim-migrate @ 14773]
Richard Laager <rlaager@wiktel.com>
parents:
12216
diff
changeset
|
156 GList *flags, GList *aliases, gboolean new_arrivals); |
11485
16b0da1f376f
[gaim-migrate @ 13727]
Richard Laager <rlaager@wiktel.com>
parents:
11454
diff
changeset
|
157 void (*chat_rename_user)(GaimConversation *conv, const char *old_name, |
16b0da1f376f
[gaim-migrate @ 13727]
Richard Laager <rlaager@wiktel.com>
parents:
11454
diff
changeset
|
158 const char *new_name, const char *new_alias); |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
159 void (*chat_remove_user)(GaimConversation *conv, const char *user); |
6407
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
160 void (*chat_remove_users)(GaimConversation *conv, GList *users); |
9554 | 161 void (*chat_update_user)(GaimConversation *conv, const char *user); |
4359 | 162 |
12624
851b0bd7eb52
[gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents:
12618
diff
changeset
|
163 void (*present)(GaimConversation *conv); |
4359 | 164 |
9260
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
165 gboolean (*has_focus)(GaimConversation *conv); |
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
166 |
10526 | 167 /* Custom Smileys */ |
12618
204bd8fac61f
[gaim-migrate @ 14954]
Richard Laager <rlaager@wiktel.com>
parents:
12463
diff
changeset
|
168 gboolean (*custom_smiley_add)(GaimConversation *conv, const char *smile, gboolean remote); |
10526 | 169 void (*custom_smiley_write)(GaimConversation *conv, const char *smile, |
11137 | 170 const guchar *data, gsize size); |
10526 | 171 void (*custom_smiley_close)(GaimConversation *conv, const char *smile); |
4359 | 172 }; |
173 | |
174 /** | |
175 * Data specific to Instant Messages. | |
176 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
177 struct _GaimConvIm |
4359 | 178 { |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
179 GaimConversation *conv; /**< The parent conversation. */ |
4359 | 180 |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
181 GaimTypingState typing_state; /**< The current typing state. */ |
4465
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
182 guint typing_timeout; /**< The typing timer handle. */ |
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
183 time_t type_again; /**< The type again time. */ |
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
184 guint type_again_timeout; /**< The type again timer handle. */ |
4359 | 185 |
6846
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
186 GaimBuddyIcon *icon; /**< The buddy icon. */ |
4359 | 187 }; |
188 | |
189 /** | |
190 * Data specific to Chats. | |
191 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
192 struct _GaimConvChat |
4359 | 193 { |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
194 GaimConversation *conv; /**< The parent conversation. */ |
4359 | 195 |
4465
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
196 GList *in_room; /**< The users in the room. */ |
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
197 GList *ignored; /**< Ignored users. */ |
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
198 char *who; /**< The person who set the topic. */ |
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
199 char *topic; /**< The topic. */ |
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
200 int id; /**< The chat ID. */ |
8158 | 201 char *nick; /**< Your nick in this chat. */ |
8256
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
202 |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
203 gboolean left; /**< We left the chat and kept the window open */ |
4359 | 204 }; |
205 | |
206 /** | |
9554 | 207 * Data for "Chat Buddies" |
208 */ | |
209 struct _GaimConvChatBuddy | |
210 { | |
211 char *name; /**< The name */ | |
212 GaimConvChatBuddyFlags flags; /**< Flags (ops, voice etc.) */ | |
213 }; | |
214 | |
215 /** | |
4359 | 216 * A core representation of a conversation between two or more people. |
217 * | |
11581 | 218 * The conversation can be an IM or a chat. |
4359 | 219 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
220 struct _GaimConversation |
4359 | 221 { |
222 GaimConversationType type; /**< The type of conversation. */ | |
223 | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
224 GaimAccount *account; /**< The user using this conversation. */ |
4359 | 225 |
226 | |
227 char *name; /**< The name of the conversation. */ | |
228 char *title; /**< The window title. */ | |
229 | |
230 gboolean logging; /**< The status of logging. */ | |
8158 | 231 |
11454
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11338
diff
changeset
|
232 GList *logs; /**< This conversation's logs */ |
8158 | 233 |
4359 | 234 GList *send_history; /**< The send history. */ |
235 | |
236 union | |
237 { | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
238 GaimConvIm *im; /**< IM-specific data. */ |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
239 GaimConvChat *chat; /**< Chat-specific data. */ |
4378
194507c83612
[gaim-migrate @ 4644]
Christian Hammond <chipx86@chipx86.com>
parents:
4359
diff
changeset
|
240 void *misc; /**< Misc. data. */ |
4359 | 241 |
242 } u; | |
4465
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
243 |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
244 GaimConversationUiOps *ui_ops; /**< UI-specific operations. */ |
4465
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
245 void *ui_data; /**< UI-specific data. */ |
4876
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
246 |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
247 GHashTable *data; /**< Plugin-specific data. */ |
10849 | 248 |
10665 | 249 GaimConnectionFlags features; /**< The supported features */ |
250 | |
4359 | 251 }; |
252 | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
253 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
254 extern "C" { |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
255 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
256 |
4359 | 257 /**************************************************************************/ |
258 /** @name Conversation API */ | |
259 /**************************************************************************/ | |
260 /*@{*/ | |
261 | |
262 /** | |
263 * Creates a new conversation of the specified type. | |
264 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6622
diff
changeset
|
265 * @param type The type of conversation. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6622
diff
changeset
|
266 * @param account The account opening the conversation window on the gaim |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6622
diff
changeset
|
267 * user's end. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6622
diff
changeset
|
268 * @param name The name of the conversation. |
4359 | 269 * |
270 * @return The new conversation. | |
271 */ | |
6585
f30579b25253
[gaim-migrate @ 7107]
Christian Hammond <chipx86@chipx86.com>
parents:
6488
diff
changeset
|
272 GaimConversation *gaim_conversation_new(GaimConversationType type, |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
273 GaimAccount *account, |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
274 const char *name); |
4359 | 275 |
276 /** | |
277 * Destroys the specified conversation and removes it from the parent | |
278 * window. | |
279 * | |
280 * If this conversation is the only one contained in the parent window, | |
281 * that window is also destroyed. | |
282 * | |
283 * @param conv The conversation to destroy. | |
284 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
285 void gaim_conversation_destroy(GaimConversation *conv); |
4359 | 286 |
12624
851b0bd7eb52
[gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents:
12618
diff
changeset
|
287 |
851b0bd7eb52
[gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents:
12618
diff
changeset
|
288 /** |
851b0bd7eb52
[gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents:
12618
diff
changeset
|
289 * Present a conversation to the user. This allows core code to initiate a |
851b0bd7eb52
[gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents:
12618
diff
changeset
|
290 * conversation by displaying the IM dialog. |
851b0bd7eb52
[gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents:
12618
diff
changeset
|
291 * @param conv The conversation to present |
851b0bd7eb52
[gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents:
12618
diff
changeset
|
292 */ |
851b0bd7eb52
[gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents:
12618
diff
changeset
|
293 void gaim_conversation_present(GaimConversation *conv); |
851b0bd7eb52
[gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents:
12618
diff
changeset
|
294 |
851b0bd7eb52
[gaim-migrate @ 14960]
Christopher O'Brien <siege@pidgin.im>
parents:
12618
diff
changeset
|
295 |
4359 | 296 /** |
297 * Returns the specified conversation's type. | |
298 * | |
299 * @param conv The conversation. | |
300 * | |
301 * @return The conversation's type. | |
302 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
303 GaimConversationType gaim_conversation_get_type(const GaimConversation *conv); |
4359 | 304 |
305 /** | |
306 * Sets the specified conversation's UI operations structure. | |
307 * | |
308 * @param conv The conversation. | |
309 * @param ops The UI conversation operations structure. | |
310 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
311 void gaim_conversation_set_ui_ops(GaimConversation *conv, |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
312 GaimConversationUiOps *ops); |
4359 | 313 |
314 /** | |
11581 | 315 * Sets the default conversation UI operations structure. |
316 * | |
317 * @param ops The UI conversation operations structure. | |
318 */ | |
319 void gaim_conversations_set_ui_ops(GaimConversationUiOps *ops); | |
320 | |
321 /** | |
4359 | 322 * Returns the specified conversation's UI operations structure. |
6585
f30579b25253
[gaim-migrate @ 7107]
Christian Hammond <chipx86@chipx86.com>
parents:
6488
diff
changeset
|
323 * |
4359 | 324 * @param conv The conversation. |
325 * | |
326 * @return The operations structure. | |
327 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
328 GaimConversationUiOps *gaim_conversation_get_ui_ops( |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
329 const GaimConversation *conv); |
4359 | 330 |
331 /** | |
4491 | 332 * Sets the specified conversation's gaim_account. |
4359 | 333 * |
4491 | 334 * This gaim_account represents the user using gaim, not the person the user |
4359 | 335 * is having a conversation/chat/flame with. |
336 * | |
337 * @param conv The conversation. | |
4491 | 338 * @param account The gaim_account. |
4359 | 339 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
340 void gaim_conversation_set_account(GaimConversation *conv, |
10827 | 341 GaimAccount *account); |
4359 | 342 |
343 /** | |
4491 | 344 * Returns the specified conversation's gaim_account. |
4359 | 345 * |
4491 | 346 * This gaim_account represents the user using gaim, not the person the user |
4359 | 347 * is having a conversation/chat/flame with. |
348 * | |
349 * @param conv The conversation. | |
350 * | |
4491 | 351 * @return The conversation's gaim_account. |
4359 | 352 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
353 GaimAccount *gaim_conversation_get_account(const GaimConversation *conv); |
4359 | 354 |
355 /** | |
356 * Returns the specified conversation's gaim_connection. | |
357 * | |
358 * This is the same as gaim_conversation_get_user(conv)->gc. | |
359 * | |
360 * @param conv The conversation. | |
361 * | |
362 * @return The conversation's gaim_connection. | |
363 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
364 GaimConnection *gaim_conversation_get_gc(const GaimConversation *conv); |
4359 | 365 |
366 /** | |
367 * Sets the specified conversation's title. | |
368 * | |
369 * @param conv The conversation. | |
370 * @param title The title. | |
371 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
372 void gaim_conversation_set_title(GaimConversation *conv, const char *title); |
4359 | 373 |
374 /** | |
375 * Returns the specified conversation's title. | |
376 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6622
diff
changeset
|
377 * @param conv The conversation. |
4359 | 378 * |
379 * @return The title. | |
380 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
381 const char *gaim_conversation_get_title(const GaimConversation *conv); |
4359 | 382 |
383 /** | |
384 * Automatically sets the specified conversation's title. | |
385 * | |
386 * This function takes OPT_IM_ALIAS_TAB into account, as well as the | |
387 * user's alias. | |
388 * | |
389 * @param conv The conversation. | |
390 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
391 void gaim_conversation_autoset_title(GaimConversation *conv); |
4359 | 392 |
393 /** | |
7256
c93493c59ac3
[gaim-migrate @ 7833]
Christian Hammond <chipx86@chipx86.com>
parents:
7122
diff
changeset
|
394 * Sets the specified conversation's name. |
c93493c59ac3
[gaim-migrate @ 7833]
Christian Hammond <chipx86@chipx86.com>
parents:
7122
diff
changeset
|
395 * |
c93493c59ac3
[gaim-migrate @ 7833]
Christian Hammond <chipx86@chipx86.com>
parents:
7122
diff
changeset
|
396 * @param conv The conversation. |
c93493c59ac3
[gaim-migrate @ 7833]
Christian Hammond <chipx86@chipx86.com>
parents:
7122
diff
changeset
|
397 * @param name The conversation's name. |
c93493c59ac3
[gaim-migrate @ 7833]
Christian Hammond <chipx86@chipx86.com>
parents:
7122
diff
changeset
|
398 */ |
c93493c59ac3
[gaim-migrate @ 7833]
Christian Hammond <chipx86@chipx86.com>
parents:
7122
diff
changeset
|
399 void gaim_conversation_set_name(GaimConversation *conv, const char *name); |
c93493c59ac3
[gaim-migrate @ 7833]
Christian Hammond <chipx86@chipx86.com>
parents:
7122
diff
changeset
|
400 |
c93493c59ac3
[gaim-migrate @ 7833]
Christian Hammond <chipx86@chipx86.com>
parents:
7122
diff
changeset
|
401 /** |
4359 | 402 * Returns the specified conversation's name. |
403 * | |
404 * @param conv The conversation. | |
405 * | |
406 * @return The conversation's name. | |
407 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
408 const char *gaim_conversation_get_name(const GaimConversation *conv); |
4359 | 409 |
410 /** | |
411 * Enables or disables logging for this conversation. | |
412 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6622
diff
changeset
|
413 * @param conv The conversation. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6622
diff
changeset
|
414 * @param log @c TRUE if logging should be enabled, or @c FALSE otherwise. |
4359 | 415 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
416 void gaim_conversation_set_logging(GaimConversation *conv, gboolean log); |
4359 | 417 |
418 /** | |
419 * Returns whether or not logging is enabled for this conversation. | |
420 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6622
diff
changeset
|
421 * @param conv The conversation. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6622
diff
changeset
|
422 * |
4359 | 423 * @return @c TRUE if logging is enabled, or @c FALSE otherwise. |
424 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
425 gboolean gaim_conversation_is_logging(const GaimConversation *conv); |
4359 | 426 |
427 /** | |
11672
04e0189bb519
[gaim-migrate @ 13958]
Richard Laager <rlaager@wiktel.com>
parents:
11664
diff
changeset
|
428 * Closes any open logs for this conversation. |
04e0189bb519
[gaim-migrate @ 13958]
Richard Laager <rlaager@wiktel.com>
parents:
11664
diff
changeset
|
429 * |
04e0189bb519
[gaim-migrate @ 13958]
Richard Laager <rlaager@wiktel.com>
parents:
11664
diff
changeset
|
430 * Note that new logs will be opened as necessary (e.g. upon receipt of a |
04e0189bb519
[gaim-migrate @ 13958]
Richard Laager <rlaager@wiktel.com>
parents:
11664
diff
changeset
|
431 * message, if the conversation has logging enabled. To disable logging for |
04e0189bb519
[gaim-migrate @ 13958]
Richard Laager <rlaager@wiktel.com>
parents:
11664
diff
changeset
|
432 * the remainder of the conversation, use gaim_conversation_set_logging(). |
04e0189bb519
[gaim-migrate @ 13958]
Richard Laager <rlaager@wiktel.com>
parents:
11664
diff
changeset
|
433 * |
04e0189bb519
[gaim-migrate @ 13958]
Richard Laager <rlaager@wiktel.com>
parents:
11664
diff
changeset
|
434 * @param conv The conversation. |
04e0189bb519
[gaim-migrate @ 13958]
Richard Laager <rlaager@wiktel.com>
parents:
11664
diff
changeset
|
435 */ |
04e0189bb519
[gaim-migrate @ 13958]
Richard Laager <rlaager@wiktel.com>
parents:
11664
diff
changeset
|
436 void gaim_conversation_close_logs(GaimConversation *conv); |
04e0189bb519
[gaim-migrate @ 13958]
Richard Laager <rlaager@wiktel.com>
parents:
11664
diff
changeset
|
437 |
04e0189bb519
[gaim-migrate @ 13958]
Richard Laager <rlaager@wiktel.com>
parents:
11664
diff
changeset
|
438 /** |
4359 | 439 * Returns the specified conversation's send history. |
440 * | |
441 * @param conv The conversation. | |
442 * | |
443 * @return The conversation's send history. | |
444 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
445 GList *gaim_conversation_get_send_history(const GaimConversation *conv); |
4359 | 446 |
447 /** | |
448 * Returns the specified conversation's IM-specific data. | |
449 * | |
11338 | 450 * If the conversation type is not GAIM_CONV_TYPE_IM, this will return @c NULL. |
4359 | 451 * |
452 * @param conv The conversation. | |
453 * | |
454 * @return The IM-specific data. | |
455 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
456 GaimConvIm *gaim_conversation_get_im_data(const GaimConversation *conv); |
4359 | 457 |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
458 #define GAIM_CONV_IM(c) (gaim_conversation_get_im_data(c)) |
4359 | 459 |
460 /** | |
461 * Returns the specified conversation's chat-specific data. | |
462 * | |
11338 | 463 * If the conversation type is not GAIM_CONV_TYPE_CHAT, this will return @c NULL. |
4359 | 464 * |
465 * @param conv The conversation. | |
466 * | |
467 * @return The chat-specific data. | |
468 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
469 GaimConvChat *gaim_conversation_get_chat_data(const GaimConversation *conv); |
4359 | 470 |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
471 #define GAIM_CONV_CHAT(c) (gaim_conversation_get_chat_data(c)) |
4359 | 472 |
473 /** | |
4877
249382064693
[gaim-migrate @ 5207]
Christian Hammond <chipx86@chipx86.com>
parents:
4876
diff
changeset
|
474 * Sets extra data for a conversation. |
6585
f30579b25253
[gaim-migrate @ 7107]
Christian Hammond <chipx86@chipx86.com>
parents:
6488
diff
changeset
|
475 * |
4876
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
476 * @param conv The conversation. |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
477 * @param key The unique key. |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
478 * @param data The data to assign. |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
479 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
480 void gaim_conversation_set_data(GaimConversation *conv, const char *key, |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
481 gpointer data); |
4876
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
482 |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
483 /** |
4877
249382064693
[gaim-migrate @ 5207]
Christian Hammond <chipx86@chipx86.com>
parents:
4876
diff
changeset
|
484 * Returns extra data in a conversation. |
4876
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
485 * |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
486 * @param conv The conversation. |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
487 * @param key The unqiue key. |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
488 * |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
489 * @return The data associated with the key. |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
490 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
491 gpointer gaim_conversation_get_data(GaimConversation *conv, const char *key); |
4876
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
492 |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
493 /** |
4359 | 494 * Returns a list of all conversations. |
495 * | |
496 * This list includes both IMs and chats. | |
497 * | |
498 * @return A GList of all conversations. | |
499 */ | |
500 GList *gaim_get_conversations(void); | |
501 | |
502 /** | |
503 * Returns a list of all IMs. | |
504 * | |
505 * @return A GList of all IMs. | |
506 */ | |
507 GList *gaim_get_ims(void); | |
508 | |
509 /** | |
510 * Returns a list of all chats. | |
511 * | |
512 * @return A GList of all chats. | |
513 */ | |
514 GList *gaim_get_chats(void); | |
515 | |
516 /** | |
10246 | 517 * Finds a conversation with the specified type, name, and Gaim account. |
4359 | 518 * |
10246 | 519 * @param type The type of the conversation. |
4359 | 520 * @param name The name of the conversation. |
4491 | 521 * @param account The gaim_account associated with the conversation. |
4359 | 522 * |
523 * @return The conversation if found, or @c NULL otherwise. | |
524 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
525 GaimConversation *gaim_find_conversation_with_account( |
10246 | 526 GaimConversationType type, const char *name, |
527 const GaimAccount *account); | |
4359 | 528 |
529 /** | |
530 * Writes to a conversation window. | |
531 * | |
532 * This function should not be used to write IM or chat messages. Use | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
533 * gaim_conv_im_write() and gaim_conv_chat_write() instead. Those functions will |
4359 | 534 * most likely call this anyway, but they may do their own formatting, |
535 * sound playback, etc. | |
536 * | |
537 * This can be used to write generic messages, such as "so and so closed | |
538 * the conversation window." | |
539 * | |
540 * @param conv The conversation. | |
541 * @param who The user who sent the message. | |
542 * @param message The message. | |
6621 | 543 * @param flags The message flags. |
4359 | 544 * @param mtime The time the message was sent. |
545 * | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
546 * @see gaim_conv_im_write() |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
547 * @see gaim_conv_chat_write() |
4359 | 548 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
549 void gaim_conversation_write(GaimConversation *conv, const char *who, |
10665 | 550 const char *message, GaimMessageFlags flags, |
551 time_t mtime); | |
552 | |
553 | |
554 /** | |
555 Set the features as supported for the given conversation. | |
556 @param conv The conversation | |
557 @param features Bitset defining supported features | |
558 */ | |
559 void gaim_conversation_set_features(GaimConversation *conv, | |
560 GaimConnectionFlags features); | |
561 | |
562 | |
563 /** | |
564 Get the features supported by the given conversation. | |
565 @param conv The conversation | |
566 */ | |
11581 | 567 GaimConnectionFlags gaim_conversation_get_features(GaimConversation *conv); |
4359 | 568 |
569 /** | |
9260
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
570 * Determines if a conversation has focus |
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
571 * |
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
572 * @param conv The conversation. |
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
573 * |
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
574 * @return @c TRUE if the conversation has focus, @c FALSE if |
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
575 * it does not or the UI does not have a concept of conversation focus |
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
576 */ |
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
577 gboolean gaim_conversation_has_focus(GaimConversation *conv); |
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
578 |
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
579 /** |
4359 | 580 * Updates the visual status and UI of a conversation. |
581 * | |
582 * @param conv The conversation. | |
583 * @param type The update type. | |
584 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
585 void gaim_conversation_update(GaimConversation *conv, GaimConvUpdateType type); |
4359 | 586 |
587 /** | |
588 * Calls a function on each conversation. | |
589 * | |
590 * @param func The function. | |
591 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
592 void gaim_conversation_foreach(void (*func)(GaimConversation *conv)); |
4359 | 593 |
594 /*@}*/ | |
595 | |
596 | |
597 /**************************************************************************/ | |
598 /** @name IM Conversation API */ | |
599 /**************************************************************************/ | |
600 /*@{*/ | |
601 | |
602 /** | |
603 * Gets an IM's parent conversation. | |
604 * | |
605 * @param im The IM. | |
606 * | |
607 * @return The parent conversation. | |
608 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
609 GaimConversation *gaim_conv_im_get_conversation(const GaimConvIm *im); |
4359 | 610 |
611 /** | |
6846
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
612 * Sets the IM's buddy icon. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
613 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
614 * This should only be called from within Gaim. You probably want to |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
615 * call gaim_buddy_icon_set_data(). |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
616 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
617 * @param im The IM. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
618 * @param icon The buddy icon. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
619 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
620 * @see gaim_buddy_icon_set_data() |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
621 */ |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
622 void gaim_conv_im_set_icon(GaimConvIm *im, GaimBuddyIcon *icon); |
6846
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
623 |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
624 /** |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
625 * Returns the IM's buddy icon. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
626 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
627 * @param im The IM. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
628 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
629 * @return The buddy icon. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
630 */ |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
631 GaimBuddyIcon *gaim_conv_im_get_icon(const GaimConvIm *im); |
6846
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
632 |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
633 /** |
4359 | 634 * Sets the IM's typing state. |
635 * | |
636 * @param im The IM. | |
637 * @param state The typing state. | |
638 */ | |
8288
dde73afb3283
[gaim-migrate @ 9012]
Christian Hammond <chipx86@chipx86.com>
parents:
8256
diff
changeset
|
639 void gaim_conv_im_set_typing_state(GaimConvIm *im, GaimTypingState state); |
4359 | 640 |
641 /** | |
642 * Returns the IM's typing state. | |
643 * | |
644 * @param im The IM. | |
645 * | |
646 * @return The IM's typing state. | |
647 */ | |
8288
dde73afb3283
[gaim-migrate @ 9012]
Christian Hammond <chipx86@chipx86.com>
parents:
8256
diff
changeset
|
648 GaimTypingState gaim_conv_im_get_typing_state(const GaimConvIm *im); |
4359 | 649 |
650 /** | |
651 * Starts the IM's typing timeout. | |
652 * | |
653 * @param im The IM. | |
654 * @param timeout The timeout. | |
655 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
656 void gaim_conv_im_start_typing_timeout(GaimConvIm *im, int timeout); |
4359 | 657 |
658 /** | |
659 * Stops the IM's typing timeout. | |
660 * | |
661 * @param im The IM. | |
662 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
663 void gaim_conv_im_stop_typing_timeout(GaimConvIm *im); |
4359 | 664 |
665 /** | |
666 * Returns the IM's typing timeout. | |
667 * | |
668 * @param im The IM. | |
669 * | |
670 * @return The timeout. | |
671 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
672 guint gaim_conv_im_get_typing_timeout(const GaimConvIm *im); |
4359 | 673 |
674 /** | |
675 * Sets the IM's time until it should send another typing notification. | |
676 * | |
677 * @param im The IM. | |
678 * @param val The time. | |
679 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
680 void gaim_conv_im_set_type_again(GaimConvIm *im, time_t val); |
4359 | 681 |
682 /** | |
683 * Returns the IM's time until it should send another typing notification. | |
684 * | |
685 * @param im The IM. | |
686 * | |
687 * @return The time. | |
688 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
689 time_t gaim_conv_im_get_type_again(const GaimConvIm *im); |
4359 | 690 |
691 /** | |
692 * Starts the IM's type again timeout. | |
693 * | |
694 * @param im The IM. | |
695 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
696 void gaim_conv_im_start_type_again_timeout(GaimConvIm *im); |
4359 | 697 |
698 /** | |
699 * Stops the IM's type again timeout. | |
700 * | |
701 * @param im The IM. | |
702 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
703 void gaim_conv_im_stop_type_again_timeout(GaimConvIm *im); |
4359 | 704 |
705 /** | |
706 * Returns the IM's type again timeout interval. | |
707 * | |
708 * @param im The IM. | |
709 * | |
710 * @return The type again timeout interval. | |
711 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
712 guint gaim_conv_im_get_type_again_timeout(const GaimConvIm *im); |
4359 | 713 |
714 /** | |
715 * Updates the visual typing notification for an IM conversation. | |
716 * | |
717 * @param im The IM. | |
718 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
719 void gaim_conv_im_update_typing(GaimConvIm *im); |
4359 | 720 |
721 /** | |
722 * Writes to an IM. | |
723 * | |
724 * @param im The IM. | |
725 * @param who The user who sent the message. | |
726 * @param message The message to write. | |
6621 | 727 * @param flags The message flags. |
4359 | 728 * @param mtime The time the message was sent. |
729 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
730 void gaim_conv_im_write(GaimConvIm *im, const char *who, |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
731 const char *message, GaimMessageFlags flags, |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
732 time_t mtime); |
4359 | 733 |
734 /** | |
9627 | 735 * Presents an IM-error to the user |
11581 | 736 * |
9627 | 737 * This is a helper function to find a conversation, write an error to it, and |
738 * raise the window. If a conversation with this user doesn't already exist, | |
739 * the function will return FALSE and the calling function can attempt to present | |
740 * the error another way (gaim_notify_error, most likely) | |
741 * | |
742 * @param who The user this error is about | |
743 * @param account The account this error is on | |
744 * @param what The error | |
745 * @return TRUE if the error was presented, else FALSE | |
746 */ | |
747 gboolean gaim_conv_present_error(const char *who, GaimAccount *account, const char *what); | |
748 | |
749 /** | |
4359 | 750 * Sends a message to this IM conversation. |
751 * | |
752 * @param im The IM. | |
753 * @param message The message to send. | |
754 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
755 void gaim_conv_im_send(GaimConvIm *im, const char *message); |
4359 | 756 |
10526 | 757 /** |
11921 | 758 * Sends a message to this IM conversation with specified flags. |
759 * | |
760 * @param im The IM. | |
761 * @param message The message to send. | |
762 * @param flags The GaimMessageFlags flags to use in addition to GAIM_MESSAGE_SEND. | |
763 */ | |
764 void gaim_conv_im_send_with_flags(GaimConvIm *im, const char *message, GaimMessageFlags flags); | |
765 | |
766 /** | |
10528 | 767 * Adds a smiley to the conversation's smiley tree. If this returns |
768 * @c TRUE you should call gaim_conv_custom_smiley_write() one or more | |
769 * times, and then gaim_conv_custom_smiley_close(). If this returns | |
770 * @c FALSE, either the conv or smile were invalid, or the icon was | |
771 * found in the cache. In either case, calling write or close would | |
772 * be an error. | |
10526 | 773 * |
774 * @param conv The conversation to associate the smiley with. | |
775 * @param smile The text associated with the smiley | |
776 * @param cksum_type The type of checksum. | |
777 * @param chksum The checksum, as a NUL terminated base64 string. | |
12618
204bd8fac61f
[gaim-migrate @ 14954]
Richard Laager <rlaager@wiktel.com>
parents:
12463
diff
changeset
|
778 * @param remote @c TRUE if the custom smiley is set by the remote user (buddy). |
10528 | 779 * @return @c TRUE if an icon is expected, else FALSE. Note that |
10526 | 780 * it is an error to never call gaim_conv_custom_smiley_close if |
781 * this function returns @c TRUE, but an error to call it if | |
782 * @c FALSE is returned. | |
783 */ | |
784 | |
785 gboolean gaim_conv_custom_smiley_add(GaimConversation *conv, const char *smile, | |
12618
204bd8fac61f
[gaim-migrate @ 14954]
Richard Laager <rlaager@wiktel.com>
parents:
12463
diff
changeset
|
786 const char *cksum_type, const char *chksum, |
204bd8fac61f
[gaim-migrate @ 14954]
Richard Laager <rlaager@wiktel.com>
parents:
12463
diff
changeset
|
787 gboolean remote); |
10526 | 788 |
789 | |
790 /** | |
791 * Updates the image associated with the current smiley. | |
792 * | |
793 * @param conv The conversation associated with the smiley. | |
794 * @param smile The text associated with the smiley. | |
795 * @param data The actual image data. | |
796 * @param size The length of the data. | |
797 */ | |
798 | |
799 void gaim_conv_custom_smiley_write(GaimConversation *conv, | |
11137 | 800 const char *smile, |
801 const guchar *data, | |
802 gsize size); | |
10526 | 803 |
804 /** | |
805 * Close the custom smiley, all data has been written with | |
806 * gaim_conv_custom_smiley_write, and it is no longer valid | |
807 * to call that function on that smiley. | |
808 * | |
809 * @param conv The gaim conversation associated with the smiley. | |
810 * @param smile The text associated with the smiley | |
811 */ | |
812 | |
813 void gaim_conv_custom_smiley_close(GaimConversation *conv, const char *smile); | |
814 | |
4359 | 815 /*@}*/ |
816 | |
817 | |
818 /**************************************************************************/ | |
819 /** @name Chat Conversation API */ | |
820 /**************************************************************************/ | |
821 /*@{*/ | |
822 | |
823 /** | |
824 * Gets a chat's parent conversation. | |
825 * | |
826 * @param chat The chat. | |
827 * | |
828 * @return The parent conversation. | |
829 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
830 GaimConversation *gaim_conv_chat_get_conversation(const GaimConvChat *chat); |
4359 | 831 |
832 /** | |
833 * Sets the list of users in the chat room. | |
834 * | |
6407
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
835 * @note Calling this function will not update the display of the users. |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
836 * Please use gaim_conv_chat_add_user(), gaim_conv_chat_add_users(), |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
837 * gaim_conv_chat_remove_user(), and gaim_conv_chat_remove_users() instead. |
6407
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
838 * |
4359 | 839 * @param chat The chat. |
840 * @param users The list of users. | |
841 * | |
842 * @return The list passed. | |
843 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
844 GList *gaim_conv_chat_set_users(GaimConvChat *chat, GList *users); |
4359 | 845 |
846 /** | |
847 * Returns a list of users in the chat room. | |
848 * | |
849 * @param chat The chat. | |
850 * | |
851 * @return The list of users. | |
852 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
853 GList *gaim_conv_chat_get_users(const GaimConvChat *chat); |
4359 | 854 |
855 /** | |
856 * Ignores a user in a chat room. | |
857 * | |
858 * @param chat The chat. | |
859 * @param name The name of the user. | |
860 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
861 void gaim_conv_chat_ignore(GaimConvChat *chat, const char *name); |
4359 | 862 |
863 /** | |
864 * Unignores a user in a chat room. | |
865 * | |
866 * @param chat The chat. | |
867 * @param name The name of the user. | |
868 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
869 void gaim_conv_chat_unignore(GaimConvChat *chat, const char *name); |
4359 | 870 |
871 /** | |
872 * Sets the list of ignored users in the chat room. | |
873 * | |
874 * @param chat The chat. | |
875 * @param ignored The list of ignored users. | |
876 * | |
877 * @return The list passed. | |
878 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
879 GList *gaim_conv_chat_set_ignored(GaimConvChat *chat, GList *ignored); |
4359 | 880 |
881 /** | |
882 * Returns the list of ignored users in the chat room. | |
883 * | |
884 * @param chat The chat. | |
885 * | |
886 * @return The list of ignored users. | |
887 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
888 GList *gaim_conv_chat_get_ignored(const GaimConvChat *chat); |
4359 | 889 |
890 /** | |
891 * Returns the actual name of the specified ignored user, if it exists in | |
892 * the ignore list. | |
893 * | |
894 * If the user found contains a prefix, such as '+' or '\@', this is also | |
895 * returned. The username passed to the function does not have to have this | |
896 * formatting. | |
897 * | |
898 * @param chat The chat. | |
899 * @param user The user to check in the ignore list. | |
900 * | |
901 * @return The ignored user if found, complete with prefixes, or @c NULL | |
902 * if not found. | |
903 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
904 const char *gaim_conv_chat_get_ignored_user(const GaimConvChat *chat, |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
905 const char *user); |
4359 | 906 |
907 /** | |
908 * Returns @c TRUE if the specified user is ignored. | |
909 * | |
910 * @param chat The chat. | |
911 * @param user The user. | |
912 * | |
913 * @return @c TRUE if the user is in the ignore list; @c FALSE otherwise. | |
914 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
915 gboolean gaim_conv_chat_is_user_ignored(const GaimConvChat *chat, |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
916 const char *user); |
4359 | 917 |
918 /** | |
919 * Sets the chat room's topic. | |
920 * | |
921 * @param chat The chat. | |
922 * @param who The user that set the topic. | |
923 * @param topic The topic. | |
924 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
925 void gaim_conv_chat_set_topic(GaimConvChat *chat, const char *who, |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
926 const char *topic); |
4359 | 927 |
928 /** | |
929 * Returns the chat room's topic. | |
930 * | |
931 * @param chat The chat. | |
932 * | |
933 * @return The chat's topic. | |
934 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
935 const char *gaim_conv_chat_get_topic(const GaimConvChat *chat); |
4359 | 936 |
937 /** | |
938 * Sets the chat room's ID. | |
939 * | |
940 * @param chat The chat. | |
941 * @param id The ID. | |
942 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
943 void gaim_conv_chat_set_id(GaimConvChat *chat, int id); |
4359 | 944 |
945 /** | |
946 * Returns the chat room's ID. | |
947 * | |
948 * @param chat The chat. | |
949 * | |
950 * @return The ID. | |
951 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
952 int gaim_conv_chat_get_id(const GaimConvChat *chat); |
4359 | 953 |
954 /** | |
955 * Writes to a chat. | |
956 * | |
957 * @param chat The chat. | |
958 * @param who The user who sent the message. | |
959 * @param message The message to write. | |
6621 | 960 * @param flags The flags. |
4359 | 961 * @param mtime The time the message was sent. |
962 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
963 void gaim_conv_chat_write(GaimConvChat *chat, const char *who, |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
964 const char *message, GaimMessageFlags flags, |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
965 time_t mtime); |
4359 | 966 |
967 /** | |
968 * Sends a message to this chat conversation. | |
969 * | |
970 * @param chat The chat. | |
971 * @param message The message to send. | |
972 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
973 void gaim_conv_chat_send(GaimConvChat *chat, const char *message); |
4359 | 974 |
975 /** | |
11921 | 976 * Sends a message to this chat conversation with specified flags. |
977 * | |
978 * @param chat The chat. | |
979 * @param message The message to send. | |
980 * @param flags The GaimMessageFlags flags to use. | |
981 */ | |
982 void gaim_conv_chat_send_with_flags(GaimConvChat *chat, const char *message, GaimMessageFlags flags); | |
983 | |
984 /** | |
4359 | 985 * Adds a user to a chat. |
986 * | |
9939 | 987 * @param chat The chat. |
988 * @param user The user to add. | |
989 * @param extra_msg An extra message to display with the join message. | |
990 * @param flags The users flags | |
991 * @param new_arrival Decides whether or not to show a join notice. | |
4359 | 992 */ |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
993 void gaim_conv_chat_add_user(GaimConvChat *chat, const char *user, |
9846 | 994 const char *extra_msg, GaimConvChatBuddyFlags flags, |
995 gboolean new_arrival); | |
4359 | 996 |
997 /** | |
6407
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
998 * Adds a list of users to a chat. |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
999 * |
11454
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11338
diff
changeset
|
1000 * The data is copied from @a users, @a extra_msgs, and @a flags, so it is up to |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11338
diff
changeset
|
1001 * the caller to free this list after calling this function. |
6407
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1002 * |
11454
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11338
diff
changeset
|
1003 * @param chat The chat. |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11338
diff
changeset
|
1004 * @param users The list of users to add. |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11338
diff
changeset
|
1005 * @param extra_msgs An extra message to display with the join message for each |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11338
diff
changeset
|
1006 * user. This list may be shorter than @a users, in which |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11338
diff
changeset
|
1007 * case, the users after the end of extra_msgs will not have |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11338
diff
changeset
|
1008 * an extra message. By extension, this means that extra_msgs |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11338
diff
changeset
|
1009 * can simply be @c NULL and none of the users will have an |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11338
diff
changeset
|
1010 * extra message. |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11338
diff
changeset
|
1011 * @param flags The list of flags for each user. |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11338
diff
changeset
|
1012 * @param new_arrivals Decides whether or not to show join notices. |
6407
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1013 */ |
11454
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11338
diff
changeset
|
1014 void gaim_conv_chat_add_users(GaimConvChat *chat, GList *users, GList *extra_msgs, |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11338
diff
changeset
|
1015 GList *flags, gboolean new_arrivals); |
6407
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1016 |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1017 /** |
4359 | 1018 * Renames a user in a chat. |
1019 * | |
1020 * @param chat The chat. | |
1021 * @param old_user The old username. | |
1022 * @param new_user The new username. | |
1023 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1024 void gaim_conv_chat_rename_user(GaimConvChat *chat, const char *old_user, |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1025 const char *new_user); |
4359 | 1026 |
1027 /** | |
1028 * Removes a user from a chat, optionally with a reason. | |
1029 * | |
6407
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1030 * 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
|
1031 * |
4359 | 1032 * @param chat The chat. |
1033 * @param user The user that is being removed. | |
1034 * @param reason The optional reason given for the removal. Can be @c NULL. | |
1035 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1036 void gaim_conv_chat_remove_user(GaimConvChat *chat, const char *user, |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1037 const char *reason); |
4359 | 1038 |
1039 /** | |
6407
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1040 * 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
|
1041 * |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1042 * @param chat The chat. |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1043 * @param users The users that are being removed. |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1044 * @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
|
1045 */ |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1046 void gaim_conv_chat_remove_users(GaimConvChat *chat, GList *users, |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1047 const char *reason); |
6407
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1048 |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1049 /** |
9554 | 1050 * Finds a user in a chat |
1051 * | |
1052 * @param chat The chat. | |
1053 * @param user The user to look for. | |
1054 * | |
1055 * @return TRUE if the user is in the chat, FALSE if not | |
1056 */ | |
1057 gboolean gaim_conv_chat_find_user(GaimConvChat *chat, const char *user); | |
1058 | |
1059 /** | |
1060 * Set a users flags in a chat | |
1061 * | |
1062 * @param chat The chat. | |
1063 * @param user The user to update. | |
1064 * @param flags The new flags. | |
1065 */ | |
1066 void gaim_conv_chat_user_set_flags(GaimConvChat *chat, const char *user, | |
1067 GaimConvChatBuddyFlags flags); | |
1068 | |
1069 /** | |
1070 * Get the flags for a user in a chat | |
1071 * | |
1072 * @param chat The chat. | |
1073 * @param user The user to find the flags for | |
1074 * | |
1075 * @return The flags for the user | |
1076 */ | |
1077 GaimConvChatBuddyFlags gaim_conv_chat_user_get_flags(GaimConvChat *chat, | |
1078 const char *user); | |
1079 | |
1080 /** | |
6414
874a5c9f4eb8
[gaim-migrate @ 6921]
Christian Hammond <chipx86@chipx86.com>
parents:
6407
diff
changeset
|
1081 * Clears all users from a chat. |
874a5c9f4eb8
[gaim-migrate @ 6921]
Christian Hammond <chipx86@chipx86.com>
parents:
6407
diff
changeset
|
1082 * |
874a5c9f4eb8
[gaim-migrate @ 6921]
Christian Hammond <chipx86@chipx86.com>
parents:
6407
diff
changeset
|
1083 * @param chat The chat. |
874a5c9f4eb8
[gaim-migrate @ 6921]
Christian Hammond <chipx86@chipx86.com>
parents:
6407
diff
changeset
|
1084 */ |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1085 void gaim_conv_chat_clear_users(GaimConvChat *chat); |
6414
874a5c9f4eb8
[gaim-migrate @ 6921]
Christian Hammond <chipx86@chipx86.com>
parents:
6407
diff
changeset
|
1086 |
874a5c9f4eb8
[gaim-migrate @ 6921]
Christian Hammond <chipx86@chipx86.com>
parents:
6407
diff
changeset
|
1087 /** |
8158 | 1088 * Sets your nickname (used for hilighting) for a chat. |
1089 * | |
1090 * @param chat The chat. | |
1091 * @param nick The nick. | |
1092 */ | |
1093 void gaim_conv_chat_set_nick(GaimConvChat *chat, const char *nick); | |
1094 | |
1095 /** | |
1096 * Gets your nickname (used for hilighting) for a chat. | |
1097 * | |
1098 * @param chat The chat. | |
1099 * @return The nick. | |
1100 */ | |
1101 const char *gaim_conv_chat_get_nick(GaimConvChat *chat); | |
1102 | |
1103 /** | |
4359 | 1104 * Finds a chat with the specified chat ID. |
1105 * | |
1106 * @param gc The gaim_connection. | |
1107 * @param id The chat ID. | |
1108 * | |
1109 * @return The chat conversation. | |
1110 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1111 GaimConversation *gaim_find_chat(const GaimConnection *gc, int id); |
4359 | 1112 |
8256
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1113 /** |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1114 * Lets the core know we left a chat, without destroying it. |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1115 * Called from serv_got_chat_left(). |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1116 * |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1117 * @param chat The chat. |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1118 */ |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1119 void gaim_conv_chat_left(GaimConvChat *chat); |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1120 |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1121 /** |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1122 * Returns true if we're no longer in this chat, |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1123 * and just left the window open. |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1124 * |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1125 * @param chat The chat. |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1126 * |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1127 * @return @c TRUE if we left the chat already, @c FALSE if |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1128 * we're still there. |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1129 */ |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1130 gboolean gaim_conv_chat_has_left(GaimConvChat *chat); |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1131 |
9554 | 1132 /** |
1133 * Creates a new chat buddy | |
1134 * | |
1135 * @param name The name. | |
1136 * @param flags The flags. | |
1137 * | |
1138 * @return The new chat buddy | |
1139 */ | |
1140 GaimConvChatBuddy *gaim_conv_chat_cb_new(const char *name, | |
1141 GaimConvChatBuddyFlags flags); | |
1142 | |
1143 /** | |
1144 * Find a chat buddy in a chat | |
1145 * | |
1146 * @param chat The chat. | |
1147 * @param name The name of the chat buddy to find. | |
1148 */ | |
1149 GaimConvChatBuddy *gaim_conv_chat_cb_find(GaimConvChat *chat, const char *name); | |
1150 | |
1151 /** | |
1152 * Get the name of a chat buddy | |
1153 * | |
1154 * @param cb The chat buddy. | |
1155 * | |
1156 * @return The name of the chat buddy. | |
1157 */ | |
1158 const char *gaim_conv_chat_cb_get_name(GaimConvChatBuddy *cb); | |
1159 | |
1160 /** | |
1161 * Destroys a chat buddy | |
1162 * | |
1163 * @param cb The chat buddy to destroy | |
1164 */ | |
1165 void gaim_conv_chat_cb_destroy(GaimConvChatBuddy *cb); | |
1166 | |
4359 | 1167 /*@}*/ |
1168 | |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1169 /**************************************************************************/ |
6485
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1170 /** @name Conversations Subsystem */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1171 /**************************************************************************/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1172 /*@{*/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1173 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1174 /** |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1175 * Returns the conversation subsystem handle. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1176 * |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1177 * @return The conversation subsystem handle. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1178 */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1179 void *gaim_conversations_get_handle(void); |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1180 |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
1181 /** |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
1182 * Initializes the conversation subsystem. |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
1183 */ |
6485
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1184 void gaim_conversations_init(void); |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1185 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1186 /** |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1187 * Uninitializes the conversation subsystem. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1188 */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1189 void gaim_conversations_uninit(void); |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
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 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
1193 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
1194 } |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
1195 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
1196 |
4890
89cb14edf8cf
[gaim-migrate @ 5220]
Christian Hammond <chipx86@chipx86.com>
parents:
4877
diff
changeset
|
1197 #endif /* _GAIM_CONVERSATION_H_ */ |