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