Mercurial > pidgin
annotate src/conversation.h @ 11531:bf763a1b2454
[gaim-migrate @ 13780]
(13:57:11) rlaager: LSchiere2: Should we just change gaim_notify_userinfo
to take a screenname and eliminate all the duplication of "Buddy
Information" and "Info for %s"?
(13:57:18) LSchiere2: sounds good
This breaks perl, I could not figure out how to fix that.
committer: Tailor Script <tailor@pidgin.im>
author | Luke Schierer <lschiere@pidgin.im> |
---|---|
date | Mon, 12 Sep 2005 18:46:15 +0000 |
parents | 16b0da1f376f |
children | 9b3833da6840 |
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 | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
34 typedef struct _GaimConvWindowUiOps GaimConvWindowUiOps; |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
35 typedef struct _GaimConvWindow GaimConvWindow; |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
36 typedef struct _GaimConversationUiOps GaimConversationUiOps; |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
37 typedef struct _GaimConversation GaimConversation; |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
38 typedef struct _GaimConvIm GaimConvIm; |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
39 typedef struct _GaimConvChat GaimConvChat; |
9554 | 40 typedef struct _GaimConvChatBuddy GaimConvChatBuddy; |
4359 | 41 |
42 /** | |
43 * A type of conversation. | |
44 */ | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
45 typedef enum |
4359 | 46 { |
11338 | 47 GAIM_CONV_TYPE_UNKNOWN = 0, /**< Unknown conversation type. */ |
48 GAIM_CONV_TYPE_IM, /**< Instant Message. */ | |
49 GAIM_CONV_TYPE_CHAT, /**< Chat room. */ | |
50 GAIM_CONV_TYPE_MISC, /**< A misc. conversation. */ | |
51 GAIM_CONV_TYPE_ANY /**< Any type of conversation. */ | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
52 |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
53 } GaimConversationType; |
4359 | 54 |
55 /** | |
56 * Unseen text states. | |
57 */ | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
58 typedef enum |
4359 | 59 { |
60 GAIM_UNSEEN_NONE = 0, /**< No unseen text in the conversation. */ | |
61 GAIM_UNSEEN_TEXT, /**< Unseen text in the conversation. */ | |
6405
96de6d9eb422
[gaim-migrate @ 6910]
Christian Hammond <chipx86@chipx86.com>
parents:
6311
diff
changeset
|
62 GAIM_UNSEEN_NICK, /**< Unseen text and the nick was said. */ |
96de6d9eb422
[gaim-migrate @ 6910]
Christian Hammond <chipx86@chipx86.com>
parents:
6311
diff
changeset
|
63 GAIM_UNSEEN_EVENT /**< Unseen events in the conversation. */ |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
64 |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
65 } GaimUnseenState; |
4359 | 66 |
67 /** | |
68 * Conversation update type. | |
69 */ | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
70 typedef enum |
4359 | 71 { |
72 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
|
73 was added. */ |
4359 | 74 GAIM_CONV_UPDATE_REMOVE, /**< The buddy associated with the conversation |
8155
77d1252b3803
[gaim-migrate @ 8867]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
75 was removed. */ |
4491 | 76 GAIM_CONV_UPDATE_ACCOUNT, /**< The gaim_account was changed. */ |
4359 | 77 GAIM_CONV_UPDATE_TYPING, /**< The typing state was updated. */ |
78 GAIM_CONV_UPDATE_UNSEEN, /**< The unseen state was updated. */ | |
79 GAIM_CONV_UPDATE_LOGGING, /**< Logging for this conversation was | |
8155
77d1252b3803
[gaim-migrate @ 8867]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
80 enabled or disabled. */ |
4359 | 81 GAIM_CONV_UPDATE_TOPIC, /**< The topic for a chat was updated. */ |
82 /* | |
83 * XXX These need to go when we implement a more generic core/UI event | |
84 * system. | |
85 */ | |
4378
194507c83612
[gaim-migrate @ 4644]
Christian Hammond <chipx86@chipx86.com>
parents:
4359
diff
changeset
|
86 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
|
87 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
|
88 GAIM_CONV_UPDATE_AWAY, /**< The other user went away. */ |
8155
77d1252b3803
[gaim-migrate @ 8867]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
89 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
|
90 GAIM_CONV_UPDATE_TITLE, |
10665 | 91 GAIM_CONV_UPDATE_CHATLEFT, |
92 | |
93 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
|
94 |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
95 } GaimConvUpdateType; |
4359 | 96 |
97 /** | |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
98 * The typing state of a user. |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
99 */ |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
100 typedef enum |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
101 { |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
102 GAIM_NOT_TYPING = 0, /**< Not typing. */ |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
103 GAIM_TYPING, /**< Currently typing. */ |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
104 GAIM_TYPED /**< Stopped typing momentarily. */ |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
105 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
106 } GaimTypingState; |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
107 |
6621 | 108 /** |
109 * Flags applicable to a message. Most will have send, recv or system. | |
110 */ | |
111 typedef enum | |
112 { | |
6982 | 113 GAIM_MESSAGE_SEND = 0x0001, /**< Outgoing message. */ |
114 GAIM_MESSAGE_RECV = 0x0002, /**< Incoming message. */ | |
115 GAIM_MESSAGE_SYSTEM = 0x0004, /**< System message. */ | |
116 GAIM_MESSAGE_AUTO_RESP = 0x0008, /**< Auto response. */ | |
117 GAIM_MESSAGE_COLORIZE = 0x0010, /**< Colorize nicks. */ | |
118 GAIM_MESSAGE_NICK = 0x0020, /**< Contains your nick. */ | |
119 GAIM_MESSAGE_NO_LOG = 0x0040, /**< Do not log. */ | |
120 GAIM_MESSAGE_WHISPER = 0x0080, /**< Whispered message. */ | |
9584 | 121 GAIM_MESSAGE_ERROR = 0x0200, /**< Error message. */ |
10346 | 122 GAIM_MESSAGE_DELAYED = 0x0400, /**< Delayed message. */ |
123 GAIM_MESSAGE_RAW = 0x0800 /**< "Raw" message - don't apply formatting */ | |
10008 | 124 |
6621 | 125 } GaimMessageFlags; |
126 | |
9554 | 127 /** |
128 * Flags applicable to users in Chats. | |
129 */ | |
130 typedef enum | |
131 { | |
132 GAIM_CBFLAGS_NONE = 0x0000, /**< No flags */ | |
133 GAIM_CBFLAGS_VOICE = 0x0001, /**< Voiced user or "Participant" */ | |
134 GAIM_CBFLAGS_HALFOP = 0x0002, /**< Half-op */ | |
135 GAIM_CBFLAGS_OP = 0x0004, /**< Channel Op or Moderator */ | |
10665 | 136 GAIM_CBFLAGS_FOUNDER = 0x0008, /**< Channel Founder */ |
137 GAIM_CBFLAGS_TYPING = 0x0010, /**< Currently typing */ | |
138 | |
10008 | 139 |
9554 | 140 } GaimConvChatBuddyFlags; |
141 | |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
142 #include "account.h" |
9718 | 143 #include "buddyicon.h" |
7431 | 144 #include "log.h" |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
145 #include "server.h" |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
146 |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
147 /** |
4359 | 148 * Conversation window operations. |
149 * | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
150 * Any UI representing a window must assign a filled-out gaim_conv_window_ops |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
151 * structure to the GaimConvWindow. |
4359 | 152 */ |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
153 struct _GaimConvWindowUiOps |
4359 | 154 { |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
155 GaimConversationUiOps *(*get_conversation_ui_ops)(void); |
4359 | 156 |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
157 void (*new_window)(GaimConvWindow *win); |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
158 void (*destroy_window)(GaimConvWindow *win); |
4359 | 159 |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
160 void (*show)(GaimConvWindow *win); |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
161 void (*hide)(GaimConvWindow *win); |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
162 void (*raise)(GaimConvWindow *win); |
4359 | 163 |
10827 | 164 void (*switch_conversation)(GaimConvWindow *win, GaimConversation *conv); |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
165 void (*add_conversation)(GaimConvWindow *win, GaimConversation *conv); |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
166 void (*remove_conversation)(GaimConvWindow *win, GaimConversation *conv); |
10665 | 167 |
10827 | 168 GaimConversation *(*get_active_conversation)(const GaimConvWindow *win); |
9260
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
169 gboolean (*has_focus)(GaimConvWindow *win); |
4359 | 170 }; |
171 | |
172 /** | |
173 * Conversation operations and events. | |
174 * | |
175 * Any UI representing a conversation must assign a filled-out | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
176 * GaimConversationUiOps structure to the GaimConversation. |
4359 | 177 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
178 struct _GaimConversationUiOps |
4359 | 179 { |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
180 void (*destroy_conversation)(GaimConversation *conv); |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
181 void (*write_chat)(GaimConversation *conv, const char *who, |
8155
77d1252b3803
[gaim-migrate @ 8867]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
182 const char *message, GaimMessageFlags flags, |
77d1252b3803
[gaim-migrate @ 8867]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
183 time_t mtime); |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
184 void (*write_im)(GaimConversation *conv, const char *who, |
8155
77d1252b3803
[gaim-migrate @ 8867]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
185 const char *message, GaimMessageFlags flags, |
77d1252b3803
[gaim-migrate @ 8867]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
186 time_t mtime); |
11454
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11338
diff
changeset
|
187 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
|
188 const char *message, GaimMessageFlags flags, |
77d1252b3803
[gaim-migrate @ 8867]
Christian Hammond <chipx86@chipx86.com>
parents:
8046
diff
changeset
|
189 time_t mtime); |
4359 | 190 |
11454
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11338
diff
changeset
|
191 void (*chat_add_users)(GaimConversation *conv, GList *users, GList *aliases); |
11485
16b0da1f376f
[gaim-migrate @ 13727]
Richard Laager <rlaager@wiktel.com>
parents:
11454
diff
changeset
|
192 void (*chat_rename_user)(GaimConversation *conv, const char *old_name, |
16b0da1f376f
[gaim-migrate @ 13727]
Richard Laager <rlaager@wiktel.com>
parents:
11454
diff
changeset
|
193 const char *new_name, const char *new_alias); |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
194 void (*chat_remove_user)(GaimConversation *conv, const char *user); |
6407
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
195 void (*chat_remove_users)(GaimConversation *conv, GList *users); |
9554 | 196 void (*chat_update_user)(GaimConversation *conv, const char *user); |
4359 | 197 |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
198 void (*update_progress)(GaimConversation *conv, float percent); |
4359 | 199 |
9260
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
200 gboolean (*has_focus)(GaimConversation *conv); |
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
201 |
10526 | 202 /* Custom Smileys */ |
203 gboolean (*custom_smiley_add)(GaimConversation *conv, const char *smile); | |
204 void (*custom_smiley_write)(GaimConversation *conv, const char *smile, | |
11137 | 205 const guchar *data, gsize size); |
10526 | 206 void (*custom_smiley_close)(GaimConversation *conv, const char *smile); |
207 | |
4359 | 208 /* Events */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
209 void (*updated)(GaimConversation *conv, GaimConvUpdateType type); |
9260
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
210 |
4359 | 211 }; |
212 | |
213 /** | |
214 * A core representation of a graphical window containing one or more | |
215 * conversations. | |
216 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
217 struct _GaimConvWindow |
4359 | 218 { |
4465
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
219 GList *conversations; /**< The conversations in the window. */ |
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
220 size_t conversation_count; /**< The number of conversations. */ |
4359 | 221 |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
222 GaimConvWindowUiOps *ui_ops; /**< UI-specific window operations. */ |
4465
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
223 void *ui_data; /**< UI-specific data. */ |
4359 | 224 }; |
225 | |
226 /** | |
227 * Data specific to Instant Messages. | |
228 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
229 struct _GaimConvIm |
4359 | 230 { |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
231 GaimConversation *conv; /**< The parent conversation. */ |
4359 | 232 |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
233 GaimTypingState typing_state; /**< The current typing state. */ |
4465
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
234 guint typing_timeout; /**< The typing timer handle. */ |
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
235 time_t type_again; /**< The type again time. */ |
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
236 guint type_again_timeout; /**< The type again timer handle. */ |
4359 | 237 |
6846
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
238 GaimBuddyIcon *icon; /**< The buddy icon. */ |
4359 | 239 }; |
240 | |
241 /** | |
242 * Data specific to Chats. | |
243 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
244 struct _GaimConvChat |
4359 | 245 { |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
246 GaimConversation *conv; /**< The parent conversation. */ |
4359 | 247 |
4465
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
248 GList *in_room; /**< The users in the room. */ |
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
249 GList *ignored; /**< Ignored users. */ |
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
250 char *who; /**< The person who set the topic. */ |
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
251 char *topic; /**< The topic. */ |
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
252 int id; /**< The chat ID. */ |
8158 | 253 char *nick; /**< Your nick in this chat. */ |
8256
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
254 |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
255 gboolean left; /**< We left the chat and kept the window open */ |
4359 | 256 }; |
257 | |
258 /** | |
9554 | 259 * Data for "Chat Buddies" |
260 */ | |
261 struct _GaimConvChatBuddy | |
262 { | |
263 char *name; /**< The name */ | |
264 GaimConvChatBuddyFlags flags; /**< Flags (ops, voice etc.) */ | |
265 }; | |
266 | |
267 /** | |
4359 | 268 * A core representation of a conversation between two or more people. |
269 * | |
270 * The conversation can be an IM or a chat. Each conversation is kept | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
271 * in a GaimConvWindow and has a UI representation. |
4359 | 272 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
273 struct _GaimConversation |
4359 | 274 { |
275 GaimConversationType type; /**< The type of conversation. */ | |
276 | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
277 GaimAccount *account; /**< The user using this conversation. */ |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
278 GaimConvWindow *window; /**< The parent window. */ |
4359 | 279 |
280 int conversation_pos; /**< The position in the window's list. */ | |
281 | |
282 char *name; /**< The name of the conversation. */ | |
283 char *title; /**< The window title. */ | |
284 | |
285 gboolean logging; /**< The status of logging. */ | |
8158 | 286 |
11454
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11338
diff
changeset
|
287 GList *logs; /**< This conversation's logs */ |
8158 | 288 |
4359 | 289 GList *send_history; /**< The send history. */ |
290 | |
291 GaimUnseenState unseen; /**< The unseen tab state. */ | |
292 | |
293 union | |
294 { | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
295 GaimConvIm *im; /**< IM-specific data. */ |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
296 GaimConvChat *chat; /**< Chat-specific data. */ |
4378
194507c83612
[gaim-migrate @ 4644]
Christian Hammond <chipx86@chipx86.com>
parents:
4359
diff
changeset
|
297 void *misc; /**< Misc. data. */ |
4359 | 298 |
299 } u; | |
4465
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
300 |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
301 GaimConversationUiOps *ui_ops; /**< UI-specific operations. */ |
4465
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
302 void *ui_data; /**< UI-specific data. */ |
4876
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
303 |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
304 GHashTable *data; /**< Plugin-specific data. */ |
10849 | 305 |
10665 | 306 GaimConnectionFlags features; /**< The supported features */ |
307 | |
4359 | 308 }; |
309 | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
310 typedef void (*GaimConvPlacementFunc)(GaimConversation *); |
4359 | 311 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
312 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
313 extern "C" { |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
314 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
315 |
4359 | 316 /**************************************************************************/ |
317 /** @name Conversation Window API */ | |
318 /**************************************************************************/ | |
319 /*@{*/ | |
320 | |
321 /** | |
322 * Creates a new conversation window. | |
323 * | |
324 * This window is added to the list of windows, but is not shown until | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
325 * gaim_conv_window_show() is called. |
4359 | 326 * |
327 * @return The new conversation window. | |
328 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
329 GaimConvWindow *gaim_conv_window_new(void); |
4359 | 330 |
331 /** | |
332 * Destroys the specified conversation window and all conversations in it. | |
333 * | |
334 * @param win The window to destroy. | |
335 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
336 void gaim_conv_window_destroy(GaimConvWindow *win); |
4359 | 337 |
338 /** | |
339 * Shows the specified conversation window. | |
340 * | |
341 * @param win The window. | |
342 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
343 void gaim_conv_window_show(GaimConvWindow *win); |
4359 | 344 |
345 /** | |
346 * Hides the specified conversation window. | |
347 * | |
348 * @param win The window. | |
349 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
350 void gaim_conv_window_hide(GaimConvWindow *win); |
4359 | 351 |
352 /** | |
353 * Raises the specified conversation window. | |
354 * | |
355 * @param win The window. | |
356 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
357 void gaim_conv_window_raise(GaimConvWindow *win); |
4359 | 358 |
359 /** | |
360 * Sets the specified window's UI window operations structure. | |
361 * | |
362 * @param win The window. | |
363 * @param ops The UI window operations structure. | |
364 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
365 void gaim_conv_window_set_ui_ops(GaimConvWindow *win, |
10827 | 366 GaimConvWindowUiOps *ops); |
4359 | 367 |
368 /** | |
369 * Returns the specified window's UI window operations structure. | |
370 * | |
371 * @param win The window. | |
372 * | |
373 * @return The UI window operations structure. | |
374 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
375 GaimConvWindowUiOps *gaim_conv_window_get_ui_ops(const GaimConvWindow *win); |
4359 | 376 |
377 /** | |
378 * Adds a conversation to this window. | |
379 * | |
380 * If the conversation already has a parent window, this will do nothing. | |
381 * | |
382 * @param win The window. | |
383 * @param conv The conversation. | |
384 * | |
385 * @return The new index of the conversation in the window. | |
386 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
387 int gaim_conv_window_add_conversation(GaimConvWindow *win, |
10827 | 388 GaimConversation *conv); |
4359 | 389 |
390 /** | |
10824 | 391 * Removes the conversation from the window. |
4359 | 392 * |
393 * @param win The window. | |
10824 | 394 * @param conv The conversation. |
4359 | 395 * |
396 * @return The conversation removed. | |
397 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
398 GaimConversation *gaim_conv_window_remove_conversation(GaimConvWindow *win, |
10824 | 399 GaimConversation *conv); |
4359 | 400 /** |
401 * Returns the number of conversations in the window. | |
402 * | |
403 * @param win The window. | |
404 * | |
405 * @return The number of conversations. | |
406 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
407 size_t gaim_conv_window_get_conversation_count(const GaimConvWindow *win); |
4359 | 408 |
409 /** | |
410 * Switches the active conversation to the one at the specified index. | |
411 * | |
11035
11e465b55fe6
[gaim-migrate @ 12922]
Gary Kramlich <grim@reaperworld.com>
parents:
11003
diff
changeset
|
412 * @param win The window. |
11e465b55fe6
[gaim-migrate @ 12922]
Gary Kramlich <grim@reaperworld.com>
parents:
11003
diff
changeset
|
413 * @param conv The converstion to switch to. |
4359 | 414 */ |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
415 void gaim_conv_window_switch_conversation(GaimConvWindow *win, |
10827 | 416 GaimConversation *conv); |
4359 | 417 |
418 /** | |
419 * Returns the active conversation in the window. | |
420 * | |
421 * @param win The window. | |
422 * | |
423 * @return The active conversation. | |
424 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
425 GaimConversation *gaim_conv_window_get_active_conversation( |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
426 const GaimConvWindow *win); |
4359 | 427 |
428 /** | |
9260
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
429 * Determines if a conversation window has focus |
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
430 * |
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
431 * @param win The window. |
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
432 * |
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
433 * @return @c TRUE if the conversation window has focus, @c FALSE if |
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
434 * it does not or the UI does not have a concept of window focus |
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
435 */ |
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
436 gboolean gaim_conv_window_has_focus(GaimConvWindow *win); |
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
437 |
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
438 /** |
4359 | 439 * Returns the list of conversations in the specified window. |
440 * | |
441 * @param win The window. | |
442 * | |
443 * @return The list of conversations. | |
444 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
445 GList *gaim_conv_window_get_conversations(const GaimConvWindow *win); |
4359 | 446 |
447 /** | |
448 * Returns a list of all windows. | |
449 * | |
450 * @return A list of windows. | |
451 */ | |
452 GList *gaim_get_windows(void); | |
453 | |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
454 /** |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
455 * Returns the first window containing a conversation of the specified type. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
456 * |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
457 * @param type The conversation type. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
458 * |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
459 * @return The window if found, or @c NULL if not found. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
460 */ |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
461 GaimConvWindow *gaim_get_first_window_with_type(GaimConversationType type); |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
462 /** |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
463 * Returns the last window containing a conversation of the specified type. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
464 * |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
465 * @param type The conversation type. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
466 * |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
467 * @return The window if found, or @c NULL if not found. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
468 */ |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
469 GaimConvWindow *gaim_get_last_window_with_type(GaimConversationType type); |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
470 |
4359 | 471 /*@}*/ |
472 | |
473 /**************************************************************************/ | |
474 /** @name Conversation API */ | |
475 /**************************************************************************/ | |
476 /*@{*/ | |
477 | |
478 /** | |
479 * Creates a new conversation of the specified type. | |
480 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6622
diff
changeset
|
481 * @param type The type of conversation. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6622
diff
changeset
|
482 * @param account The account opening the conversation window on the gaim |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6622
diff
changeset
|
483 * user's end. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6622
diff
changeset
|
484 * @param name The name of the conversation. |
4359 | 485 * |
486 * @return The new conversation. | |
487 */ | |
6585
f30579b25253
[gaim-migrate @ 7107]
Christian Hammond <chipx86@chipx86.com>
parents:
6488
diff
changeset
|
488 GaimConversation *gaim_conversation_new(GaimConversationType type, |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
489 GaimAccount *account, |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
490 const char *name); |
4359 | 491 |
492 /** | |
493 * Destroys the specified conversation and removes it from the parent | |
494 * window. | |
495 * | |
496 * If this conversation is the only one contained in the parent window, | |
497 * that window is also destroyed. | |
498 * | |
499 * @param conv The conversation to destroy. | |
500 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
501 void gaim_conversation_destroy(GaimConversation *conv); |
4359 | 502 |
503 /** | |
504 * Returns the specified conversation's type. | |
505 * | |
506 * @param conv The conversation. | |
507 * | |
508 * @return The conversation's type. | |
509 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
510 GaimConversationType gaim_conversation_get_type(const GaimConversation *conv); |
4359 | 511 |
512 /** | |
513 * Sets the specified conversation's UI operations structure. | |
514 * | |
515 * @param conv The conversation. | |
516 * @param ops The UI conversation operations structure. | |
517 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
518 void gaim_conversation_set_ui_ops(GaimConversation *conv, |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
519 GaimConversationUiOps *ops); |
4359 | 520 |
521 /** | |
522 * Returns the specified conversation's UI operations structure. | |
6585
f30579b25253
[gaim-migrate @ 7107]
Christian Hammond <chipx86@chipx86.com>
parents:
6488
diff
changeset
|
523 * |
4359 | 524 * @param conv The conversation. |
525 * | |
526 * @return The operations structure. | |
527 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
528 GaimConversationUiOps *gaim_conversation_get_ui_ops( |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
529 const GaimConversation *conv); |
4359 | 530 |
531 /** | |
4491 | 532 * Sets the specified conversation's gaim_account. |
4359 | 533 * |
4491 | 534 * This gaim_account represents the user using gaim, not the person the user |
4359 | 535 * is having a conversation/chat/flame with. |
536 * | |
537 * @param conv The conversation. | |
4491 | 538 * @param account The gaim_account. |
4359 | 539 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
540 void gaim_conversation_set_account(GaimConversation *conv, |
10827 | 541 GaimAccount *account); |
4359 | 542 |
543 /** | |
4491 | 544 * Returns the specified conversation's gaim_account. |
4359 | 545 * |
4491 | 546 * This gaim_account represents the user using gaim, not the person the user |
4359 | 547 * is having a conversation/chat/flame with. |
548 * | |
549 * @param conv The conversation. | |
550 * | |
4491 | 551 * @return The conversation's gaim_account. |
4359 | 552 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
553 GaimAccount *gaim_conversation_get_account(const GaimConversation *conv); |
4359 | 554 |
555 /** | |
556 * Returns the specified conversation's gaim_connection. | |
557 * | |
558 * This is the same as gaim_conversation_get_user(conv)->gc. | |
559 * | |
560 * @param conv The conversation. | |
561 * | |
562 * @return The conversation's gaim_connection. | |
563 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
564 GaimConnection *gaim_conversation_get_gc(const GaimConversation *conv); |
4359 | 565 |
566 /** | |
567 * Sets the specified conversation's title. | |
568 * | |
569 * @param conv The conversation. | |
570 * @param title The title. | |
571 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
572 void gaim_conversation_set_title(GaimConversation *conv, const char *title); |
4359 | 573 |
574 /** | |
575 * Returns the specified conversation's title. | |
576 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6622
diff
changeset
|
577 * @param conv The conversation. |
4359 | 578 * |
579 * @return The title. | |
580 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
581 const char *gaim_conversation_get_title(const GaimConversation *conv); |
4359 | 582 |
583 /** | |
584 * Automatically sets the specified conversation's title. | |
585 * | |
586 * This function takes OPT_IM_ALIAS_TAB into account, as well as the | |
587 * user's alias. | |
588 * | |
589 * @param conv The conversation. | |
590 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
591 void gaim_conversation_autoset_title(GaimConversation *conv); |
4359 | 592 |
593 /** | |
594 * Sets the conversation's unseen state. | |
595 * | |
596 * @param conv The conversation. | |
597 * @param state The new unseen state. | |
598 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
599 void gaim_conversation_set_unseen(GaimConversation *conv, |
10827 | 600 GaimUnseenState state); |
4359 | 601 |
602 /** | |
603 * Returns the conversation's unseen state. | |
604 * | |
605 * @param conv The conversation. | |
606 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6622
diff
changeset
|
607 * @return The conversation's unseen state. |
4359 | 608 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
609 GaimUnseenState gaim_conversation_get_unseen(const GaimConversation *conv); |
4359 | 610 |
611 /** | |
7256
c93493c59ac3
[gaim-migrate @ 7833]
Christian Hammond <chipx86@chipx86.com>
parents:
7122
diff
changeset
|
612 * Sets the specified conversation's name. |
c93493c59ac3
[gaim-migrate @ 7833]
Christian Hammond <chipx86@chipx86.com>
parents:
7122
diff
changeset
|
613 * |
c93493c59ac3
[gaim-migrate @ 7833]
Christian Hammond <chipx86@chipx86.com>
parents:
7122
diff
changeset
|
614 * @param conv The conversation. |
c93493c59ac3
[gaim-migrate @ 7833]
Christian Hammond <chipx86@chipx86.com>
parents:
7122
diff
changeset
|
615 * @param name The conversation's name. |
c93493c59ac3
[gaim-migrate @ 7833]
Christian Hammond <chipx86@chipx86.com>
parents:
7122
diff
changeset
|
616 */ |
c93493c59ac3
[gaim-migrate @ 7833]
Christian Hammond <chipx86@chipx86.com>
parents:
7122
diff
changeset
|
617 void gaim_conversation_set_name(GaimConversation *conv, const char *name); |
c93493c59ac3
[gaim-migrate @ 7833]
Christian Hammond <chipx86@chipx86.com>
parents:
7122
diff
changeset
|
618 |
c93493c59ac3
[gaim-migrate @ 7833]
Christian Hammond <chipx86@chipx86.com>
parents:
7122
diff
changeset
|
619 /** |
4359 | 620 * Returns the specified conversation's name. |
621 * | |
622 * @param conv The conversation. | |
623 * | |
624 * @return The conversation's name. | |
625 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
626 const char *gaim_conversation_get_name(const GaimConversation *conv); |
4359 | 627 |
628 /** | |
629 * Enables or disables logging for this conversation. | |
630 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6622
diff
changeset
|
631 * @param conv The conversation. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6622
diff
changeset
|
632 * @param log @c TRUE if logging should be enabled, or @c FALSE otherwise. |
4359 | 633 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
634 void gaim_conversation_set_logging(GaimConversation *conv, gboolean log); |
4359 | 635 |
636 /** | |
637 * Returns whether or not logging is enabled for this conversation. | |
638 * | |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6622
diff
changeset
|
639 * @param conv The conversation. |
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6622
diff
changeset
|
640 * |
4359 | 641 * @return @c TRUE if logging is enabled, or @c FALSE otherwise. |
642 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
643 gboolean gaim_conversation_is_logging(const GaimConversation *conv); |
4359 | 644 |
645 /** | |
646 * Returns the specified conversation's send history. | |
647 * | |
648 * @param conv The conversation. | |
649 * | |
650 * @return The conversation's send history. | |
651 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
652 GList *gaim_conversation_get_send_history(const GaimConversation *conv); |
4359 | 653 |
654 /** | |
655 * Returns the specified conversation's parent window. | |
656 * | |
657 * @param conv The conversation. | |
658 * | |
659 * @return The conversation's parent window. | |
660 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
661 GaimConvWindow *gaim_conversation_get_window(const GaimConversation *conv); |
4359 | 662 |
663 /** | |
664 * Returns the specified conversation's IM-specific data. | |
665 * | |
11338 | 666 * If the conversation type is not GAIM_CONV_TYPE_IM, this will return @c NULL. |
4359 | 667 * |
668 * @param conv The conversation. | |
669 * | |
670 * @return The IM-specific data. | |
671 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
672 GaimConvIm *gaim_conversation_get_im_data(const GaimConversation *conv); |
4359 | 673 |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
674 #define GAIM_CONV_IM(c) (gaim_conversation_get_im_data(c)) |
4359 | 675 |
676 /** | |
677 * Returns the specified conversation's chat-specific data. | |
678 * | |
11338 | 679 * If the conversation type is not GAIM_CONV_TYPE_CHAT, this will return @c NULL. |
4359 | 680 * |
681 * @param conv The conversation. | |
682 * | |
683 * @return The chat-specific data. | |
684 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
685 GaimConvChat *gaim_conversation_get_chat_data(const GaimConversation *conv); |
4359 | 686 |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
687 #define GAIM_CONV_CHAT(c) (gaim_conversation_get_chat_data(c)) |
4359 | 688 |
689 /** | |
4877
249382064693
[gaim-migrate @ 5207]
Christian Hammond <chipx86@chipx86.com>
parents:
4876
diff
changeset
|
690 * Sets extra data for a conversation. |
6585
f30579b25253
[gaim-migrate @ 7107]
Christian Hammond <chipx86@chipx86.com>
parents:
6488
diff
changeset
|
691 * |
4876
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
692 * @param conv The conversation. |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
693 * @param key The unique key. |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
694 * @param data The data to assign. |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
695 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
696 void gaim_conversation_set_data(GaimConversation *conv, const char *key, |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
697 gpointer data); |
4876
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
698 |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
699 /** |
4877
249382064693
[gaim-migrate @ 5207]
Christian Hammond <chipx86@chipx86.com>
parents:
4876
diff
changeset
|
700 * Returns extra data in a conversation. |
4876
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
701 * |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
702 * @param conv The conversation. |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
703 * @param key The unqiue key. |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
704 * |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
705 * @return The data associated with the key. |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
706 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
707 gpointer gaim_conversation_get_data(GaimConversation *conv, const char *key); |
4876
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
708 |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
709 /** |
4359 | 710 * Returns a list of all conversations. |
711 * | |
712 * This list includes both IMs and chats. | |
713 * | |
714 * @return A GList of all conversations. | |
715 */ | |
716 GList *gaim_get_conversations(void); | |
717 | |
718 /** | |
719 * Returns a list of all IMs. | |
720 * | |
721 * @return A GList of all IMs. | |
722 */ | |
723 GList *gaim_get_ims(void); | |
724 | |
725 /** | |
726 * Returns a list of all chats. | |
727 * | |
728 * @return A GList of all chats. | |
729 */ | |
730 GList *gaim_get_chats(void); | |
731 | |
732 /** | |
10246 | 733 * Finds a conversation with the specified type, name, and Gaim account. |
4359 | 734 * |
10246 | 735 * @param type The type of the conversation. |
4359 | 736 * @param name The name of the conversation. |
4491 | 737 * @param account The gaim_account associated with the conversation. |
4359 | 738 * |
739 * @return The conversation if found, or @c NULL otherwise. | |
740 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
741 GaimConversation *gaim_find_conversation_with_account( |
10246 | 742 GaimConversationType type, const char *name, |
743 const GaimAccount *account); | |
4359 | 744 |
745 /** | |
746 * Writes to a conversation window. | |
747 * | |
748 * 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
|
749 * gaim_conv_im_write() and gaim_conv_chat_write() instead. Those functions will |
4359 | 750 * most likely call this anyway, but they may do their own formatting, |
751 * sound playback, etc. | |
752 * | |
753 * This can be used to write generic messages, such as "so and so closed | |
754 * the conversation window." | |
755 * | |
756 * @param conv The conversation. | |
757 * @param who The user who sent the message. | |
758 * @param message The message. | |
6621 | 759 * @param flags The message flags. |
4359 | 760 * @param mtime The time the message was sent. |
761 * | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
762 * @see gaim_conv_im_write() |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
763 * @see gaim_conv_chat_write() |
4359 | 764 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
765 void gaim_conversation_write(GaimConversation *conv, const char *who, |
10665 | 766 const char *message, GaimMessageFlags flags, |
767 time_t mtime); | |
768 | |
769 | |
770 /** | |
771 Set the features as supported for the given conversation. | |
772 @param conv The conversation | |
773 @param features Bitset defining supported features | |
774 */ | |
775 void gaim_conversation_set_features(GaimConversation *conv, | |
776 GaimConnectionFlags features); | |
777 | |
778 | |
779 /** | |
780 Get the features supported by the given conversation. | |
781 @param conv The conversation | |
782 */ | |
783 GaimConnectionFlags gaim_conversation_get_features(GaimConversation *conv); | |
784 | |
4359 | 785 |
786 /** | |
787 * Updates the progress bar on a conversation window | |
788 * (if one exists in the UI). | |
789 * | |
790 * This is used for loading images typically. | |
791 * | |
792 * @param conv The conversation. | |
793 * @param percent The percentage. | |
794 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
795 void gaim_conversation_update_progress(GaimConversation *conv, float percent); |
4359 | 796 |
797 /** | |
9260
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
798 * Determines if a conversation has focus |
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
799 * |
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
800 * @param conv The conversation. |
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
801 * |
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
802 * @return @c TRUE if the conversation has focus, @c FALSE if |
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
803 * 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
|
804 */ |
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
805 gboolean gaim_conversation_has_focus(GaimConversation *conv); |
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
806 |
947876140943
[gaim-migrate @ 10059]
Christian Hammond <chipx86@chipx86.com>
parents:
9166
diff
changeset
|
807 /** |
4359 | 808 * Updates the visual status and UI of a conversation. |
809 * | |
810 * @param conv The conversation. | |
811 * @param type The update type. | |
812 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
813 void gaim_conversation_update(GaimConversation *conv, GaimConvUpdateType type); |
4359 | 814 |
815 /** | |
816 * Calls a function on each conversation. | |
817 * | |
818 * @param func The function. | |
819 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
820 void gaim_conversation_foreach(void (*func)(GaimConversation *conv)); |
4359 | 821 |
822 /*@}*/ | |
823 | |
824 | |
825 /**************************************************************************/ | |
826 /** @name IM Conversation API */ | |
827 /**************************************************************************/ | |
828 /*@{*/ | |
829 | |
830 /** | |
831 * Gets an IM's parent conversation. | |
832 * | |
833 * @param im The IM. | |
834 * | |
835 * @return The parent conversation. | |
836 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
837 GaimConversation *gaim_conv_im_get_conversation(const GaimConvIm *im); |
4359 | 838 |
839 /** | |
6846
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
840 * Sets the IM's buddy icon. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
841 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
842 * 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
|
843 * call gaim_buddy_icon_set_data(). |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
844 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
845 * @param im The IM. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
846 * @param icon The buddy icon. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
847 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
848 * @see gaim_buddy_icon_set_data() |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
849 */ |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
850 void gaim_conv_im_set_icon(GaimConvIm *im, GaimBuddyIcon *icon); |
6846
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
851 |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
852 /** |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
853 * Returns the IM's buddy icon. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
854 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
855 * @param im The IM. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
856 * |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
857 * @return The buddy icon. |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
858 */ |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
859 GaimBuddyIcon *gaim_conv_im_get_icon(const GaimConvIm *im); |
6846
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
860 |
8ab95f4c9800
[gaim-migrate @ 7391]
Christian Hammond <chipx86@chipx86.com>
parents:
6720
diff
changeset
|
861 /** |
4359 | 862 * Sets the IM's typing state. |
863 * | |
864 * @param im The IM. | |
865 * @param state The typing state. | |
866 */ | |
8288
dde73afb3283
[gaim-migrate @ 9012]
Christian Hammond <chipx86@chipx86.com>
parents:
8256
diff
changeset
|
867 void gaim_conv_im_set_typing_state(GaimConvIm *im, GaimTypingState state); |
4359 | 868 |
869 /** | |
870 * Returns the IM's typing state. | |
871 * | |
872 * @param im The IM. | |
873 * | |
874 * @return The IM's typing state. | |
875 */ | |
8288
dde73afb3283
[gaim-migrate @ 9012]
Christian Hammond <chipx86@chipx86.com>
parents:
8256
diff
changeset
|
876 GaimTypingState gaim_conv_im_get_typing_state(const GaimConvIm *im); |
4359 | 877 |
878 /** | |
879 * Starts the IM's typing timeout. | |
880 * | |
881 * @param im The IM. | |
882 * @param timeout The timeout. | |
883 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
884 void gaim_conv_im_start_typing_timeout(GaimConvIm *im, int timeout); |
4359 | 885 |
886 /** | |
887 * Stops the IM's typing timeout. | |
888 * | |
889 * @param im The IM. | |
890 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
891 void gaim_conv_im_stop_typing_timeout(GaimConvIm *im); |
4359 | 892 |
893 /** | |
894 * Returns the IM's typing timeout. | |
895 * | |
896 * @param im The IM. | |
897 * | |
898 * @return The timeout. | |
899 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
900 guint gaim_conv_im_get_typing_timeout(const GaimConvIm *im); |
4359 | 901 |
902 /** | |
903 * Sets the IM's time until it should send another typing notification. | |
904 * | |
905 * @param im The IM. | |
906 * @param val The time. | |
907 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
908 void gaim_conv_im_set_type_again(GaimConvIm *im, time_t val); |
4359 | 909 |
910 /** | |
911 * Returns the IM's time until it should send another typing notification. | |
912 * | |
913 * @param im The IM. | |
914 * | |
915 * @return The time. | |
916 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
917 time_t gaim_conv_im_get_type_again(const GaimConvIm *im); |
4359 | 918 |
919 /** | |
920 * Starts the IM's type again timeout. | |
921 * | |
922 * @param im The IM. | |
923 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
924 void gaim_conv_im_start_type_again_timeout(GaimConvIm *im); |
4359 | 925 |
926 /** | |
927 * Stops the IM's type again timeout. | |
928 * | |
929 * @param im The IM. | |
930 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
931 void gaim_conv_im_stop_type_again_timeout(GaimConvIm *im); |
4359 | 932 |
933 /** | |
934 * Returns the IM's type again timeout interval. | |
935 * | |
936 * @param im The IM. | |
937 * | |
938 * @return The type again timeout interval. | |
939 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
940 guint gaim_conv_im_get_type_again_timeout(const GaimConvIm *im); |
4359 | 941 |
942 /** | |
943 * Updates the visual typing notification for an IM conversation. | |
944 * | |
945 * @param im The IM. | |
946 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
947 void gaim_conv_im_update_typing(GaimConvIm *im); |
4359 | 948 |
949 /** | |
950 * Writes to an IM. | |
951 * | |
952 * @param im The IM. | |
953 * @param who The user who sent the message. | |
954 * @param message The message to write. | |
6621 | 955 * @param flags The message flags. |
4359 | 956 * @param mtime The time the message was sent. |
957 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
958 void gaim_conv_im_write(GaimConvIm *im, const char *who, |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
959 const char *message, GaimMessageFlags flags, |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
960 time_t mtime); |
4359 | 961 |
962 /** | |
9627 | 963 * Presents an IM-error to the user |
964 * | |
965 * This is a helper function to find a conversation, write an error to it, and | |
966 * raise the window. If a conversation with this user doesn't already exist, | |
967 * the function will return FALSE and the calling function can attempt to present | |
968 * the error another way (gaim_notify_error, most likely) | |
969 * | |
970 * @param who The user this error is about | |
971 * @param account The account this error is on | |
972 * @param what The error | |
973 * @return TRUE if the error was presented, else FALSE | |
974 */ | |
975 gboolean gaim_conv_present_error(const char *who, GaimAccount *account, const char *what); | |
976 | |
977 /** | |
4359 | 978 * Sends a message to this IM conversation. |
979 * | |
980 * @param im The IM. | |
981 * @param message The message to send. | |
982 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
983 void gaim_conv_im_send(GaimConvIm *im, const char *message); |
4359 | 984 |
10526 | 985 /** |
10528 | 986 * Adds a smiley to the conversation's smiley tree. If this returns |
987 * @c TRUE you should call gaim_conv_custom_smiley_write() one or more | |
988 * times, and then gaim_conv_custom_smiley_close(). If this returns | |
989 * @c FALSE, either the conv or smile were invalid, or the icon was | |
990 * found in the cache. In either case, calling write or close would | |
991 * be an error. | |
10526 | 992 * |
993 * @param conv The conversation to associate the smiley with. | |
994 * @param smile The text associated with the smiley | |
995 * @param cksum_type The type of checksum. | |
996 * @param chksum The checksum, as a NUL terminated base64 string. | |
10528 | 997 * @return @c TRUE if an icon is expected, else FALSE. Note that |
10526 | 998 * it is an error to never call gaim_conv_custom_smiley_close if |
999 * this function returns @c TRUE, but an error to call it if | |
1000 * @c FALSE is returned. | |
1001 */ | |
1002 | |
1003 gboolean gaim_conv_custom_smiley_add(GaimConversation *conv, const char *smile, | |
1004 const char *cksum_type, const char *chksum); | |
1005 | |
1006 | |
1007 /** | |
1008 * Updates the image associated with the current smiley. | |
1009 * | |
1010 * @param conv The conversation associated with the smiley. | |
1011 * @param smile The text associated with the smiley. | |
1012 * @param data The actual image data. | |
1013 * @param size The length of the data. | |
1014 */ | |
1015 | |
1016 void gaim_conv_custom_smiley_write(GaimConversation *conv, | |
11137 | 1017 const char *smile, |
1018 const guchar *data, | |
1019 gsize size); | |
10526 | 1020 |
1021 /** | |
1022 * Close the custom smiley, all data has been written with | |
1023 * gaim_conv_custom_smiley_write, and it is no longer valid | |
1024 * to call that function on that smiley. | |
1025 * | |
1026 * @param conv The gaim conversation associated with the smiley. | |
1027 * @param smile The text associated with the smiley | |
1028 */ | |
1029 | |
1030 void gaim_conv_custom_smiley_close(GaimConversation *conv, const char *smile); | |
1031 | |
4359 | 1032 /*@}*/ |
1033 | |
1034 | |
1035 /**************************************************************************/ | |
1036 /** @name Chat Conversation API */ | |
1037 /**************************************************************************/ | |
1038 /*@{*/ | |
1039 | |
1040 /** | |
1041 * Gets a chat's parent conversation. | |
1042 * | |
1043 * @param chat The chat. | |
1044 * | |
1045 * @return The parent conversation. | |
1046 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1047 GaimConversation *gaim_conv_chat_get_conversation(const GaimConvChat *chat); |
4359 | 1048 |
1049 /** | |
1050 * Sets the list of users in the chat room. | |
1051 * | |
6407
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1052 * @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
|
1053 * 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
|
1054 * 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
|
1055 * |
4359 | 1056 * @param chat The chat. |
1057 * @param users The list of users. | |
1058 * | |
1059 * @return The list passed. | |
1060 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1061 GList *gaim_conv_chat_set_users(GaimConvChat *chat, GList *users); |
4359 | 1062 |
1063 /** | |
1064 * Returns a list of users in the chat room. | |
1065 * | |
1066 * @param chat The chat. | |
1067 * | |
1068 * @return The list of users. | |
1069 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1070 GList *gaim_conv_chat_get_users(const GaimConvChat *chat); |
4359 | 1071 |
1072 /** | |
1073 * Ignores a user in a chat room. | |
1074 * | |
1075 * @param chat The chat. | |
1076 * @param name The name of the user. | |
1077 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1078 void gaim_conv_chat_ignore(GaimConvChat *chat, const char *name); |
4359 | 1079 |
1080 /** | |
1081 * Unignores a user in a chat room. | |
1082 * | |
1083 * @param chat The chat. | |
1084 * @param name The name of the user. | |
1085 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1086 void gaim_conv_chat_unignore(GaimConvChat *chat, const char *name); |
4359 | 1087 |
1088 /** | |
1089 * Sets the list of ignored users in the chat room. | |
1090 * | |
1091 * @param chat The chat. | |
1092 * @param ignored The list of ignored users. | |
1093 * | |
1094 * @return The list passed. | |
1095 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1096 GList *gaim_conv_chat_set_ignored(GaimConvChat *chat, GList *ignored); |
4359 | 1097 |
1098 /** | |
1099 * Returns the list of ignored users in the chat room. | |
1100 * | |
1101 * @param chat The chat. | |
1102 * | |
1103 * @return The list of ignored users. | |
1104 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1105 GList *gaim_conv_chat_get_ignored(const GaimConvChat *chat); |
4359 | 1106 |
1107 /** | |
1108 * Returns the actual name of the specified ignored user, if it exists in | |
1109 * the ignore list. | |
1110 * | |
1111 * If the user found contains a prefix, such as '+' or '\@', this is also | |
1112 * returned. The username passed to the function does not have to have this | |
1113 * formatting. | |
1114 * | |
1115 * @param chat The chat. | |
1116 * @param user The user to check in the ignore list. | |
1117 * | |
1118 * @return The ignored user if found, complete with prefixes, or @c NULL | |
1119 * if not found. | |
1120 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1121 const char *gaim_conv_chat_get_ignored_user(const GaimConvChat *chat, |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1122 const char *user); |
4359 | 1123 |
1124 /** | |
1125 * Returns @c TRUE if the specified user is ignored. | |
1126 * | |
1127 * @param chat The chat. | |
1128 * @param user The user. | |
1129 * | |
1130 * @return @c TRUE if the user is in the ignore list; @c FALSE otherwise. | |
1131 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1132 gboolean gaim_conv_chat_is_user_ignored(const GaimConvChat *chat, |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1133 const char *user); |
4359 | 1134 |
1135 /** | |
1136 * Sets the chat room's topic. | |
1137 * | |
1138 * @param chat The chat. | |
1139 * @param who The user that set the topic. | |
1140 * @param topic The topic. | |
1141 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1142 void gaim_conv_chat_set_topic(GaimConvChat *chat, const char *who, |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1143 const char *topic); |
4359 | 1144 |
1145 /** | |
1146 * Returns the chat room's topic. | |
1147 * | |
1148 * @param chat The chat. | |
1149 * | |
1150 * @return The chat's topic. | |
1151 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1152 const char *gaim_conv_chat_get_topic(const GaimConvChat *chat); |
4359 | 1153 |
1154 /** | |
1155 * Sets the chat room's ID. | |
1156 * | |
1157 * @param chat The chat. | |
1158 * @param id The ID. | |
1159 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1160 void gaim_conv_chat_set_id(GaimConvChat *chat, int id); |
4359 | 1161 |
1162 /** | |
1163 * Returns the chat room's ID. | |
1164 * | |
1165 * @param chat The chat. | |
1166 * | |
1167 * @return The ID. | |
1168 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1169 int gaim_conv_chat_get_id(const GaimConvChat *chat); |
4359 | 1170 |
1171 /** | |
1172 * Writes to a chat. | |
1173 * | |
1174 * @param chat The chat. | |
1175 * @param who The user who sent the message. | |
1176 * @param message The message to write. | |
6621 | 1177 * @param flags The flags. |
4359 | 1178 * @param mtime The time the message was sent. |
1179 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1180 void gaim_conv_chat_write(GaimConvChat *chat, const char *who, |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1181 const char *message, GaimMessageFlags flags, |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1182 time_t mtime); |
4359 | 1183 |
1184 /** | |
1185 * Sends a message to this chat conversation. | |
1186 * | |
1187 * @param chat The chat. | |
1188 * @param message The message to send. | |
1189 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1190 void gaim_conv_chat_send(GaimConvChat *chat, const char *message); |
4359 | 1191 |
1192 /** | |
1193 * Adds a user to a chat. | |
1194 * | |
9939 | 1195 * @param chat The chat. |
1196 * @param user The user to add. | |
1197 * @param extra_msg An extra message to display with the join message. | |
1198 * @param flags The users flags | |
1199 * @param new_arrival Decides whether or not to show a join notice. | |
4359 | 1200 */ |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1201 void gaim_conv_chat_add_user(GaimConvChat *chat, const char *user, |
9846 | 1202 const char *extra_msg, GaimConvChatBuddyFlags flags, |
1203 gboolean new_arrival); | |
4359 | 1204 |
1205 /** | |
6407
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1206 * Adds a list of users to a chat. |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1207 * |
11454
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11338
diff
changeset
|
1208 * 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
|
1209 * the caller to free this list after calling this function. |
6407
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1210 * |
11454
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11338
diff
changeset
|
1211 * @param chat The chat. |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11338
diff
changeset
|
1212 * @param users The list of users to add. |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11338
diff
changeset
|
1213 * @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
|
1214 * user. This list may be shorter than @a users, in which |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11338
diff
changeset
|
1215 * 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
|
1216 * an extra message. By extension, this means that extra_msgs |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11338
diff
changeset
|
1217 * 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
|
1218 * extra message. |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11338
diff
changeset
|
1219 * @param flags The list of flags for each user. |
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11338
diff
changeset
|
1220 * @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
|
1221 */ |
11454
201617d49573
[gaim-migrate @ 13693]
Richard Laager <rlaager@wiktel.com>
parents:
11338
diff
changeset
|
1222 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
|
1223 GList *flags, gboolean new_arrivals); |
6407
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1224 |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1225 /** |
4359 | 1226 * Renames a user in a chat. |
1227 * | |
1228 * @param chat The chat. | |
1229 * @param old_user The old username. | |
1230 * @param new_user The new username. | |
1231 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1232 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
|
1233 const char *new_user); |
4359 | 1234 |
1235 /** | |
1236 * Removes a user from a chat, optionally with a reason. | |
1237 * | |
6407
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1238 * 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
|
1239 * |
4359 | 1240 * @param chat The chat. |
1241 * @param user The user that is being removed. | |
1242 * @param reason The optional reason given for the removal. Can be @c NULL. | |
1243 */ | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1244 void gaim_conv_chat_remove_user(GaimConvChat *chat, const char *user, |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1245 const char *reason); |
4359 | 1246 |
1247 /** | |
6407
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1248 * 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
|
1249 * |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1250 * @param chat The chat. |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1251 * @param users The users that are being removed. |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1252 * @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
|
1253 */ |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1254 void gaim_conv_chat_remove_users(GaimConvChat *chat, GList *users, |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1255 const char *reason); |
6407
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1256 |
ba0b99a72be2
[gaim-migrate @ 6913]
Christian Hammond <chipx86@chipx86.com>
parents:
6405
diff
changeset
|
1257 /** |
9554 | 1258 * Finds a user in a chat |
1259 * | |
1260 * @param chat The chat. | |
1261 * @param user The user to look for. | |
1262 * | |
1263 * @return TRUE if the user is in the chat, FALSE if not | |
1264 */ | |
1265 gboolean gaim_conv_chat_find_user(GaimConvChat *chat, const char *user); | |
1266 | |
1267 /** | |
1268 * Set a users flags in a chat | |
1269 * | |
1270 * @param chat The chat. | |
1271 * @param user The user to update. | |
1272 * @param flags The new flags. | |
1273 */ | |
1274 void gaim_conv_chat_user_set_flags(GaimConvChat *chat, const char *user, | |
1275 GaimConvChatBuddyFlags flags); | |
1276 | |
1277 /** | |
1278 * Get the flags for a user in a chat | |
1279 * | |
1280 * @param chat The chat. | |
1281 * @param user The user to find the flags for | |
1282 * | |
1283 * @return The flags for the user | |
1284 */ | |
1285 GaimConvChatBuddyFlags gaim_conv_chat_user_get_flags(GaimConvChat *chat, | |
1286 const char *user); | |
1287 | |
1288 /** | |
6414
874a5c9f4eb8
[gaim-migrate @ 6921]
Christian Hammond <chipx86@chipx86.com>
parents:
6407
diff
changeset
|
1289 * Clears all users from a chat. |
874a5c9f4eb8
[gaim-migrate @ 6921]
Christian Hammond <chipx86@chipx86.com>
parents:
6407
diff
changeset
|
1290 * |
874a5c9f4eb8
[gaim-migrate @ 6921]
Christian Hammond <chipx86@chipx86.com>
parents:
6407
diff
changeset
|
1291 * @param chat The chat. |
874a5c9f4eb8
[gaim-migrate @ 6921]
Christian Hammond <chipx86@chipx86.com>
parents:
6407
diff
changeset
|
1292 */ |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1293 void gaim_conv_chat_clear_users(GaimConvChat *chat); |
6414
874a5c9f4eb8
[gaim-migrate @ 6921]
Christian Hammond <chipx86@chipx86.com>
parents:
6407
diff
changeset
|
1294 |
874a5c9f4eb8
[gaim-migrate @ 6921]
Christian Hammond <chipx86@chipx86.com>
parents:
6407
diff
changeset
|
1295 /** |
8158 | 1296 * Sets your nickname (used for hilighting) for a chat. |
1297 * | |
1298 * @param chat The chat. | |
1299 * @param nick The nick. | |
1300 */ | |
1301 void gaim_conv_chat_set_nick(GaimConvChat *chat, const char *nick); | |
1302 | |
1303 /** | |
1304 * Gets your nickname (used for hilighting) for a chat. | |
1305 * | |
1306 * @param chat The chat. | |
1307 * @return The nick. | |
1308 */ | |
1309 const char *gaim_conv_chat_get_nick(GaimConvChat *chat); | |
1310 | |
1311 /** | |
4359 | 1312 * Finds a chat with the specified chat ID. |
1313 * | |
1314 * @param gc The gaim_connection. | |
1315 * @param id The chat ID. | |
1316 * | |
1317 * @return The chat conversation. | |
1318 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1319 GaimConversation *gaim_find_chat(const GaimConnection *gc, int id); |
4359 | 1320 |
8256
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1321 /** |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1322 * Lets the core know we left a chat, without destroying it. |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1323 * Called from serv_got_chat_left(). |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1324 * |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1325 * @param chat The chat. |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1326 */ |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1327 void gaim_conv_chat_left(GaimConvChat *chat); |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1328 |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1329 /** |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1330 * Returns true if we're no longer in this chat, |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1331 * and just left the window open. |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1332 * |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1333 * @param chat The chat. |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1334 * |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1335 * @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
|
1336 * we're still there. |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1337 */ |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1338 gboolean gaim_conv_chat_has_left(GaimConvChat *chat); |
1d86096ae0f4
[gaim-migrate @ 8979]
Christian Hammond <chipx86@chipx86.com>
parents:
8158
diff
changeset
|
1339 |
9554 | 1340 /** |
1341 * Creates a new chat buddy | |
1342 * | |
1343 * @param name The name. | |
1344 * @param flags The flags. | |
1345 * | |
1346 * @return The new chat buddy | |
1347 */ | |
1348 GaimConvChatBuddy *gaim_conv_chat_cb_new(const char *name, | |
1349 GaimConvChatBuddyFlags flags); | |
1350 | |
1351 /** | |
1352 * Find a chat buddy in a chat | |
1353 * | |
1354 * @param chat The chat. | |
1355 * @param name The name of the chat buddy to find. | |
1356 */ | |
1357 GaimConvChatBuddy *gaim_conv_chat_cb_find(GaimConvChat *chat, const char *name); | |
1358 | |
1359 /** | |
1360 * Get the name of a chat buddy | |
1361 * | |
1362 * @param cb The chat buddy. | |
1363 * | |
1364 * @return The name of the chat buddy. | |
1365 */ | |
1366 const char *gaim_conv_chat_cb_get_name(GaimConvChatBuddy *cb); | |
1367 | |
1368 /** | |
1369 * Destroys a chat buddy | |
1370 * | |
1371 * @param cb The chat buddy to destroy | |
1372 */ | |
1373 void gaim_conv_chat_cb_destroy(GaimConvChatBuddy *cb); | |
1374 | |
4359 | 1375 /*@}*/ |
1376 | |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1377 /**************************************************************************/ |
7122
b90c94620d1c
[gaim-migrate @ 7689]
Christian Hammond <chipx86@chipx86.com>
parents:
7118
diff
changeset
|
1378 /** @name Conversation Placement API */ |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1379 /**************************************************************************/ |
4481
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1380 /*@{*/ |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1381 |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1382 /** |
5858 | 1383 * Returns a GList containing the IDs and Names of the registered placement |
1384 * functions. | |
1385 * | |
1386 * @return The list of IDs and names. | |
1387 */ | |
1388 GList *gaim_conv_placement_get_options(void); | |
1389 | |
1390 /** | |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1391 * Adds a conversation placement function to the list of possible functions. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1392 * |
6720
41120df7ed94
[gaim-migrate @ 7247]
Christian Hammond <chipx86@chipx86.com>
parents:
6622
diff
changeset
|
1393 * @param id The unique ID of the placement function. |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1394 * @param name The name of the function. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1395 * @param fnc A pointer to the function. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1396 */ |
6311
eaeac660c17c
[gaim-migrate @ 6810]
Christian Hammond <chipx86@chipx86.com>
parents:
6063
diff
changeset
|
1397 void gaim_conv_placement_add_fnc(const char *id, const char *name, |
eaeac660c17c
[gaim-migrate @ 6810]
Christian Hammond <chipx86@chipx86.com>
parents:
6063
diff
changeset
|
1398 GaimConvPlacementFunc fnc); |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1399 |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1400 /** |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1401 * Removes a conversation placement function from the list of possible |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1402 * functions. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1403 * |
5858 | 1404 * @param id The id of the function. |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1405 */ |
5858 | 1406 void gaim_conv_placement_remove_fnc(const char *id); |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1407 |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1408 /** |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1409 * Returns the name of the conversation placement function at the |
5858 | 1410 * specified id. |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1411 * |
5858 | 1412 * @param id The id. |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1413 * |
5858 | 1414 * @return The name of the function, or @c NULL if this id is invalid. |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1415 */ |
5858 | 1416 const char *gaim_conv_placement_get_name(const char *id); |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1417 |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1418 /** |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1419 * Returns a pointer to the conversation placement function at the |
5858 | 1420 * specified id. |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1421 * |
5858 | 1422 * @param id The id. |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1423 * |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1424 * @return A pointer to the function. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1425 */ |
5858 | 1426 GaimConvPlacementFunc gaim_conv_placement_get_fnc(const char *id); |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1427 |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1428 /** |
7561
cdfdbabd3266
[gaim-migrate @ 8175]
Christian Hammond <chipx86@chipx86.com>
parents:
7431
diff
changeset
|
1429 * Sets the current conversation placement function. |
cdfdbabd3266
[gaim-migrate @ 8175]
Christian Hammond <chipx86@chipx86.com>
parents:
7431
diff
changeset
|
1430 * |
cdfdbabd3266
[gaim-migrate @ 8175]
Christian Hammond <chipx86@chipx86.com>
parents:
7431
diff
changeset
|
1431 * @param func The new conversation placement function. |
cdfdbabd3266
[gaim-migrate @ 8175]
Christian Hammond <chipx86@chipx86.com>
parents:
7431
diff
changeset
|
1432 */ |
cdfdbabd3266
[gaim-migrate @ 8175]
Christian Hammond <chipx86@chipx86.com>
parents:
7431
diff
changeset
|
1433 void gaim_conv_placement_set_current_func(GaimConvPlacementFunc func); |
cdfdbabd3266
[gaim-migrate @ 8175]
Christian Hammond <chipx86@chipx86.com>
parents:
7431
diff
changeset
|
1434 |
cdfdbabd3266
[gaim-migrate @ 8175]
Christian Hammond <chipx86@chipx86.com>
parents:
7431
diff
changeset
|
1435 /** |
cdfdbabd3266
[gaim-migrate @ 8175]
Christian Hammond <chipx86@chipx86.com>
parents:
7431
diff
changeset
|
1436 * Returns the current conversation placement function. |
cdfdbabd3266
[gaim-migrate @ 8175]
Christian Hammond <chipx86@chipx86.com>
parents:
7431
diff
changeset
|
1437 * |
cdfdbabd3266
[gaim-migrate @ 8175]
Christian Hammond <chipx86@chipx86.com>
parents:
7431
diff
changeset
|
1438 * @return The current conversation placement function. |
cdfdbabd3266
[gaim-migrate @ 8175]
Christian Hammond <chipx86@chipx86.com>
parents:
7431
diff
changeset
|
1439 */ |
cdfdbabd3266
[gaim-migrate @ 8175]
Christian Hammond <chipx86@chipx86.com>
parents:
7431
diff
changeset
|
1440 GaimConvPlacementFunc gaim_conv_placement_get_current_func(void); |
cdfdbabd3266
[gaim-migrate @ 8175]
Christian Hammond <chipx86@chipx86.com>
parents:
7431
diff
changeset
|
1441 |
4481
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1442 /*@}*/ |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1443 |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1444 /**************************************************************************/ |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1445 /** @name UI Registration Functions */ |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1446 /**************************************************************************/ |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1447 /*@{*/ |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1448 |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1449 /** |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1450 * Sets the UI operations structure to be used in all gaim conversation |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1451 * windows. |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1452 * |
5207
2819f90a20ba
[gaim-migrate @ 5575]
Christian Hammond <chipx86@chipx86.com>
parents:
5034
diff
changeset
|
1453 * @param ops The UI operations structure. |
4481
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1454 */ |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1455 void gaim_conversations_set_win_ui_ops(GaimConvWindowUiOps *ops); |
4481
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1456 |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1457 /** |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1458 * Returns the gaim window UI operations structure to be used in |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1459 * new windows. |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1460 * |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1461 * @return A filled-out GaimConvWindowUiOps structure. |
4481
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1462 */ |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7035
diff
changeset
|
1463 GaimConvWindowUiOps *gaim_conversations_get_win_ui_ops(void); |
4481
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1464 |
10665 | 1465 |
6485
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1466 /*@}*/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1467 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1468 /**************************************************************************/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1469 /** @name Conversations Subsystem */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1470 /**************************************************************************/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1471 /*@{*/ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1472 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1473 /** |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1474 * Returns the conversation subsystem handle. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1475 * |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1476 * @return The conversation subsystem handle. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1477 */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1478 void *gaim_conversations_get_handle(void); |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1479 |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
1480 /** |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
1481 * Initializes the conversation subsystem. |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
1482 */ |
6485
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1483 void gaim_conversations_init(void); |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1484 |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1485 /** |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1486 * Uninitializes the conversation subsystem. |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1487 */ |
70d5122bc3ff
[gaim-migrate @ 6999]
Christian Hammond <chipx86@chipx86.com>
parents:
6414
diff
changeset
|
1488 void gaim_conversations_uninit(void); |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
1489 |
4481
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1490 /*@}*/ |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1491 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
1492 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
1493 } |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
1494 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
1495 |
4890
89cb14edf8cf
[gaim-migrate @ 5220]
Christian Hammond <chipx86@chipx86.com>
parents:
4877
diff
changeset
|
1496 #endif /* _GAIM_CONVERSATION_H_ */ |