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