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