Mercurial > pidgin.yaz
comparison libpurple/request.h @ 21242:76bdbe79d40f
Document the UI hint defines and remove some bad ui_hint @param lines from
when I copied-and-pasted the documentation back to the old functions.
author | Richard Laager <rlaager@wiktel.com> |
---|---|
date | Sun, 14 Oct 2007 19:50:27 +0000 |
parents | fba1f6c3df0b |
children | a20ef7180680 b2aab3aa316b |
comparison
equal
deleted
inserted
replaced
21241:d8990c20cbee | 21242:76bdbe79d40f |
---|---|
196 | 196 |
197 void *ui_data; | 197 void *ui_data; |
198 | 198 |
199 } PurpleRequestField; | 199 } PurpleRequestField; |
200 | 200 |
201 /** | 201 /* |
202 * List of UI hints used by purple | 202 * UI hints for the request functions. These are used by libpurple. |
203 */ | |
204 | |
205 /** | |
206 * @since 2.3.0 | |
203 */ | 207 */ |
204 #define PURPLE_REQUEST_HINT_ACCOUNT "account" | 208 #define PURPLE_REQUEST_HINT_ACCOUNT "account" |
209 | |
210 /** | |
211 * @since 2.3.0 | |
212 */ | |
205 #define PURPLE_REQUEST_HINT_BLIST "blist" | 213 #define PURPLE_REQUEST_HINT_BLIST "blist" |
214 | |
215 /** | |
216 * @since 2.3.0 | |
217 */ | |
206 #define PURPLE_REQUEST_HINT_BUDDY "buddy" | 218 #define PURPLE_REQUEST_HINT_BUDDY "buddy" |
219 | |
220 /** | |
221 * @since 2.3.0 | |
222 */ | |
207 #define PURPLE_REQUEST_HINT_CONV "conversation" | 223 #define PURPLE_REQUEST_HINT_CONV "conversation" |
224 | |
225 /** | |
226 * @since 2.3.0 | |
227 */ | |
208 #define PURPLE_REQUEST_HINT_REGISTER "register-account" | 228 #define PURPLE_REQUEST_HINT_REGISTER "register-account" |
229 | |
230 /** | |
231 * @since 2.3.0 | |
232 */ | |
209 #define PURPLE_REQUEST_HINT_XFER "xfer" | 233 #define PURPLE_REQUEST_HINT_XFER "xfer" |
210 | 234 |
211 /** | 235 |
212 * List of UI hints used by purple UIs | 236 /* |
213 * We need a header file included by both pidgin and finch, but not part of | 237 * UI hints for the request functions. These are common hints used by UIs. |
214 * libpurple for these | 238 * UIs can still define any hints they like, but standardization is good. |
239 */ | |
240 | |
241 /** | |
242 * @since 2.3.0 | |
215 */ | 243 */ |
216 #define PURPLE_UI_REQUEST_HINT_ACCOUNTMGR "accountmgr" | 244 #define PURPLE_UI_REQUEST_HINT_ACCOUNTMGR "accountmgr" |
245 | |
246 /** | |
247 * @since 2.3.0 | |
248 */ | |
217 #define PURPLE_UI_REQUEST_HINT_CERTMGR "certmgr" | 249 #define PURPLE_UI_REQUEST_HINT_CERTMGR "certmgr" |
250 | |
251 /** | |
252 * @since 2.3.0 | |
253 */ | |
218 #define PURPLE_UI_REQUEST_HINT_PLUGINMGR "pluginmgr" | 254 #define PURPLE_UI_REQUEST_HINT_PLUGINMGR "pluginmgr" |
255 | |
256 /** | |
257 * @since 2.3.0 | |
258 */ | |
219 #define PURPLE_UI_REQUEST_HINT_POUNCEMGR "pouncemgr" | 259 #define PURPLE_UI_REQUEST_HINT_POUNCEMGR "pouncemgr" |
260 | |
261 /** | |
262 * @since 2.3.0 | |
263 */ | |
220 #define PURPLE_UI_REQUEST_HINT_PREFSMGR "preferences" | 264 #define PURPLE_UI_REQUEST_HINT_PREFSMGR "preferences" |
265 | |
266 /** | |
267 * @since 2.3.0 | |
268 */ | |
221 #define PURPLE_UI_REQUEST_HINT_STATUSMGR "statusmgr" | 269 #define PURPLE_UI_REQUEST_HINT_STATUSMGR "statusmgr" |
270 | |
222 | 271 |
223 /** | 272 /** |
224 * Request UI operations. | 273 * Request UI operations. |
225 */ | 274 */ |
226 typedef struct | 275 typedef struct |
1368 * @param cancel_text The text for the @c Cancel button. | 1417 * @param cancel_text The text for the @c Cancel button. |
1369 * @param cancel_cb The callback for the @c Cancel button. | 1418 * @param cancel_cb The callback for the @c Cancel button. |
1370 * @param account The PurpleAccount associated with this request, or NULL if none is | 1419 * @param account The PurpleAccount associated with this request, or NULL if none is |
1371 * @param who The username of the buddy assocaited with this request, or NULL if none is | 1420 * @param who The username of the buddy assocaited with this request, or NULL if none is |
1372 * @param conv The PurpleConversation associated with this request, or NULL if none is | 1421 * @param conv The PurpleConversation associated with this request, or NULL if none is |
1373 * @param ui_hint UI hint | |
1374 * @param user_data The data to pass to the callback. | 1422 * @param user_data The data to pass to the callback. |
1375 * | 1423 * |
1376 * @return A UI-specific handle. | 1424 * @return A UI-specific handle. |
1377 * | 1425 * |
1378 * @deprecated Please use purple_request_input_with_hint() instead. | 1426 * @deprecated Please use purple_request_input_with_hint() instead. |
1437 * @param cancel_text The text for the @c Cancel button. | 1485 * @param cancel_text The text for the @c Cancel button. |
1438 * @param cancel_cb The callback for the @c Cancel button. | 1486 * @param cancel_cb The callback for the @c Cancel button. |
1439 * @param account The PurpleAccount associated with this request, or NULL if none is | 1487 * @param account The PurpleAccount associated with this request, or NULL if none is |
1440 * @param who The username of the buddy assocaited with this request, or NULL if none is | 1488 * @param who The username of the buddy assocaited with this request, or NULL if none is |
1441 * @param conv The PurpleConversation associated with this request, or NULL if none is | 1489 * @param conv The PurpleConversation associated with this request, or NULL if none is |
1442 * @param ui_hint UI hint | |
1443 * @param user_data The data to pass to the callback. | 1490 * @param user_data The data to pass to the callback. |
1444 * @param ... The choices. This argument list should be | 1491 * @param ... The choices. This argument list should be |
1445 * terminated with a NULL parameter. | 1492 * terminated with a NULL parameter. |
1446 * | 1493 * |
1447 * @return A UI-specific handle. | 1494 * @return A UI-specific handle. |
1507 * @param cancel_text The text for the @c Cancel button. | 1554 * @param cancel_text The text for the @c Cancel button. |
1508 * @param cancel_cb The callback for the @c Cancel button. | 1555 * @param cancel_cb The callback for the @c Cancel button. |
1509 * @param account The PurpleAccount associated with this request, or NULL if none is | 1556 * @param account The PurpleAccount associated with this request, or NULL if none is |
1510 * @param who The username of the buddy assocaited with this request, or NULL if none is | 1557 * @param who The username of the buddy assocaited with this request, or NULL if none is |
1511 * @param conv The PurpleConversation associated with this request, or NULL if none is | 1558 * @param conv The PurpleConversation associated with this request, or NULL if none is |
1512 * @param ui_hint UI hint | |
1513 * @param user_data The data to pass to the callback. | 1559 * @param user_data The data to pass to the callback. |
1514 * @param choices The choices. This argument list should be | 1560 * @param choices The choices. This argument list should be |
1515 * terminated with a @c NULL parameter. | 1561 * terminated with a @c NULL parameter. |
1516 * | 1562 * |
1517 * @return A UI-specific handle. | 1563 * @return A UI-specific handle. |
1577 * @param secondary The secondary information. | 1623 * @param secondary The secondary information. |
1578 * @param default_action The default value. | 1624 * @param default_action The default value. |
1579 * @param account The PurpleAccount associated with this request, or NULL if none is | 1625 * @param account The PurpleAccount associated with this request, or NULL if none is |
1580 * @param who The username of the buddy assocaited with this request, or NULL if none is | 1626 * @param who The username of the buddy assocaited with this request, or NULL if none is |
1581 * @param conv The PurpleConversation associated with this request, or NULL if none is | 1627 * @param conv The PurpleConversation associated with this request, or NULL if none is |
1582 * @param ui_hint UI hint | |
1583 * @param user_data The data to pass to the callback. | 1628 * @param user_data The data to pass to the callback. |
1584 * @param action_count The number of actions. | 1629 * @param action_count The number of actions. |
1585 * @param ... A list of actions. These are pairs of | 1630 * @param ... A list of actions. These are pairs of |
1586 * arguments. The first of each pair is the | 1631 * arguments. The first of each pair is the |
1587 * string that appears on the button. It should | 1632 * string that appears on the button. It should |
1646 * @param secondary The secondary information. | 1691 * @param secondary The secondary information. |
1647 * @param default_action The default value. | 1692 * @param default_action The default value. |
1648 * @param account The PurpleAccount associated with this request, or NULL if none is | 1693 * @param account The PurpleAccount associated with this request, or NULL if none is |
1649 * @param who The username of the buddy assocaited with this request, or NULL if none is | 1694 * @param who The username of the buddy assocaited with this request, or NULL if none is |
1650 * @param conv The PurpleConversation associated with this request, or NULL if none is | 1695 * @param conv The PurpleConversation associated with this request, or NULL if none is |
1651 * @param ui_hint UI hint | |
1652 * @param user_data The data to pass to the callback. | 1696 * @param user_data The data to pass to the callback. |
1653 * @param action_count The number of actions. | 1697 * @param action_count The number of actions. |
1654 * @param actions A list of actions and callbacks. | 1698 * @param actions A list of actions and callbacks. |
1655 * | 1699 * |
1656 * @return A UI-specific handle. | 1700 * @return A UI-specific handle. |
1713 * @param cancel_text The text for the @c Cancel button. | 1757 * @param cancel_text The text for the @c Cancel button. |
1714 * @param cancel_cb The callback for the @c Cancel button. | 1758 * @param cancel_cb The callback for the @c Cancel button. |
1715 * @param account The PurpleAccount associated with this request, or NULL if none is | 1759 * @param account The PurpleAccount associated with this request, or NULL if none is |
1716 * @param who The username of the buddy associated with this request, or NULL if none is | 1760 * @param who The username of the buddy associated with this request, or NULL if none is |
1717 * @param conv The PurpleConversation associated with this request, or NULL if none is | 1761 * @param conv The PurpleConversation associated with this request, or NULL if none is |
1718 * @param ui_hint UI hint | |
1719 * @param user_data The data to pass to the callback. | 1762 * @param user_data The data to pass to the callback. |
1720 * | 1763 * |
1721 * @return A UI-specific handle. | 1764 * @return A UI-specific handle. |
1722 * | 1765 * |
1723 * @deprecated Please use purple_request_fields_with_hint() instead. | 1766 * @deprecated Please use purple_request_fields_with_hint() instead. |
1868 * @param ok_cb The callback for the @c OK button. | 1911 * @param ok_cb The callback for the @c OK button. |
1869 * @param cancel_cb The callback for the @c Cancel button. | 1912 * @param cancel_cb The callback for the @c Cancel button. |
1870 * @param account The PurpleAccount associated with this request, or NULL if none is | 1913 * @param account The PurpleAccount associated with this request, or NULL if none is |
1871 * @param who The username of the buddy assocaited with this request, or NULL if none is | 1914 * @param who The username of the buddy assocaited with this request, or NULL if none is |
1872 * @param conv The PurpleConversation associated with this request, or NULL if none is | 1915 * @param conv The PurpleConversation associated with this request, or NULL if none is |
1873 * @param ui_hint UI hint | |
1874 * @param user_data The data to pass to the callback. | 1916 * @param user_data The data to pass to the callback. |
1875 * | 1917 * |
1876 * @return A UI-specific handle. | 1918 * @return A UI-specific handle. |
1877 * | 1919 * |
1878 * @deprecated Please use purple_request_file_with_hint() instead. | 1920 * @deprecated Please use purple_request_file_with_hint() instead. |
1923 * @param ok_cb The callback for the @c OK button. | 1965 * @param ok_cb The callback for the @c OK button. |
1924 * @param cancel_cb The callback for the @c Cancel button. | 1966 * @param cancel_cb The callback for the @c Cancel button. |
1925 * @param account The PurpleAccount associated with this request, or NULL if none is | 1967 * @param account The PurpleAccount associated with this request, or NULL if none is |
1926 * @param who The username of the buddy assocaited with this request, or NULL if none is | 1968 * @param who The username of the buddy assocaited with this request, or NULL if none is |
1927 * @param conv The PurpleConversation associated with this request, or NULL if none is | 1969 * @param conv The PurpleConversation associated with this request, or NULL if none is |
1928 * @param ui_hint UI hint | |
1929 * @param user_data The data to pass to the callback. | 1970 * @param user_data The data to pass to the callback. |
1930 * | 1971 * |
1931 * @return A UI-specific handle. | 1972 * @return A UI-specific handle. |
1932 * | 1973 * |
1933 * @deprecated Please use purple_request_folder_with_hint() instead. | 1974 * @deprecated Please use purple_request_folder_with_hint() instead. |