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