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