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