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