Mercurial > pidgin.yaz
annotate src/conversation.h @ 6097:7197713bca8a
[gaim-migrate @ 6556]
(00:08:47) Robot101: gaimrc.c lines 1161 and 1168
(00:08:53) Robot101: entry_right should be entry_height
(00:09:08) Robot101: explains why the entry widget's height wasn't importing =)
committer: Tailor Script <tailor@pidgin.im>
author | Luke Schierer <lschiere@pidgin.im> |
---|---|
date | Sat, 12 Jul 2003 04:17:41 +0000 |
parents | 5239a3b4ab33 |
children | eaeac660c17c |
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 * | |
7 * Copyright (C) 2002-2003, Christian Hammond <chipx86@gnupdate.org> | |
8 * | |
9 * This program is free software; you can redistribute it and/or modify | |
10 * it under the terms of the GNU General Public License as published by | |
11 * the Free Software Foundation; either version 2 of the License, or | |
12 * (at your option) any later version. | |
13 * | |
14 * This program is distributed in the hope that it will be useful, | |
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 * GNU General Public License for more details. | |
18 * | |
19 * You should have received a copy of the GNU General Public License | |
20 * along with this program; if not, write to the Free Software | |
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
22 */ | |
23 | |
4890
89cb14edf8cf
[gaim-migrate @ 5220]
Christian Hammond <chipx86@chipx86.com>
parents:
4877
diff
changeset
|
24 #ifndef _GAIM_CONVERSATION_H_ |
89cb14edf8cf
[gaim-migrate @ 5220]
Christian Hammond <chipx86@chipx86.com>
parents:
4877
diff
changeset
|
25 #define _GAIM_CONVERSATION_H_ |
4359 | 26 |
27 /**************************************************************************/ | |
28 /** Data Structures */ | |
29 /**************************************************************************/ | |
30 | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
31 typedef struct _GaimWindowUiOps GaimWindowUiOps; |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
32 typedef struct _GaimWindow GaimWindow; |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
33 typedef struct _GaimConversationUiOps GaimConversationUiOps; |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
34 typedef struct _GaimConversation GaimConversation; |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
35 typedef struct _GaimIm GaimIm; |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
36 typedef struct _GaimChat GaimChat; |
4359 | 37 |
38 /** | |
39 * A type of conversation. | |
40 */ | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
41 typedef enum |
4359 | 42 { |
43 GAIM_CONV_UNKNOWN = 0, /**< Unknown conversation type. */ | |
44 GAIM_CONV_IM, /**< Instant Message. */ | |
4378
194507c83612
[gaim-migrate @ 4644]
Christian Hammond <chipx86@chipx86.com>
parents:
4359
diff
changeset
|
45 GAIM_CONV_CHAT, /**< Chat room. */ |
194507c83612
[gaim-migrate @ 4644]
Christian Hammond <chipx86@chipx86.com>
parents:
4359
diff
changeset
|
46 GAIM_CONV_MISC /**< A misc. conversation. */ |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
47 |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
48 } GaimConversationType; |
4359 | 49 |
50 /** | |
51 * Unseen text states. | |
52 */ | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
53 typedef enum |
4359 | 54 { |
55 GAIM_UNSEEN_NONE = 0, /**< No unseen text in the conversation. */ | |
56 GAIM_UNSEEN_TEXT, /**< Unseen text in the conversation. */ | |
6063 | 57 GAIM_UNSEEN_NICK /**< Unseen text and the nick was said. */ |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
58 |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
59 } GaimUnseenState; |
4359 | 60 |
61 /** | |
62 * Conversation update type. | |
63 */ | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
64 typedef enum |
4359 | 65 { |
66 GAIM_CONV_UPDATE_ADD = 0, /**< The buddy associated with the conversation | |
67 was added. */ | |
68 GAIM_CONV_UPDATE_REMOVE, /**< The buddy associated with the conversation | |
69 was removed. */ | |
4491 | 70 GAIM_CONV_UPDATE_ACCOUNT, /**< The gaim_account was changed. */ |
4359 | 71 GAIM_CONV_UPDATE_TYPING, /**< The typing state was updated. */ |
72 GAIM_CONV_UPDATE_UNSEEN, /**< The unseen state was updated. */ | |
73 GAIM_CONV_UPDATE_LOGGING, /**< Logging for this conversation was | |
74 enabled or disabled. */ | |
75 GAIM_CONV_UPDATE_TOPIC, /**< The topic for a chat was updated. */ | |
76 | |
77 /* | |
78 * XXX These need to go when we implement a more generic core/UI event | |
79 * system. | |
80 */ | |
4378
194507c83612
[gaim-migrate @ 4644]
Christian Hammond <chipx86@chipx86.com>
parents:
4359
diff
changeset
|
81 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
|
82 GAIM_CONV_ACCOUNT_OFFLINE, /**< One of the user's accounts went offline. */ |
194507c83612
[gaim-migrate @ 4644]
Christian Hammond <chipx86@chipx86.com>
parents:
4359
diff
changeset
|
83 GAIM_CONV_UPDATE_AWAY /**< The other user went away. */ |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
84 |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
85 } GaimConvUpdateType; |
4359 | 86 |
87 /** | |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
88 * The typing state of a user. |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
89 */ |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
90 typedef enum |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
91 { |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
92 GAIM_NOT_TYPING = 0, /**< Not typing. */ |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
93 GAIM_TYPING, /**< Currently typing. */ |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
94 GAIM_TYPED /**< Stopped typing momentarily. */ |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
95 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
96 } GaimTypingState; |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
97 |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
98 #include "account.h" |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
99 #include "server.h" |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
100 |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
101 /** |
4359 | 102 * Conversation window operations. |
103 * | |
104 * Any UI representing a window must assign a filled-out gaim_window_ops | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
105 * structure to the GaimWindow. |
4359 | 106 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
107 struct _GaimWindowUiOps |
4359 | 108 { |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
109 GaimConversationUiOps *(*get_conversation_ui_ops)(void); |
4359 | 110 |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
111 void (*new_window)(GaimWindow *win); |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
112 void (*destroy_window)(GaimWindow *win); |
4359 | 113 |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
114 void (*show)(GaimWindow *win); |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
115 void (*hide)(GaimWindow *win); |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
116 void (*raise)(GaimWindow *win); |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
117 void (*flash)(GaimWindow *win); |
4359 | 118 |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
119 void (*switch_conversation)(GaimWindow *win, unsigned int index); |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
120 void (*add_conversation)(GaimWindow *win, GaimConversation *conv); |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
121 void (*remove_conversation)(GaimWindow *win, GaimConversation *conv); |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
122 void (*move_conversation)(GaimWindow *win, GaimConversation *conv, |
4359 | 123 unsigned int newIndex); |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
124 int (*get_active_index)(const GaimWindow *win); |
4359 | 125 }; |
126 | |
127 /** | |
128 * Conversation operations and events. | |
129 * | |
130 * Any UI representing a conversation must assign a filled-out | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
131 * GaimConversationUiOps structure to the GaimConversation. |
4359 | 132 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
133 struct _GaimConversationUiOps |
4359 | 134 { |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
135 void (*destroy_conversation)(GaimConversation *conv); |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
136 void (*write_chat)(GaimConversation *conv, const char *who, |
4359 | 137 const char *message, int flags, time_t mtime); |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
138 void (*write_im)(GaimConversation *conv, const char *who, |
4359 | 139 const char *message, size_t len, int flags, time_t mtime); |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
140 void (*write_conv)(GaimConversation *conv, const char *who, |
4359 | 141 const char *message, size_t length, int flags, |
142 time_t mtime); | |
143 | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
144 void (*chat_add_user)(GaimConversation *conv, const char *user); |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
145 void (*chat_rename_user)(GaimConversation *conv, |
4359 | 146 const char *old_name, const char *new_name); |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
147 void (*chat_remove_user)(GaimConversation *conv, const char *user); |
4359 | 148 |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
149 void (*set_title)(GaimConversation *conv, const char *title); |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
150 void (*update_progress)(GaimConversation *conv, float percent); |
4359 | 151 |
152 /* Events */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
153 void (*updated)(GaimConversation *conv, GaimConvUpdateType type); |
4359 | 154 }; |
155 | |
156 /** | |
157 * A core representation of a graphical window containing one or more | |
158 * conversations. | |
159 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
160 struct _GaimWindow |
4359 | 161 { |
4465
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
162 GList *conversations; /**< The conversations in the window. */ |
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
163 size_t conversation_count; /**< The number of conversations. */ |
4359 | 164 |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
165 GaimWindowUiOps *ui_ops; /**< UI-specific window operations. */ |
4465
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
166 void *ui_data; /**< UI-specific data. */ |
4359 | 167 }; |
168 | |
169 /** | |
170 * Data specific to Instant Messages. | |
171 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
172 struct _GaimIm |
4359 | 173 { |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
174 GaimConversation *conv; /**< The parent conversation. */ |
4359 | 175 |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
176 GaimTypingState typing_state; /**< The current typing state. */ |
4465
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
177 guint typing_timeout; /**< The typing timer handle. */ |
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
178 time_t type_again; /**< The type again time. */ |
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
179 guint type_again_timeout; /**< The type again timer handle. */ |
4359 | 180 |
4465
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
181 GSList *images; /**< A list of images in the IM. */ |
4359 | 182 }; |
183 | |
184 /** | |
185 * Data specific to Chats. | |
186 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
187 struct _GaimChat |
4359 | 188 { |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
189 GaimConversation *conv; /**< The parent conversation. */ |
4359 | 190 |
4465
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
191 GList *in_room; /**< The users in the room. */ |
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
192 GList *ignored; /**< Ignored users. */ |
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
193 char *who; /**< The person who set the topic. */ |
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
194 char *topic; /**< The topic. */ |
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
195 int id; /**< The chat ID. */ |
4359 | 196 }; |
197 | |
198 /** | |
199 * A core representation of a conversation between two or more people. | |
200 * | |
201 * The conversation can be an IM or a chat. Each conversation is kept | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
202 * in a GaimWindow and has a UI representation. |
4359 | 203 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
204 struct _GaimConversation |
4359 | 205 { |
206 GaimConversationType type; /**< The type of conversation. */ | |
207 | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
208 GaimAccount *account; /**< The user using this conversation. */ |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
209 GaimWindow *window; /**< The parent window. */ |
4359 | 210 |
211 int conversation_pos; /**< The position in the window's list. */ | |
212 | |
213 char *name; /**< The name of the conversation. */ | |
214 char *title; /**< The window title. */ | |
215 | |
216 gboolean logging; /**< The status of logging. */ | |
217 | |
218 GList *send_history; /**< The send history. */ | |
219 GString *history; /**< The conversation history. */ | |
220 | |
221 GaimUnseenState unseen; /**< The unseen tab state. */ | |
222 | |
223 union | |
224 { | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
225 GaimIm *im; /**< IM-specific data. */ |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
226 GaimChat *chat; /**< Chat-specific data. */ |
4378
194507c83612
[gaim-migrate @ 4644]
Christian Hammond <chipx86@chipx86.com>
parents:
4359
diff
changeset
|
227 void *misc; /**< Misc. data. */ |
4359 | 228 |
229 } u; | |
4465
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
230 |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
231 GaimConversationUiOps *ui_ops; /**< UI-specific operations. */ |
4465
6e37eb000b7a
[gaim-migrate @ 4740]
Christian Hammond <chipx86@chipx86.com>
parents:
4378
diff
changeset
|
232 void *ui_data; /**< UI-specific data. */ |
4876
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
233 |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
234 GHashTable *data; /**< Plugin-specific data. */ |
4359 | 235 }; |
236 | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
237 typedef void (*GaimConvPlacementFunc)(GaimConversation *); |
4359 | 238 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
239 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
240 extern "C" { |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
241 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
242 |
4359 | 243 /**************************************************************************/ |
244 /** @name Conversation Window API */ | |
245 /**************************************************************************/ | |
246 /*@{*/ | |
247 | |
248 /** | |
249 * Creates a new conversation window. | |
250 * | |
251 * This window is added to the list of windows, but is not shown until | |
252 * gaim_window_show() is called. | |
253 * | |
254 * @return The new conversation window. | |
255 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
256 GaimWindow *gaim_window_new(void); |
4359 | 257 |
258 /** | |
259 * Destroys the specified conversation window and all conversations in it. | |
260 * | |
261 * @param win The window to destroy. | |
262 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
263 void gaim_window_destroy(GaimWindow *win); |
4359 | 264 |
265 /** | |
266 * Shows the specified conversation window. | |
267 * | |
268 * @param win The window. | |
269 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
270 void gaim_window_show(GaimWindow *win); |
4359 | 271 |
272 /** | |
273 * Hides the specified conversation window. | |
274 * | |
275 * @param win The window. | |
276 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
277 void gaim_window_hide(GaimWindow *win); |
4359 | 278 |
279 /** | |
280 * Raises the specified conversation window. | |
281 * | |
282 * @param win The window. | |
283 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
284 void gaim_window_raise(GaimWindow *win); |
4359 | 285 |
286 /** | |
287 * Causes the window to flash for IM notification, if the UI supports this. | |
288 * | |
289 * @param win The window. | |
290 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
291 void gaim_window_flash(GaimWindow *win); |
4359 | 292 |
293 /** | |
294 * Sets the specified window's UI window operations structure. | |
295 * | |
296 * @param win The window. | |
297 * @param ops The UI window operations structure. | |
298 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
299 void gaim_window_set_ui_ops(GaimWindow *win, GaimWindowUiOps *ops); |
4359 | 300 |
301 /** | |
302 * Returns the specified window's UI window operations structure. | |
303 * | |
304 * @param win The window. | |
305 * | |
306 * @return The UI window operations structure. | |
307 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
308 GaimWindowUiOps *gaim_window_get_ui_ops(const GaimWindow *win); |
4359 | 309 |
310 /** | |
311 * Adds a conversation to this window. | |
312 * | |
313 * If the conversation already has a parent window, this will do nothing. | |
314 * | |
315 * @param win The window. | |
316 * @param conv The conversation. | |
317 * | |
318 * @return The new index of the conversation in the window. | |
319 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
320 int gaim_window_add_conversation(GaimWindow *win, GaimConversation *conv); |
4359 | 321 |
322 /** | |
323 * Removes the conversation at the specified index from the window. | |
324 * | |
325 * If there is no conversation at this index, this will do nothing. | |
326 * | |
327 * @param win The window. | |
328 * @param index The index of the conversation. | |
329 * | |
330 * @return The conversation removed. | |
331 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
332 GaimConversation *gaim_window_remove_conversation(GaimWindow *win, |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
333 unsigned int index); |
4359 | 334 |
335 /** | |
336 * Moves the conversation at the specified index in a window to a new index. | |
337 * | |
338 * @param win The window. | |
339 * @param index The index of the conversation to move. | |
340 * @param new_index The new index. | |
341 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
342 void gaim_window_move_conversation(GaimWindow *win, unsigned int index, |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
343 unsigned int new_index); |
4359 | 344 |
345 /** | |
346 * Returns the conversation in the window at the specified index. | |
347 * | |
348 * If the index is out of range, this returns @c NULL. | |
349 * | |
350 * @param win The window. | |
351 * @param index The index containing a conversation. | |
352 * | |
353 * @return The conversation at the specified index. | |
354 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
355 GaimConversation *gaim_window_get_conversation_at(const GaimWindow *win, |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
356 unsigned int index); |
4359 | 357 |
358 /** | |
359 * Returns the number of conversations in the window. | |
360 * | |
361 * @param win The window. | |
362 * | |
363 * @return The number of conversations. | |
364 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
365 size_t gaim_window_get_conversation_count(const GaimWindow *win); |
4359 | 366 |
367 /** | |
368 * Switches the active conversation to the one at the specified index. | |
369 * | |
370 * If @a index is out of range, this does nothing. | |
371 * | |
372 * @param win The window. | |
373 * @param index The new index. | |
374 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
375 void gaim_window_switch_conversation(GaimWindow *win, unsigned int index); |
4359 | 376 |
377 /** | |
378 * Returns the active conversation in the window. | |
379 * | |
380 * @param win The window. | |
381 * | |
382 * @return The active conversation. | |
383 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
384 GaimConversation *gaim_window_get_active_conversation(const GaimWindow *win); |
4359 | 385 |
386 /** | |
387 * Returns the list of conversations in the specified window. | |
388 * | |
389 * @param win The window. | |
390 * | |
391 * @return The list of conversations. | |
392 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
393 GList *gaim_window_get_conversations(const GaimWindow *win); |
4359 | 394 |
395 /** | |
396 * Returns a list of all windows. | |
397 * | |
398 * @return A list of windows. | |
399 */ | |
400 GList *gaim_get_windows(void); | |
401 | |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
402 /** |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
403 * Returns the first window containing a conversation of the specified type. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
404 * |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
405 * @param type The conversation type. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
406 * |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
407 * @return The window if found, or @c NULL if not found. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
408 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
409 GaimWindow *gaim_get_first_window_with_type(GaimConversationType type); |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
410 |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
411 /** |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
412 * Returns the last window containing a conversation of the specified type. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
413 * |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
414 * @param type The conversation type. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
415 * |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
416 * @return The window if found, or @c NULL if not found. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
417 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
418 GaimWindow *gaim_get_last_window_with_type(GaimConversationType type); |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
419 |
4359 | 420 /*@}*/ |
421 | |
422 /**************************************************************************/ | |
423 /** @name Conversation API */ | |
424 /**************************************************************************/ | |
425 /*@{*/ | |
426 | |
427 /** | |
428 * Creates a new conversation of the specified type. | |
429 * | |
430 * @param type The type of conversation. | |
4476
62c1e5e656d0
[gaim-migrate @ 4751]
Christian Hammond <chipx86@chipx86.com>
parents:
4469
diff
changeset
|
431 * @param user The account opening the conversation window on the gaim |
62c1e5e656d0
[gaim-migrate @ 4751]
Christian Hammond <chipx86@chipx86.com>
parents:
4469
diff
changeset
|
432 * user's end. |
4359 | 433 * @param name The name of the conversation. |
434 * | |
435 * @return The new conversation. | |
436 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
437 GaimConversation *gaim_conversation_new(GaimConversationType type, |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
438 GaimAccount *account, |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
439 const char *name); |
4359 | 440 |
441 /** | |
442 * Destroys the specified conversation and removes it from the parent | |
443 * window. | |
444 * | |
445 * If this conversation is the only one contained in the parent window, | |
446 * that window is also destroyed. | |
447 * | |
448 * @param conv The conversation to destroy. | |
449 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
450 void gaim_conversation_destroy(GaimConversation *conv); |
4359 | 451 |
452 /** | |
453 * Returns the specified conversation's type. | |
454 * | |
455 * @param conv The conversation. | |
456 * | |
457 * @return The conversation's type. | |
458 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
459 GaimConversationType gaim_conversation_get_type(const GaimConversation *conv); |
4359 | 460 |
461 /** | |
462 * Sets the specified conversation's UI operations structure. | |
463 * | |
464 * @param conv The conversation. | |
465 * @param ops The UI conversation operations structure. | |
466 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
467 void gaim_conversation_set_ui_ops(GaimConversation *conv, |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
468 GaimConversationUiOps *ops); |
4359 | 469 |
470 /** | |
471 * Returns the specified conversation's UI operations structure. | |
472 * | |
473 * @param conv The conversation. | |
474 * | |
475 * @return The operations structure. | |
476 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
477 GaimConversationUiOps *gaim_conversation_get_ui_ops( |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
478 const GaimConversation *conv); |
4359 | 479 |
480 /** | |
4491 | 481 * Sets the specified conversation's gaim_account. |
4359 | 482 * |
4491 | 483 * This gaim_account represents the user using gaim, not the person the user |
4359 | 484 * is having a conversation/chat/flame with. |
485 * | |
486 * @param conv The conversation. | |
4491 | 487 * @param account The gaim_account. |
4359 | 488 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
489 void gaim_conversation_set_account(GaimConversation *conv, |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
490 GaimAccount *account); |
4359 | 491 |
492 /** | |
4491 | 493 * Returns the specified conversation's gaim_account. |
4359 | 494 * |
4491 | 495 * This gaim_account represents the user using gaim, not the person the user |
4359 | 496 * is having a conversation/chat/flame with. |
497 * | |
498 * @param conv The conversation. | |
499 * | |
4491 | 500 * @return The conversation's gaim_account. |
4359 | 501 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
502 GaimAccount *gaim_conversation_get_account(const GaimConversation *conv); |
4359 | 503 |
504 /** | |
505 * Returns the specified conversation's gaim_connection. | |
506 * | |
507 * This is the same as gaim_conversation_get_user(conv)->gc. | |
508 * | |
509 * @param conv The conversation. | |
510 * | |
511 * @return The conversation's gaim_connection. | |
512 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
513 GaimConnection *gaim_conversation_get_gc(const GaimConversation *conv); |
4359 | 514 |
515 /** | |
516 * Sets the specified conversation's title. | |
517 * | |
518 * @param conv The conversation. | |
519 * @param title The title. | |
520 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
521 void gaim_conversation_set_title(GaimConversation *conv, const char *title); |
4359 | 522 |
523 /** | |
524 * Returns the specified conversation's title. | |
525 * | |
526 * @param win The conversation. | |
527 * | |
528 * @return The title. | |
529 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
530 const char *gaim_conversation_get_title(const GaimConversation *conv); |
4359 | 531 |
532 /** | |
533 * Automatically sets the specified conversation's title. | |
534 * | |
535 * This function takes OPT_IM_ALIAS_TAB into account, as well as the | |
536 * user's alias. | |
537 * | |
538 * @param conv The conversation. | |
539 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
540 void gaim_conversation_autoset_title(GaimConversation *conv); |
4359 | 541 |
542 /** | |
543 * Returns the specified conversation's index in the parent window. | |
544 * | |
545 * @param conv The conversation. | |
546 * | |
547 * @return The current index in the parent window. | |
548 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
549 int gaim_conversation_get_index(const GaimConversation *conv); |
4359 | 550 |
551 /** | |
552 * Sets the conversation's unseen state. | |
553 * | |
554 * @param conv The conversation. | |
555 * @param state The new unseen state. | |
556 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
557 void gaim_conversation_set_unseen(GaimConversation *conv, |
4359 | 558 GaimUnseenState state); |
559 | |
560 /** | |
561 * Returns the conversation's unseen state. | |
562 * | |
563 * @param conv The conversation. | |
564 * | |
565 * @param The conversation's unseen state. | |
566 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
567 GaimUnseenState gaim_conversation_get_unseen(const GaimConversation *conv); |
4359 | 568 |
569 /** | |
570 * Returns the specified conversation's name. | |
571 * | |
572 * @param conv The conversation. | |
573 * | |
574 * @return The conversation's name. | |
575 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
576 const char *gaim_conversation_get_name(const GaimConversation *conv); |
4359 | 577 |
578 /** | |
579 * Enables or disables logging for this conversation. | |
580 * | |
581 * @param log @c TRUE if logging should be enabled, or @c FALSE otherwise. | |
582 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
583 void gaim_conversation_set_logging(GaimConversation *conv, gboolean log); |
4359 | 584 |
585 /** | |
586 * Returns whether or not logging is enabled for this conversation. | |
587 * | |
588 * @return @c TRUE if logging is enabled, or @c FALSE otherwise. | |
589 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
590 gboolean gaim_conversation_is_logging(const GaimConversation *conv); |
4359 | 591 |
592 /** | |
593 * Returns the specified conversation's send history. | |
594 * | |
595 * @param conv The conversation. | |
596 * | |
597 * @return The conversation's send history. | |
598 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
599 GList *gaim_conversation_get_send_history(const GaimConversation *conv); |
4359 | 600 |
601 /** | |
602 * Sets the specified conversation's history. | |
603 * | |
604 * @param conv The conversation. | |
605 * @param history The history. | |
606 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
607 void gaim_conversation_set_history(GaimConversation *conv, GString *history); |
4359 | 608 |
609 /** | |
610 * Returns the specified conversation's history. | |
611 * | |
612 * @param conv The conversation. | |
613 * | |
614 * @return The conversation's history. | |
615 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
616 GString *gaim_conversation_get_history(const GaimConversation *conv); |
4359 | 617 |
618 /** | |
619 * Returns the specified conversation's parent window. | |
620 * | |
621 * @param conv The conversation. | |
622 * | |
623 * @return The conversation's parent window. | |
624 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
625 GaimWindow *gaim_conversation_get_window(const GaimConversation *conv); |
4359 | 626 |
627 /** | |
628 * Returns the specified conversation's IM-specific data. | |
629 * | |
630 * If the conversation type is not GAIM_CONV_IM, this will return @c NULL. | |
631 * | |
632 * @param conv The conversation. | |
633 * | |
634 * @return The IM-specific data. | |
635 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
636 GaimIm *gaim_conversation_get_im_data(const GaimConversation *conv); |
4359 | 637 |
638 #define GAIM_IM(c) (gaim_conversation_get_im_data(c)) | |
639 | |
640 /** | |
641 * Returns the specified conversation's chat-specific data. | |
642 * | |
643 * If the conversation type is not GAIM_CONV_CHAT, this will return @c NULL. | |
644 * | |
645 * @param conv The conversation. | |
646 * | |
647 * @return The chat-specific data. | |
648 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
649 GaimChat *gaim_conversation_get_chat_data(const GaimConversation *conv); |
4359 | 650 |
651 #define GAIM_CHAT(c) (gaim_conversation_get_chat_data(c)) | |
652 | |
653 /** | |
4877
249382064693
[gaim-migrate @ 5207]
Christian Hammond <chipx86@chipx86.com>
parents:
4876
diff
changeset
|
654 * Sets extra data for a conversation. |
4876
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
655 * |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
656 * @param conv The conversation. |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
657 * @param key The unique key. |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
658 * @param data The data to assign. |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
659 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
660 void gaim_conversation_set_data(GaimConversation *conv, const char *key, |
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
661 gpointer data); |
4876
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
662 |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
663 /** |
4877
249382064693
[gaim-migrate @ 5207]
Christian Hammond <chipx86@chipx86.com>
parents:
4876
diff
changeset
|
664 * Returns extra data in a conversation. |
4876
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
665 * |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
666 * @param conv The conversation. |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
667 * @param key The unqiue key. |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
668 * |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
669 * @return The data associated with the key. |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
670 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
671 gpointer gaim_conversation_get_data(GaimConversation *conv, const char *key); |
4876
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
672 |
9567b13d0e98
[gaim-migrate @ 5206]
Christian Hammond <chipx86@chipx86.com>
parents:
4491
diff
changeset
|
673 /** |
4359 | 674 * Returns a list of all conversations. |
675 * | |
676 * This list includes both IMs and chats. | |
677 * | |
678 * @return A GList of all conversations. | |
679 */ | |
680 GList *gaim_get_conversations(void); | |
681 | |
682 /** | |
683 * Returns a list of all IMs. | |
684 * | |
685 * @return A GList of all IMs. | |
686 */ | |
687 GList *gaim_get_ims(void); | |
688 | |
689 /** | |
690 * Returns a list of all chats. | |
691 * | |
692 * @return A GList of all chats. | |
693 */ | |
694 GList *gaim_get_chats(void); | |
695 | |
696 /** | |
697 * Finds the conversation with the specified name. | |
698 * | |
699 * @param name The name of the conversation. | |
700 * | |
701 * @return The conversation if found, or @c NULL otherwise. | |
702 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
703 GaimConversation *gaim_find_conversation(const char *name); |
4359 | 704 |
705 /** | |
706 * Finds a conversation with the specified name and user. | |
707 * | |
708 * @param name The name of the conversation. | |
4491 | 709 * @param account The gaim_account associated with the conversation. |
4359 | 710 * |
711 * @return The conversation if found, or @c NULL otherwise. | |
712 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
713 GaimConversation *gaim_find_conversation_with_account( |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5207
diff
changeset
|
714 const char *name, const GaimAccount *account); |
4359 | 715 |
716 /** | |
717 * Writes to a conversation window. | |
718 * | |
719 * This function should not be used to write IM or chat messages. Use | |
720 * gaim_im_write() and gaim_chat_write() instead. Those functions will | |
721 * most likely call this anyway, but they may do their own formatting, | |
722 * sound playback, etc. | |
723 * | |
724 * This can be used to write generic messages, such as "so and so closed | |
725 * the conversation window." | |
726 * | |
727 * @param conv The conversation. | |
728 * @param who The user who sent the message. | |
729 * @param message The message. | |
730 * @param length The length of the message. | |
731 * @param flags The flags. | |
732 * @param mtime The time the message was sent. | |
733 * | |
734 * @see gaim_im_write() | |
735 * @see gaim_chat_write() | |
736 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
737 void gaim_conversation_write(GaimConversation *conv, const char *who, |
4359 | 738 const char *message, size_t length, int flags, |
739 time_t mtime); | |
740 | |
741 /** | |
742 * Updates the progress bar on a conversation window | |
743 * (if one exists in the UI). | |
744 * | |
745 * This is used for loading images typically. | |
746 * | |
747 * @param conv The conversation. | |
748 * @param percent The percentage. | |
749 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
750 void gaim_conversation_update_progress(GaimConversation *conv, float percent); |
4359 | 751 |
752 /** | |
753 * Updates the visual status and UI of a conversation. | |
754 * | |
755 * @param conv The conversation. | |
756 * @param type The update type. | |
757 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
758 void gaim_conversation_update(GaimConversation *conv, GaimConvUpdateType type); |
4359 | 759 |
760 /** | |
761 * Calls a function on each conversation. | |
762 * | |
763 * @param func The function. | |
764 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
765 void gaim_conversation_foreach(void (*func)(GaimConversation *conv)); |
4359 | 766 |
767 /*@}*/ | |
768 | |
769 | |
770 /**************************************************************************/ | |
771 /** @name IM Conversation API */ | |
772 /**************************************************************************/ | |
773 /*@{*/ | |
774 | |
775 /** | |
776 * Gets an IM's parent conversation. | |
777 * | |
778 * @param im The IM. | |
779 * | |
780 * @return The parent conversation. | |
781 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
782 GaimConversation *gaim_im_get_conversation(const GaimIm *im); |
4359 | 783 |
784 /** | |
785 * Sets the IM's typing state. | |
786 * | |
787 * @param im The IM. | |
788 * @param state The typing state. | |
789 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
790 void gaim_im_set_typing_state(GaimIm *im, int state); |
4359 | 791 |
792 /** | |
793 * Returns the IM's typing state. | |
794 * | |
795 * @param im The IM. | |
796 * | |
797 * @return The IM's typing state. | |
798 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
799 int gaim_im_get_typing_state(const GaimIm *im); |
4359 | 800 |
801 /** | |
802 * Starts the IM's typing timeout. | |
803 * | |
804 * @param im The IM. | |
805 * @param timeout The timeout. | |
806 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
807 void gaim_im_start_typing_timeout(GaimIm *im, int timeout); |
4359 | 808 |
809 /** | |
810 * Stops the IM's typing timeout. | |
811 * | |
812 * @param im The IM. | |
813 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
814 void gaim_im_stop_typing_timeout(GaimIm *im); |
4359 | 815 |
816 /** | |
817 * Returns the IM's typing timeout. | |
818 * | |
819 * @param im The IM. | |
820 * | |
821 * @return The timeout. | |
822 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
823 guint gaim_im_get_typing_timeout(const GaimIm *im); |
4359 | 824 |
825 /** | |
826 * Sets the IM's time until it should send another typing notification. | |
827 * | |
828 * @param im The IM. | |
829 * @param val The time. | |
830 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
831 void gaim_im_set_type_again(GaimIm *im, time_t val); |
4359 | 832 |
833 /** | |
834 * Returns the IM's time until it should send another typing notification. | |
835 * | |
836 * @param im The IM. | |
837 * | |
838 * @return The time. | |
839 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
840 time_t gaim_im_get_type_again(const GaimIm *im); |
4359 | 841 |
842 /** | |
843 * Starts the IM's type again timeout. | |
844 * | |
845 * @param im The IM. | |
846 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
847 void gaim_im_start_type_again_timeout(GaimIm *im); |
4359 | 848 |
849 /** | |
850 * Stops the IM's type again timeout. | |
851 * | |
852 * @param im The IM. | |
853 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
854 void gaim_im_stop_type_again_timeout(GaimIm *im); |
4359 | 855 |
856 /** | |
857 * Returns the IM's type again timeout interval. | |
858 * | |
859 * @param im The IM. | |
860 * | |
861 * @return The type again timeout interval. | |
862 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
863 guint gaim_im_get_type_again_timeout(const GaimIm *im); |
4359 | 864 |
865 /** | |
866 * Updates the visual typing notification for an IM conversation. | |
867 * | |
868 * @param im The IM. | |
869 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
870 void gaim_im_update_typing(GaimIm *im); |
4359 | 871 |
872 /** | |
873 * Writes to an IM. | |
874 * | |
875 * The @a len parameter is used for writing binary data, such as an | |
876 * image. If @c message is text, specify -1 for @a len. | |
877 * | |
878 * @param im The IM. | |
879 * @param who The user who sent the message. | |
880 * @param message The message to write. | |
881 * @param len The length of the message, or -1 to specify the length | |
882 * of @a message. | |
883 * @param flag The flags. | |
884 * @param mtime The time the message was sent. | |
885 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
886 void gaim_im_write(GaimIm *im, const char *who, |
4359 | 887 const char *message, size_t len, int flag, time_t mtime); |
888 | |
889 /** | |
890 * Sends a message to this IM conversation. | |
891 * | |
892 * @param im The IM. | |
893 * @param message The message to send. | |
894 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
895 void gaim_im_send(GaimIm *im, const char *message); |
4359 | 896 |
897 /*@}*/ | |
898 | |
899 | |
900 /**************************************************************************/ | |
901 /** @name Chat Conversation API */ | |
902 /**************************************************************************/ | |
903 /*@{*/ | |
904 | |
905 /** | |
906 * Gets a chat's parent conversation. | |
907 * | |
908 * @param chat The chat. | |
909 * | |
910 * @return The parent conversation. | |
911 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
912 GaimConversation *gaim_chat_get_conversation(const GaimChat *chat); |
4359 | 913 |
914 /** | |
915 * Sets the list of users in the chat room. | |
916 * | |
917 * @param chat The chat. | |
918 * @param users The list of users. | |
919 * | |
920 * @return The list passed. | |
921 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
922 GList *gaim_chat_set_users(GaimChat *chat, GList *users); |
4359 | 923 |
924 /** | |
925 * Returns a list of users in the chat room. | |
926 * | |
927 * @param chat The chat. | |
928 * | |
929 * @return The list of users. | |
930 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
931 GList *gaim_chat_get_users(const GaimChat *chat); |
4359 | 932 |
933 /** | |
934 * Ignores a user in a chat room. | |
935 * | |
936 * @param chat The chat. | |
937 * @param name The name of the user. | |
938 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
939 void gaim_chat_ignore(GaimChat *chat, const char *name); |
4359 | 940 |
941 /** | |
942 * Unignores a user in a chat room. | |
943 * | |
944 * @param chat The chat. | |
945 * @param name The name of the user. | |
946 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
947 void gaim_chat_unignore(GaimChat *chat, const char *name); |
4359 | 948 |
949 /** | |
950 * Sets the list of ignored users in the chat room. | |
951 * | |
952 * @param chat The chat. | |
953 * @param ignored The list of ignored users. | |
954 * | |
955 * @return The list passed. | |
956 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
957 GList *gaim_chat_set_ignored(GaimChat *chat, GList *ignored); |
4359 | 958 |
959 /** | |
960 * Returns the list of ignored users in the chat room. | |
961 * | |
962 * @param chat The chat. | |
963 * | |
964 * @return The list of ignored users. | |
965 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
966 GList *gaim_chat_get_ignored(const GaimChat *chat); |
4359 | 967 |
968 /** | |
969 * Returns the actual name of the specified ignored user, if it exists in | |
970 * the ignore list. | |
971 * | |
972 * If the user found contains a prefix, such as '+' or '\@', this is also | |
973 * returned. The username passed to the function does not have to have this | |
974 * formatting. | |
975 * | |
976 * @param chat The chat. | |
977 * @param user The user to check in the ignore list. | |
978 * | |
979 * @return The ignored user if found, complete with prefixes, or @c NULL | |
980 * if not found. | |
981 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
982 const char *gaim_chat_get_ignored_user(const GaimChat *chat, |
4359 | 983 const char *user); |
984 | |
985 /** | |
986 * Returns @c TRUE if the specified user is ignored. | |
987 * | |
988 * @param chat The chat. | |
989 * @param user The user. | |
990 * | |
991 * @return @c TRUE if the user is in the ignore list; @c FALSE otherwise. | |
992 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
993 gboolean gaim_chat_is_user_ignored(const GaimChat *chat, |
4359 | 994 const char *user); |
995 | |
996 /** | |
997 * Sets the chat room's topic. | |
998 * | |
999 * @param chat The chat. | |
1000 * @param who The user that set the topic. | |
1001 * @param topic The topic. | |
1002 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1003 void gaim_chat_set_topic(GaimChat *chat, const char *who, |
4359 | 1004 const char *topic); |
1005 | |
1006 /** | |
1007 * Returns the chat room's topic. | |
1008 * | |
1009 * @param chat The chat. | |
1010 * | |
1011 * @return The chat's topic. | |
1012 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1013 const char *gaim_chat_get_topic(const GaimChat *chat); |
4359 | 1014 |
1015 /** | |
1016 * Sets the chat room's ID. | |
1017 * | |
1018 * @param chat The chat. | |
1019 * @param id The ID. | |
1020 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1021 void gaim_chat_set_id(GaimChat *chat, int id); |
4359 | 1022 |
1023 /** | |
1024 * Returns the chat room's ID. | |
1025 * | |
1026 * @param chat The chat. | |
1027 * | |
1028 * @return The ID. | |
1029 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1030 int gaim_chat_get_id(const GaimChat *chat); |
4359 | 1031 |
1032 /** | |
1033 * Writes to a chat. | |
1034 * | |
1035 * @param chat The chat. | |
1036 * @param who The user who sent the message. | |
1037 * @param message The message to write. | |
1038 * @param flag The flags. | |
1039 * @param mtime The time the message was sent. | |
1040 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1041 void gaim_chat_write(GaimChat *chat, const char *who, |
4359 | 1042 const char *message, int flag, time_t mtime); |
1043 | |
1044 /** | |
1045 * Sends a message to this chat conversation. | |
1046 * | |
1047 * @param chat The chat. | |
1048 * @param message The message to send. | |
1049 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1050 void gaim_chat_send(GaimChat *chat, const char *message); |
4359 | 1051 |
1052 /** | |
1053 * Adds a user to a chat. | |
1054 * | |
1055 * @param chat The chat. | |
1056 * @param user The user to add. | |
1057 * @param extra_msg An extra message to display with the join message. | |
1058 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1059 void gaim_chat_add_user(GaimChat *chat, const char *user, |
4359 | 1060 const char *extra_msg); |
1061 | |
1062 /** | |
1063 * Renames a user in a chat. | |
1064 * | |
1065 * @param chat The chat. | |
1066 * @param old_user The old username. | |
1067 * @param new_user The new username. | |
1068 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1069 void gaim_chat_rename_user(GaimChat *chat, const char *old_user, |
4359 | 1070 const char *new_user); |
1071 | |
1072 /** | |
1073 * Removes a user from a chat, optionally with a reason. | |
1074 * | |
1075 * @param chat The chat. | |
1076 * @param user The user that is being removed. | |
1077 * @param reason The optional reason given for the removal. Can be @c NULL. | |
1078 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1079 void gaim_chat_remove_user(GaimChat *chat, const char *user, |
4359 | 1080 const char *reason); |
1081 | |
1082 /** | |
1083 * Finds a chat with the specified chat ID. | |
1084 * | |
1085 * @param gc The gaim_connection. | |
1086 * @param id The chat ID. | |
1087 * | |
1088 * @return The chat conversation. | |
1089 */ | |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1090 GaimConversation *gaim_find_chat(const GaimConnection *gc, int id); |
4359 | 1091 |
1092 /*@}*/ | |
1093 | |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1094 /**************************************************************************/ |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1095 /** @name Conversation Placement Functions */ |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1096 /**************************************************************************/ |
4481
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1097 /*@{*/ |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1098 |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1099 /** |
5858 | 1100 * Returns a GList containing the IDs and Names of the registered placement |
1101 * functions. | |
1102 * | |
1103 * @return The list of IDs and names. | |
1104 */ | |
1105 GList *gaim_conv_placement_get_options(void); | |
1106 | |
1107 /** | |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1108 * Adds a conversation placement function to the list of possible functions. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1109 * |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1110 * @param name The name of the function. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1111 * @param fnc A pointer to the function. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1112 */ |
5858 | 1113 void gaim_conv_placement_add_fnc(const char *id, const char *name, GaimConvPlacementFunc fnc); |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1114 |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1115 /** |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1116 * Removes a conversation placement function from the list of possible |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1117 * functions. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1118 * |
5858 | 1119 * @param id The id of the function. |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1120 */ |
5858 | 1121 void gaim_conv_placement_remove_fnc(const char *id); |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1122 |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1123 /** |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1124 * Returns the name of the conversation placement function at the |
5858 | 1125 * specified id. |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1126 * |
5858 | 1127 * @param id The id. |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1128 * |
5858 | 1129 * @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
|
1130 */ |
5858 | 1131 const char *gaim_conv_placement_get_name(const char *id); |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1132 |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1133 /** |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1134 * Returns a pointer to the conversation placement function at the |
5858 | 1135 * specified id. |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1136 * |
5858 | 1137 * @param id The id. |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1138 * |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1139 * @return A pointer to the function. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1140 */ |
5858 | 1141 GaimConvPlacementFunc gaim_conv_placement_get_fnc(const char *id); |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1142 |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1143 /** |
5858 | 1144 * Returns the id of the specified conversation placement function. |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1145 * |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1146 * @param fnc A pointer to the registered function. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1147 * |
5858 | 1148 * @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
|
1149 * registered. |
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1150 */ |
5858 | 1151 const char *gaim_conv_placement_get_fnc_id(GaimConvPlacementFunc fnc); |
4469
d76095396a0e
[gaim-migrate @ 4744]
Christian Hammond <chipx86@chipx86.com>
parents:
4465
diff
changeset
|
1152 |
4481
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1153 /*@}*/ |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1154 |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1155 /**************************************************************************/ |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1156 /** @name UI Registration Functions */ |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1157 /**************************************************************************/ |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1158 /*@{*/ |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1159 |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1160 /** |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1161 * 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
|
1162 * windows. |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1163 * |
5207
2819f90a20ba
[gaim-migrate @ 5575]
Christian Hammond <chipx86@chipx86.com>
parents:
5034
diff
changeset
|
1164 * @param ops The UI operations structure. |
4481
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1165 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1166 void gaim_set_win_ui_ops(GaimWindowUiOps *ops); |
4481
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1167 |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1168 /** |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1169 * Returns the gaim window UI operations structure to be used in |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1170 * new windows. |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1171 * |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1172 * @return A filled-out GaimWindowUiOps structure. |
4481
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1173 */ |
5676
dae79aefac8d
[gaim-migrate @ 6094]
Christian Hammond <chipx86@chipx86.com>
parents:
5563
diff
changeset
|
1174 GaimWindowUiOps *gaim_get_win_ui_ops(void); |
4481
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1175 |
5872
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
1176 /** |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
1177 * Initializes the conversation subsystem. |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
1178 */ |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
1179 void gaim_conversation_init(void); |
059d95c67cda
[gaim-migrate @ 6304]
Christian Hammond <chipx86@chipx86.com>
parents:
5858
diff
changeset
|
1180 |
4481
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1181 /*@}*/ |
b30b0a02ada0
[gaim-migrate @ 4756]
Christian Hammond <chipx86@chipx86.com>
parents:
4476
diff
changeset
|
1182 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
1183 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
1184 } |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
1185 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5872
diff
changeset
|
1186 |
4890
89cb14edf8cf
[gaim-migrate @ 5220]
Christian Hammond <chipx86@chipx86.com>
parents:
4877
diff
changeset
|
1187 #endif /* _GAIM_CONVERSATION_H_ */ |