Mercurial > pidgin
annotate src/prpl.h @ 11243:a511b77a368b
[gaim-migrate @ 13408]
sf patch #1246384, from shiyee
"This patch globally defines
spacings and boreders according to the Gnome Human
Interfaces Guidelines, and uses those defines where
appropriate. No visual changes are made, but the the
intention is that the defines should help promote
uniformness."
committer: Tailor Script <tailor@pidgin.im>
author | Mark Doliner <mark@kingant.net> |
---|---|
date | Fri, 12 Aug 2005 23:53:28 +0000 |
parents | 11e465b55fe6 |
children | 90be432e8385 |
rev | line source |
---|---|
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
1 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
2 * @file prpl.h Protocol Plugin functions |
5034
4691c5936c01
[gaim-migrate @ 5377]
Christian Hammond <chipx86@chipx86.com>
parents:
4966
diff
changeset
|
3 * @ingroup core |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
4 * |
981 | 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. | |
6451
6f16136b41e5
[gaim-migrate @ 6960]
Christian Hammond <chipx86@chipx86.com>
parents:
6418
diff
changeset
|
10 * |
981 | 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 | |
24 */ | |
25 | |
2417
5473c8c5378d
[gaim-migrate @ 2430]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2411
diff
changeset
|
26 /* this file should be all that prpls need to include. therefore, by including |
5473c8c5378d
[gaim-migrate @ 2430]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2411
diff
changeset
|
27 * this file, they should get glib, proxy, gaim_connection, prpl, etc. */ |
981 | 28 |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
29 #ifndef _GAIM_PRPL_H_ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
30 #define _GAIM_PRPL_H_ |
2417
5473c8c5378d
[gaim-migrate @ 2430]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2411
diff
changeset
|
31 |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
32 typedef struct _GaimPluginProtocolInfo GaimPluginProtocolInfo; |
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
33 |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
34 /**************************************************************************/ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
35 /** @name Basic Protocol Information */ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
36 /**************************************************************************/ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
37 |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
38 /** |
6622 | 39 * Flags applicable to outgoing/incoming IMs from prpls. |
40 */ | |
41 typedef enum | |
42 { | |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7015
diff
changeset
|
43 GAIM_CONV_IM_AUTO_RESP = 0x0001, /**< Auto response. */ |
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7015
diff
changeset
|
44 GAIM_CONV_IM_IMAGES = 0x0002 /**< Contains images. */ |
9584 | 45 } GaimConvImFlags; |
8749
d7b8eb1f0a18
[gaim-migrate @ 9504]
Christian Hammond <chipx86@chipx86.com>
parents:
8713
diff
changeset
|
46 |
9584 | 47 typedef enum |
48 { | |
49 GAIM_CONV_CHAT_WHISPER = 0x0001, /**< Whispered message.*/ | |
10104 | 50 GAIM_CONV_CHAT_DELAYED = 0x0002, /**< Delayed message. */ |
51 GAIM_CONV_CHAT_ALERT = 0x0004 /**< Alert message. */ | |
9584 | 52 } GaimConvChatFlags; |
6622 | 53 |
9318 | 54 typedef enum { |
55 GAIM_ICON_SCALE_DISPLAY = 0x01, /**< We scale the icon when we display it */ | |
56 GAIM_ICON_SCALE_SEND = 0x02 /**< We scale the icon before we send it to the server */ | |
57 } GaimIconScaleRules; | |
58 | |
59 | |
9308 | 60 /** |
61 * A description of a Buddy Icon specification. This tells Gaim what kind of image file | |
62 * it should give this prpl, and what kind of image file it should expect back. | |
9316 | 63 * Dimensions less than 1 should be ignored and the image not scaled. |
9308 | 64 */ |
65 typedef struct { | |
66 char *format; /**< This is a comma-delimited list of image formats or NULL if icons are not supported. | |
67 * The core nor the prpl will actually check to see if the data it's given matches this, it's entirely | |
68 * up to the UI to do what it wants */ | |
9318 | 69 int min_width; /**< The minimum width of this icon */ |
70 int min_height; /**< The minimum height of this icon */ | |
71 int max_width; /**< The maximum width of this icon */ | |
72 int max_height; /**< The maximum height of this icon */ | |
73 GaimIconScaleRules scale_rules; /**< How to stretch this icon */ | |
9308 | 74 } GaimBuddyIconSpec; |
75 | |
9999 | 76 /** |
11035
11e465b55fe6
[gaim-migrate @ 12922]
Gary Kramlich <grim@reaperworld.com>
parents:
10870
diff
changeset
|
77 * This \#define exists just to make it easier to fill out the buddy icon |
9999 | 78 * field in the prpl info struct for protocols that couldn't care less. |
79 */ | |
9318 | 80 #define NO_BUDDY_ICONS {NULL, 0, 0, 0, 0, 0} |
9308 | 81 |
8573 | 82 #include "blist.h" |
83 #include "proxy.h" | |
84 #include "plugin.h" | |
9999 | 85 #include "roomlist.h" |
9944 | 86 #include "status.h" |
8573 | 87 |
9713 | 88 struct proto_chat_entry { |
89 char *label; | |
90 char *identifier; | |
10475 | 91 gboolean required; |
9713 | 92 gboolean is_int; |
93 int min; | |
94 int max; | |
95 gboolean secret; | |
96 }; | |
97 | |
6622 | 98 /** |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
99 * Protocol options |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
100 * |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
101 * These should all be stuff that some plugins can do and others can't. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
102 */ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
103 typedef enum |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
104 { |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
105 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
106 * Use a unique name, not an alias, for chat rooms. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
107 * |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
108 * Jabber lets you choose what name you want for chat. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
109 * So it shouldn't be pulling the alias for when you're in chat; |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
110 * it gets annoying. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
111 */ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
112 OPT_PROTO_UNIQUE_CHATNAME = 0x00000004, |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
113 |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
114 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
115 * Chat rooms have topics. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
116 * |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
117 * IRC and Jabber support this. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
118 */ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
119 OPT_PROTO_CHAT_TOPIC = 0x00000008, |
1370
776bb4c6c0b8
[gaim-migrate @ 1380]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
1355
diff
changeset
|
120 |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
121 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
122 * Don't require passwords for sign-in. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
123 * |
9999 | 124 * Zephyr doesn't require passwords, so there's no |
125 * need for a password prompt. | |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
126 */ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
127 OPT_PROTO_NO_PASSWORD = 0x00000010, |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
128 |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
129 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
130 * Notify on new mail. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
131 * |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
132 * MSN and Yahoo notify you when you have new mail. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
133 */ |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
134 OPT_PROTO_MAIL_CHECK = 0x00000020, |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
135 |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
136 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
137 * Images in IMs. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
138 * |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
139 * Oscar lets you send images in direct IMs. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
140 */ |
9999 | 141 OPT_PROTO_IM_IMAGE = 0x00000040, |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
142 |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
143 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
144 * Allow passwords to be optional. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
145 * |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
146 * Passwords in IRC are optional, and are needed for certain |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
147 * functionality. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
148 */ |
9999 | 149 OPT_PROTO_PASSWORD_OPTIONAL = 0x00000080, |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
150 |
5367 | 151 /** |
152 * Allows font size to be specified in sane point size | |
153 * | |
154 * Probably just Jabber and Y!M | |
155 */ | |
9999 | 156 OPT_PROTO_USE_POINTSIZE = 0x00000100 |
5367 | 157 |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
158 } GaimProtocolOptions; |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
159 |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
160 /** |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
161 * A protocol plugin information structure. |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
162 * |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
163 * Every protocol plugin initializes this structure. It is the gateway |
10160 | 164 * between gaim and the protocol plugin. Many of this callbacks can be |
10162 | 165 * NULL. If a callback must be implemented, it has a comment indicating so. |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
166 */ |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
167 struct _GaimPluginProtocolInfo |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
168 { |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
169 GaimProtocolOptions options; /**< Protocol options. */ |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
170 |
5638
0bdfa28c678e
[gaim-migrate @ 6047]
Christian Hammond <chipx86@chipx86.com>
parents:
5573
diff
changeset
|
171 GList *user_splits; /* A GList of GaimAccountUserSplit */ |
0bdfa28c678e
[gaim-migrate @ 6047]
Christian Hammond <chipx86@chipx86.com>
parents:
5573
diff
changeset
|
172 GList *protocol_options; /* A GList of GaimAccountOption */ |
10160 | 173 |
9308 | 174 GaimBuddyIconSpec icon_spec; /* The icon spec. */ |
10160 | 175 |
6451
6f16136b41e5
[gaim-migrate @ 6960]
Christian Hammond <chipx86@chipx86.com>
parents:
6418
diff
changeset
|
176 /** |
6f16136b41e5
[gaim-migrate @ 6960]
Christian Hammond <chipx86@chipx86.com>
parents:
6418
diff
changeset
|
177 * Returns the base icon name for the given buddy and account. |
10160 | 178 * If buddy is NULL, it will return the name to use for the account's |
179 * icon. This must be implemented. | |
4687 | 180 */ |
6695 | 181 const char *(*list_icon)(GaimAccount *account, GaimBuddy *buddy); |
4687 | 182 |
183 /** | |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
184 * Fills the four char**'s with string identifiers for "emblems" |
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
185 * that the UI will interpret and display as relevant |
4687 | 186 */ |
9952 | 187 void (*list_emblems)(GaimBuddy *buddy, const char **se, const char **sw, |
188 const char **nw, const char **ne); | |
4722 | 189 |
190 /** | |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
191 * Gets a short string representing this buddy's status. This will |
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
192 * be shown on the buddy list. |
4722 | 193 */ |
6695 | 194 char *(*status_text)(GaimBuddy *buddy); |
6451
6f16136b41e5
[gaim-migrate @ 6960]
Christian Hammond <chipx86@chipx86.com>
parents:
6418
diff
changeset
|
195 |
4724 | 196 /** |
197 * Gets a string to put in the buddy list tooltip. | |
198 */ | |
6695 | 199 char *(*tooltip_text)(GaimBuddy *buddy); |
6451
6f16136b41e5
[gaim-migrate @ 6960]
Christian Hammond <chipx86@chipx86.com>
parents:
6418
diff
changeset
|
200 |
10200 | 201 /** |
202 * This must be implemented, and must add at least the offline | |
203 * and online states. | |
204 */ | |
9950 | 205 GList *(*status_types)(GaimAccount *account); |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
206 |
9030 | 207 GList *(*blist_node_menu)(GaimBlistNode *node); |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
208 GList *(*chat_info)(GaimConnection *); |
9754 | 209 GHashTable *(*chat_info_defaults)(GaimConnection *, const char *chat_name); |
1333
b332d8f46b84
[gaim-migrate @ 1343]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
1318
diff
changeset
|
210 |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
211 /* All the server-related functions */ |
10160 | 212 |
213 /** This must be implemented. */ | |
10400 | 214 void (*login)(GaimAccount *, GaimStatus *); |
10160 | 215 |
216 /** This must be implemented. */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
217 void (*close)(GaimConnection *); |
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
218 int (*send_im)(GaimConnection *, const char *who, |
6982 | 219 const char *message, |
7118
bf630f7dfdcd
[gaim-migrate @ 7685]
Christian Hammond <chipx86@chipx86.com>
parents:
7015
diff
changeset
|
220 GaimConvImFlags flags); |
5954 | 221 void (*set_info)(GaimConnection *, const char *info); |
6059 | 222 int (*send_typing)(GaimConnection *, const char *name, int typing); |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
223 void (*get_info)(GaimConnection *, const char *who); |
9949 | 224 void (*set_status)(GaimAccount *account, GaimStatus *status); |
225 | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
226 void (*set_idle)(GaimConnection *, int idletime); |
5946
209cae24a51d
[gaim-migrate @ 6387]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
227 void (*change_passwd)(GaimConnection *, const char *old_pass, |
209cae24a51d
[gaim-migrate @ 6387]
Christian Hammond <chipx86@chipx86.com>
parents:
5944
diff
changeset
|
228 const char *new_pass); |
9285 | 229 void (*add_buddy)(GaimConnection *, GaimBuddy *buddy, GaimGroup *group); |
230 void (*add_buddies)(GaimConnection *, GList *buddies, GList *groups); | |
231 void (*remove_buddy)(GaimConnection *, GaimBuddy *buddy, GaimGroup *group); | |
232 void (*remove_buddies)(GaimConnection *, GList *buddies, GList *groups); | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
233 void (*add_permit)(GaimConnection *, const char *name); |
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
234 void (*add_deny)(GaimConnection *, const char *name); |
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
235 void (*rem_permit)(GaimConnection *, const char *name); |
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
236 void (*rem_deny)(GaimConnection *, const char *name); |
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
237 void (*set_permit_deny)(GaimConnection *); |
9753 | 238 void (*warn)(GaimConnection *, const char *who, gboolean anonymous); |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
239 void (*join_chat)(GaimConnection *, GHashTable *components); |
8562 | 240 void (*reject_chat)(GaimConnection *, GHashTable *components); |
9917 | 241 char *(*get_chat_name)(GHashTable *components); |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
242 void (*chat_invite)(GaimConnection *, int id, |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
243 const char *who, const char *message); |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
244 void (*chat_leave)(GaimConnection *, int id); |
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
245 void (*chat_whisper)(GaimConnection *, int id, |
6059 | 246 const char *who, const char *message); |
247 int (*chat_send)(GaimConnection *, int id, const char *message); | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
248 void (*keepalive)(GaimConnection *); |
1713
14caa7df478c
[gaim-migrate @ 1723]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
1626
diff
changeset
|
249 |
2827
51999a36c0b1
[gaim-migrate @ 2840]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2773
diff
changeset
|
250 /* new user registration */ |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
251 void (*register_user)(GaimAccount *); |
2956 | 252 |
253 /* get "chat buddy" info and away message */ | |
6059 | 254 void (*get_cb_info)(GaimConnection *, int, const char *who); |
255 void (*get_cb_away)(GaimConnection *, int, const char *who); | |
2827
51999a36c0b1
[gaim-migrate @ 2840]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2773
diff
changeset
|
256 |
3136 | 257 /* save/store buddy's alias on server list/roster */ |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
258 void (*alias_buddy)(GaimConnection *, const char *who, |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
259 const char *alias); |
3136 | 260 |
261 /* change a buddy's group on a server list/roster */ | |
5563
9eb5b13fd412
[gaim-migrate @ 5965]
Christian Hammond <chipx86@chipx86.com>
parents:
5538
diff
changeset
|
262 void (*group_buddy)(GaimConnection *, const char *who, |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
263 const char *old_group, const char *new_group); |
3136 | 264 |
3348 | 265 /* rename a group on a server list/roster */ |
9285 | 266 void (*rename_group)(GaimConnection *, const char *old_name, |
267 GaimGroup *group, GList *moved_buddies); | |
3348 | 268 |
6695 | 269 void (*buddy_free)(GaimBuddy *); |
2607
e0d4a23aac89
[gaim-migrate @ 2620]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2582
diff
changeset
|
270 |
6059 | 271 void (*convo_closed)(GaimConnection *, const char *who); |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
272 |
7322 | 273 const char *(*normalize)(const GaimAccount *, const char *); |
6451
6f16136b41e5
[gaim-migrate @ 6960]
Christian Hammond <chipx86@chipx86.com>
parents:
6418
diff
changeset
|
274 |
5842 | 275 void (*set_buddy_icon)(GaimConnection *, const char *filename); |
6885
66dd420d3d23
[gaim-migrate @ 7431]
Christian Hammond <chipx86@chipx86.com>
parents:
6846
diff
changeset
|
276 |
9285 | 277 void (*remove_group)(GaimConnection *gc, GaimGroup *group); |
7398 | 278 |
279 char *(*get_cb_real_name)(GaimConnection *gc, int id, const char *who); | |
7971 | 280 |
281 void (*set_chat_topic)(GaimConnection *gc, int id, const char *topic); | |
7999 | 282 |
283 GaimChat *(*find_blist_chat)(GaimAccount *account, const char *name); | |
8113 | 284 |
285 /* room listing prpl callbacks */ | |
9999 | 286 GaimRoomlist *(*roomlist_get_list)(GaimConnection *gc); |
287 void (*roomlist_cancel)(GaimRoomlist *list); | |
288 void (*roomlist_expand_category)(GaimRoomlist *list, GaimRoomlistRoom *category); | |
9466 | 289 |
290 /* file transfer callbacks */ | |
291 gboolean (*can_receive_file)(GaimConnection *, const char *who); | |
292 void (*send_file)(GaimConnection *, const char *who, const char *filename); | |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
293 }; |
2246
933346315b9b
[gaim-migrate @ 2256]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2232
diff
changeset
|
294 |
5205
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
295 #define GAIM_IS_PROTOCOL_PLUGIN(plugin) \ |
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
296 ((plugin)->info->type == GAIM_PLUGIN_PROTOCOL) |
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
297 |
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
298 #define GAIM_PLUGIN_PROTOCOL_INFO(plugin) \ |
fefad67de2c7
[gaim-migrate @ 5573]
Christian Hammond <chipx86@chipx86.com>
parents:
5148
diff
changeset
|
299 ((GaimPluginProtocolInfo *)(plugin)->info->extra_info) |
981 | 300 |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
301 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
302 extern "C" { |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
303 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
304 |
9944 | 305 /**************************************************************************/ |
306 /** @name Protocol Plugin API */ | |
307 /**************************************************************************/ | |
308 /*@{*/ | |
309 | |
310 /** | |
311 * Notifies Gaim that an account's idle state and time have changed. | |
312 * | |
313 * This is meant to be called from protocol plugins. | |
314 * | |
315 * @param account The account. | |
316 * @param idle The user's idle state. | |
317 * @param idle_time The user's idle time. | |
318 */ | |
319 void gaim_prpl_got_account_idle(GaimAccount *account, gboolean idle, | |
320 time_t idle_time); | |
321 | |
322 /** | |
323 * Notifies Gaim of an account's log-in time. | |
324 * | |
325 * This is meant to be called from protocol plugins. | |
326 * | |
327 * @param account The account the user is on. | |
328 * @param login_time The user's log-in time. | |
329 */ | |
10870 | 330 void gaim_prpl_got_account_login_time(GaimAccount *account, time_t login_time); |
9944 | 331 |
332 /** | |
333 * Notifies Gaim that an account's status has changed. | |
334 * | |
335 * This is meant to be called from protocol plugins. | |
336 * | |
337 * @param account The account the user is on. | |
338 * @param status_id The status ID. | |
339 * @param attr_id The first attribute ID, or NULL for no attribute updates. | |
340 * @param ... A NULL-terminated list of attribute IDs and values, | |
341 * beginning with the value for @a attr_id. | |
342 */ | |
343 void gaim_prpl_got_account_status(GaimAccount *account, | |
344 const char *status_id, const char *attr_id, | |
345 ...); | |
346 | |
347 /** | |
348 * Notifies Gaim that an account's warning level has changed. | |
349 * | |
350 * This is meant to be called from protocol plugins. | |
351 * | |
352 * @param account The account the user is on. | |
353 * @param username The user that warned the account. | |
354 * @param level The new warning level. | |
355 */ | |
356 void gaim_prpl_got_account_warning_level(GaimAccount *account, | |
357 const char *username, | |
358 unsigned int level); | |
359 | |
360 | |
361 /** | |
362 * Notifies Gaim that a user's idle state and time have changed. | |
363 * | |
364 * This is meant to be called from protocol plugins. | |
365 * | |
366 * @param account The account the user is on. | |
367 * @param name The screen name of the user. | |
368 * @param idle The user's idle state. | |
10860 | 369 * @param idle_time The user's idle time. This is the time at |
370 * which the user became idle, in seconds since | |
371 * the epoch. | |
9944 | 372 */ |
373 void gaim_prpl_got_user_idle(GaimAccount *account, const char *name, | |
374 gboolean idle, time_t idle_time); | |
375 | |
376 /** | |
377 * Notifies Gaim of a user's log-in time. | |
378 * | |
379 * This is meant to be called from protocol plugins. | |
380 * | |
381 * @param account The account the user is on. | |
382 * @param name The screen name of the user. | |
383 * @param login_time The user's log-in time. | |
384 */ | |
385 void gaim_prpl_got_user_login_time(GaimAccount *account, const char *name, | |
386 time_t login_time); | |
387 | |
388 /** | |
389 * Notifies Gaim that a user's status has changed. | |
390 * | |
391 * This is meant to be called from protocol plugins. | |
392 * | |
393 * @param account The account the user is on. | |
394 * @param name The screen name of the user. | |
395 * @param status_id The status ID. | |
396 * @param attr_id The first attribute ID, or NULL for no attribute updates. | |
397 * @param ... A NULL-terminated list of attribute IDs and values, | |
398 * beginning with the value for @a attr_id. | |
399 */ | |
400 void gaim_prpl_got_user_status(GaimAccount *account, const char *name, | |
401 const char *status_id, const char *attr_id, ...); | |
402 | |
403 /** | |
404 * Notifies Gaim that a user's warning level has changed. | |
405 * | |
406 * This is meant to be called from protocol plugins. | |
407 * | |
408 * @param account The account the user is on. | |
409 * @param name The screen name of the user. | |
410 * @param level The new warning level. | |
411 */ | |
412 void gaim_prpl_got_user_warning_level(GaimAccount *account, const char *name, | |
413 unsigned int level); | |
414 | |
415 /** | |
416 * Informs the server that an account's status changed. | |
417 * | |
10447 | 418 * @param account The account the user is on. |
419 * @param old_status The previous status. | |
420 * @param new_status The status that was activated, or deactivated | |
421 * (in the case of independent statuses). | |
9944 | 422 */ |
10447 | 423 void gaim_prpl_change_account_status(GaimAccount *account, |
424 GaimStatus *old_status, | |
425 GaimStatus *new_status); | |
9944 | 426 |
10006 | 427 /** |
428 * Retrieves the list of stock status types from a prpl. | |
429 * | |
430 * @param account The account the user is on. | |
431 * @param presence The presence for which we're going to get statuses | |
432 * | |
433 * @return List of statuses | |
434 */ | |
435 GList *gaim_prpl_get_statuses(GaimAccount *account, GaimPresence *presence); | |
436 | |
9944 | 437 /*@}*/ |
438 | |
439 /**************************************************************************/ | |
440 /** @name Protocol Plugin Subsystem API */ | |
441 /**************************************************************************/ | |
442 /*@{*/ | |
443 | |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
444 /** |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
445 * Finds a protocol plugin structure of the specified type. |
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
446 * |
9000 | 447 * @param id The protocol plugin; |
4557
53ce3af93edb
[gaim-migrate @ 4837]
Christian Hammond <chipx86@chipx86.com>
parents:
4514
diff
changeset
|
448 */ |
7956 | 449 GaimPlugin *gaim_find_prpl(const char *id); |
981 | 450 |
9944 | 451 /*@}*/ |
452 | |
5944
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
453 #ifdef __cplusplus |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
454 } |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
455 #endif |
158196b2db19
[gaim-migrate @ 6385]
Christian Hammond <chipx86@chipx86.com>
parents:
5943
diff
changeset
|
456 |
2417
5473c8c5378d
[gaim-migrate @ 2430]
Eric Warmenhoven <eric@warmenhoven.org>
parents:
2411
diff
changeset
|
457 #endif /* _PRPL_H_ */ |