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