comparison libpurple/request.h @ 21338:a0769bab5a3d

disapproval of revision '2ce5a939a395a946ffcf7f9c862b4c54aba7457f'
author Richard Laager <rlaager@wiktel.com>
date Fri, 16 Nov 2007 22:59:48 +0000
parents 110f23ef3542
children
comparison
equal deleted inserted replaced
21233:110f23ef3542 21338:a0769bab5a3d
1301 * @param conv The PurpleConversation associated with this request, or NULL if none is 1301 * @param conv The PurpleConversation associated with this request, or NULL if none is
1302 * @param ui_hint UI hint 1302 * @param ui_hint UI hint
1303 * @param user_data The data to pass to the callback. 1303 * @param user_data The data to pass to the callback.
1304 * 1304 *
1305 * @return A UI-specific handle. 1305 * @return A UI-specific handle.
1306 *
1307 * @since 2.3.0
1308 */ 1306 */
1309 void *purple_request_input_with_hint(void *handle, const char *title, 1307 void *purple_request_input_with_hint(void *handle, const char *title,
1310 const char *primary, const char *secondary, 1308 const char *primary, const char *secondary,
1311 const char *default_value, 1309 const char *default_value,
1312 gboolean multiline, gboolean masked, gchar *hint, 1310 gboolean multiline, gboolean masked, gchar *hint,
1314 const char *cancel_text, GCallback cancel_cb, 1312 const char *cancel_text, GCallback cancel_cb,
1315 PurpleAccount *account, const char *who, PurpleConversation *conv, 1313 PurpleAccount *account, const char *who, PurpleConversation *conv,
1316 const char *ui_hint, void *user_data); 1314 const char *ui_hint, void *user_data);
1317 1315
1318 /** 1316 /**
1319 * Prompts the user for text input.
1320 *
1321 * @param handle The plugin or connection handle. For some
1322 * things this is EXTREMELY important. The
1323 * handle is used to programmatically close
1324 * the request dialog when it is no longer
1325 * needed. For PRPLs this is often a pointer
1326 * to the PurpleConnection instance. For plugins
1327 * this should be a similar, unique memory
1328 * location. This value is important because
1329 * it allows a request to be closed, say, when
1330 * you sign offline. If the request is NOT
1331 * closed it is VERY likely to cause a crash
1332 * whenever the callback handler functions are
1333 * triggered.
1334 * @param title The title of the message.
1335 * @param primary The main point of the message.
1336 * @param secondary The secondary information.
1337 * @param default_value The default value.
1338 * @param multiline TRUE if the inputted text can span multiple lines.
1339 * @param masked TRUE if the inputted text should be masked in some way.
1340 * @param hint Optionally suggest how the input box should appear.
1341 * Use "html," for example, to allow the user to enter
1342 * HTML.
1343 * @param ok_text The text for the @c OK button.
1344 * @param ok_cb The callback for the @c OK button.
1345 * @param cancel_text The text for the @c Cancel button.
1346 * @param cancel_cb The callback for the @c Cancel button.
1347 * @param account The PurpleAccount associated with this request, or NULL if none is
1348 * @param who The username of the buddy assocaited with this request, or NULL if none is
1349 * @param conv The PurpleConversation associated with this request, or NULL if none is
1350 * @param ui_hint UI hint
1351 * @param user_data The data to pass to the callback.
1352 *
1353 * @return A UI-specific handle.
1354 *
1355 * @deprecated Please use purple_request_input_with_hint() instead. 1317 * @deprecated Please use purple_request_input_with_hint() instead.
1356 */ 1318 */
1357 void *purple_request_input(void *handle, const char *title, 1319 void *purple_request_input(void *handle, const char *title,
1358 const char *primary, const char *secondary, 1320 const char *primary, const char *secondary,
1359 const char *default_value, 1321 const char *default_value,
1384 * @param user_data The data to pass to the callback. 1346 * @param user_data The data to pass to the callback.
1385 * @param ... The choices. This argument list should be 1347 * @param ... The choices. This argument list should be
1386 * terminated with a NULL parameter. 1348 * terminated with a NULL parameter.
1387 * 1349 *
1388 * @return A UI-specific handle. 1350 * @return A UI-specific handle.
1389 *
1390 * @since 2.3.0
1391 */ 1351 */
1392 void *purple_request_choice_with_hint(void *handle, const char *title, 1352 void *purple_request_choice_with_hint(void *handle, const char *title,
1393 const char *primary, const char *secondary, 1353 const char *primary, const char *secondary,
1394 int default_value, 1354 int default_value,
1395 const char *ok_text, GCallback ok_cb, 1355 const char *ok_text, GCallback ok_cb,
1396 const char *cancel_text, GCallback cancel_cb, 1356 const char *cancel_text, GCallback cancel_cb,
1397 PurpleAccount *account, const char *who, PurpleConversation *conv, 1357 PurpleAccount *account, const char *who, PurpleConversation *conv,
1398 const char *ui_hint, void *user_data, ...) G_GNUC_NULL_TERMINATED; 1358 const char *ui_hint, void *user_data, ...) G_GNUC_NULL_TERMINATED;
1399 1359
1400 /** 1360 /**
1401 * Prompts the user for multiple-choice input.
1402 *
1403 * @param handle The plugin or connection handle. For some
1404 * things this is EXTREMELY important. See
1405 * the comments on purple_request_input.
1406 * @param title The title of the message.
1407 * @param primary The main point of the message.
1408 * @param secondary The secondary information.
1409 * @param default_value The default value.
1410 * @param ok_text The text for the @c OK button.
1411 * @param ok_cb The callback for the @c OK button.
1412 * @param cancel_text The text for the @c Cancel button.
1413 * @param cancel_cb The callback for the @c Cancel button.
1414 * @param account The PurpleAccount associated with this request, or NULL if none is
1415 * @param who The username of the buddy assocaited with this request, or NULL if none is
1416 * @param conv The PurpleConversation associated with this request, or NULL if none is
1417 * @param ui_hint UI hint
1418 * @param user_data The data to pass to the callback.
1419 * @param ... The choices. This argument list should be
1420 * terminated with a NULL parameter.
1421 *
1422 * @return A UI-specific handle.
1423 *
1424 * @deprecated Please use purple_request_choice_with_hint() instead. 1361 * @deprecated Please use purple_request_choice_with_hint() instead.
1425 */ 1362 */
1426 void *purple_request_choice(void *handle, const char *title, 1363 void *purple_request_choice(void *handle, const char *title,
1427 const char *primary, const char *secondary, 1364 const char *primary, const char *secondary,
1428 int default_value, 1365 int default_value,
1452 * @param user_data The data to pass to the callback. 1389 * @param user_data The data to pass to the callback.
1453 * @param choices The choices. This argument list should be 1390 * @param choices The choices. This argument list should be
1454 * terminated with a @c NULL parameter. 1391 * terminated with a @c NULL parameter.
1455 * 1392 *
1456 * @return A UI-specific handle. 1393 * @return A UI-specific handle.
1457 *
1458 * @since 2.3.0
1459 */ 1394 */
1460 void *purple_request_choice_varg_with_hint(void *handle, const char *title, 1395 void *purple_request_choice_varg_with_hint(void *handle, const char *title,
1461 const char *primary, const char *secondary, 1396 const char *primary, const char *secondary,
1462 int default_value, 1397 int default_value,
1463 const char *ok_text, GCallback ok_cb, 1398 const char *ok_text, GCallback ok_cb,
1464 const char *cancel_text, GCallback cancel_cb, 1399 const char *cancel_text, GCallback cancel_cb,
1465 PurpleAccount *account, const char *who, PurpleConversation *conv, 1400 PurpleAccount *account, const char *who, PurpleConversation *conv,
1466 const char *ui_hint, void *user_data, va_list choices); 1401 const char *ui_hint, void *user_data, va_list choices);
1467 1402
1468 /** 1403 /**
1469 * Prompts the user for multiple-choice input.
1470 *
1471 * @param handle The plugin or connection handle. For some
1472 * things this is EXTREMELY important. See
1473 * the comments on purple_request_input.
1474 * @param title The title of the message.
1475 * @param primary The main point of the message.
1476 * @param secondary The secondary information.
1477 * @param default_value The default value.
1478 * @param ok_text The text for the @c OK button.
1479 * @param ok_cb The callback for the @c OK button.
1480 * @param cancel_text The text for the @c Cancel button.
1481 * @param cancel_cb The callback for the @c Cancel button.
1482 * @param account The PurpleAccount associated with this request, or NULL if none is
1483 * @param who The username of the buddy assocaited with this request, or NULL if none is
1484 * @param conv The PurpleConversation associated with this request, or NULL if none is
1485 * @param ui_hint UI hint
1486 * @param user_data The data to pass to the callback.
1487 * @param choices The choices. This argument list should be
1488 * terminated with a @c NULL parameter.
1489 *
1490 * @return A UI-specific handle.
1491 *
1492 * @deprecated Please use purple_request_choice_varg_with_hint() instead. 1404 * @deprecated Please use purple_request_choice_varg_with_hint() instead.
1493 */ 1405 */
1494 void *purple_request_choice_varg(void *handle, const char *title, 1406 void *purple_request_choice_varg(void *handle, const char *title,
1495 const char *primary, const char *secondary, 1407 const char *primary, const char *secondary,
1496 int default_value, 1408 int default_value,
1524 * to use as the accelerator key for the button. 1436 * to use as the accelerator key for the button.
1525 * The second of each pair is the callback 1437 * The second of each pair is the callback
1526 * function to use when the button is clicked. 1438 * function to use when the button is clicked.
1527 * 1439 *
1528 * @return A UI-specific handle. 1440 * @return A UI-specific handle.
1529 *
1530 * @since 2.3.0
1531 */ 1441 */
1532 void *purple_request_action_with_hint(void *handle, const char *title, 1442 void *purple_request_action_with_hint(void *handle, const char *title,
1533 const char *primary, const char *secondary, 1443 const char *primary, const char *secondary,
1534 int default_action, 1444 int default_action,
1535 PurpleAccount *account, const char *who, PurpleConversation *conv, 1445 PurpleAccount *account, const char *who, PurpleConversation *conv,
1536 const char *ui_hint, void *user_data, size_t action_count, ...); 1446 const char *ui_hint, void *user_data, size_t action_count, ...);
1537 1447
1538 /** 1448 /**
1539 * Prompts the user for an action.
1540 *
1541 * This is often represented as a dialog with a button for each action.
1542 *
1543 * @param handle The plugin or connection handle. For some
1544 * things this is EXTREMELY important. See
1545 * the comments on purple_request_input.
1546 * @param title The title of the message.
1547 * @param primary The main point of the message.
1548 * @param secondary The secondary information.
1549 * @param default_action The default value.
1550 * @param account The PurpleAccount associated with this request, or NULL if none is
1551 * @param who The username of the buddy assocaited with this request, or NULL if none is
1552 * @param conv The PurpleConversation associated with this request, or NULL if none is
1553 * @param ui_hint UI hint
1554 * @param user_data The data to pass to the callback.
1555 * @param action_count The number of actions.
1556 * @param ... A list of actions. These are pairs of
1557 * arguments. The first of each pair is the
1558 * string that appears on the button. It should
1559 * have an underscore before the letter you want
1560 * to use as the accelerator key for the button.
1561 * The second of each pair is the callback
1562 * function to use when the button is clicked.
1563 *
1564 * @return A UI-specific handle.
1565 *
1566 * @deprecated Please use purple_request_action_with_hint() instead. 1449 * @deprecated Please use purple_request_action_with_hint() instead.
1567 */ 1450 */
1568 void *purple_request_action(void *handle, const char *title, 1451 void *purple_request_action(void *handle, const char *title,
1569 const char *primary, const char *secondary, 1452 const char *primary, const char *secondary,
1570 int default_action, 1453 int default_action,
1590 * @param user_data The data to pass to the callback. 1473 * @param user_data The data to pass to the callback.
1591 * @param action_count The number of actions. 1474 * @param action_count The number of actions.
1592 * @param actions A list of actions and callbacks. 1475 * @param actions A list of actions and callbacks.
1593 * 1476 *
1594 * @return A UI-specific handle. 1477 * @return A UI-specific handle.
1595 *
1596 * @since 2.3.0
1597 */ 1478 */
1598 void *purple_request_action_varg_with_hint(void *handle, const char *title, 1479 void *purple_request_action_varg_with_hint(void *handle, const char *title,
1599 const char *primary, const char *secondary, 1480 const char *primary, const char *secondary,
1600 int default_action, 1481 int default_action,
1601 PurpleAccount *account, const char *who, PurpleConversation *conv, 1482 PurpleAccount *account, const char *who, PurpleConversation *conv,
1602 const char *ui_hint, void *user_data, size_t action_count, 1483 const char *ui_hint, void *user_data, size_t action_count,
1603 va_list actions); 1484 va_list actions);
1604 1485
1605 /** 1486 /**
1606 * Prompts the user for an action.
1607 *
1608 * This is often represented as a dialog with a button for each action.
1609 *
1610 * @param handle The plugin or connection handle. For some
1611 * things this is EXTREMELY important. See
1612 * the comments on purple_request_input.
1613 * @param title The title of the message.
1614 * @param primary The main point of the message.
1615 * @param secondary The secondary information.
1616 * @param default_action The default value.
1617 * @param account The PurpleAccount associated with this request, or NULL if none is
1618 * @param who The username of the buddy assocaited with this request, or NULL if none is
1619 * @param conv The PurpleConversation associated with this request, or NULL if none is
1620 * @param ui_hint UI hint
1621 * @param user_data The data to pass to the callback.
1622 * @param action_count The number of actions.
1623 * @param actions A list of actions and callbacks.
1624 *
1625 * @return A UI-specific handle.
1626 *
1627 * @deprecated Please use purple_request_action_varg_with_hint() instead. 1487 * @deprecated Please use purple_request_action_varg_with_hint() instead.
1628 */ 1488 */
1629 void *purple_request_action_varg(void *handle, const char *title, 1489 void *purple_request_action_varg(void *handle, const char *title,
1630 const char *primary, const char *secondary, 1490 const char *primary, const char *secondary,
1631 int default_action, 1491 int default_action,
1652 * @param conv The PurpleConversation associated with this request, or NULL if none is 1512 * @param conv The PurpleConversation associated with this request, or NULL if none is
1653 * @param ui_hint UI hint 1513 * @param ui_hint UI hint
1654 * @param user_data The data to pass to the callback. 1514 * @param user_data The data to pass to the callback.
1655 * 1515 *
1656 * @return A UI-specific handle. 1516 * @return A UI-specific handle.
1657 *
1658 * @since 2.3.0
1659 */ 1517 */
1660 void *purple_request_fields_with_hint(void *handle, const char *title, 1518 void *purple_request_fields_with_hint(void *handle, const char *title,
1661 const char *primary, const char *secondary, 1519 const char *primary, const char *secondary,
1662 PurpleRequestFields *fields, 1520 PurpleRequestFields *fields,
1663 const char *ok_text, GCallback ok_cb, 1521 const char *ok_text, GCallback ok_cb,
1664 const char *cancel_text, GCallback cancel_cb, 1522 const char *cancel_text, GCallback cancel_cb,
1665 PurpleAccount *account, const char *who, PurpleConversation *conv, 1523 PurpleAccount *account, const char *who, PurpleConversation *conv,
1666 const char *ui_hint, void *user_data); 1524 const char *ui_hint, void *user_data);
1667 1525
1668 /** 1526 /**
1669 * Displays groups of fields for the user to fill in.
1670 *
1671 * @param handle The plugin or connection handle. For some
1672 * things this is EXTREMELY important. See
1673 * the comments on purple_request_input.
1674 * @param title The title of the message.
1675 * @param primary The main point of the message.
1676 * @param secondary The secondary information.
1677 * @param fields The list of fields.
1678 * @param ok_text The text for the @c OK button.
1679 * @param ok_cb The callback for the @c OK button.
1680 * @param cancel_text The text for the @c Cancel button.
1681 * @param cancel_cb The callback for the @c Cancel button.
1682 * @param account The PurpleAccount associated with this request, or NULL if none is
1683 * @param who The username of the buddy associated with this request, or NULL if none is
1684 * @param conv The PurpleConversation associated with this request, or NULL if none is
1685 * @param ui_hint UI hint
1686 * @param user_data The data to pass to the callback.
1687 *
1688 * @return A UI-specific handle.
1689 *
1690 * @deprecated Please use purple_request_fields_with_hint() instead. 1527 * @deprecated Please use purple_request_fields_with_hint() instead.
1691 */ 1528 */
1692 void *purple_request_fields(void *handle, const char *title, 1529 void *purple_request_fields(void *handle, const char *title,
1693 const char *primary, const char *secondary, 1530 const char *primary, const char *secondary,
1694 PurpleRequestFields *fields, 1531 PurpleRequestFields *fields,
1712 */ 1549 */
1713 void purple_request_close_with_handle(void *handle); 1550 void purple_request_close_with_handle(void *handle);
1714 1551
1715 /** 1552 /**
1716 * A wrapper for purple_request_action() that uses @c Yes and @c No buttons. 1553 * A wrapper for purple_request_action() that uses @c Yes and @c No buttons.
1717 *
1718 * @since 2.3.0
1719 */ 1554 */
1720 #define purple_request_yes_no_with_hint(handle, title, primary, secondary, \ 1555 #define purple_request_yes_no_with_hint(handle, title, primary, secondary, \
1721 default_action, account, who, conv, \ 1556 default_action, account, who, conv, \
1722 ui_hint, user_data, yes_cb, no_cb) \ 1557 ui_hint, user_data, yes_cb, no_cb) \
1723 purple_request_action_with_hint((handle), (title), (primary), (secondary), \ 1558 purple_request_action_with_hint((handle), (title), (primary), (secondary), \
1724 (default_action), account, who, conv, (ui_hint), (user_data), 2, \ 1559 (default_action), account, who, conv, (ui_hint), (user_data), 2, \
1725 _("_Yes"), (yes_cb), _("_No"), (no_cb)) 1560 _("_Yes"), (yes_cb), _("_No"), (no_cb))
1726 1561
1727 /** 1562 /**
1728 * A wrapper for purple_request_action() that uses @c Yes and @c No buttons.
1729 *
1730 * @deprecated Please use purple_request_yes_no_with_hint instead. 1563 * @deprecated Please use purple_request_yes_no_with_hint instead.
1731 */ 1564 */
1732 #define purple_request_yes_no(handle, title, primary, secondary, \ 1565 #define purple_request_yes_no(handle, title, primary, secondary, \
1733 default_action, account, who, conv, \ 1566 default_action, account, who, conv, \
1734 user_data, yes_cb, no_cb) \ 1567 user_data, yes_cb, no_cb) \
1736 (default_action), account, who, conv, (user_data), 2, \ 1569 (default_action), account, who, conv, (user_data), 2, \
1737 _("_Yes"), (yes_cb), _("_No"), (no_cb)) 1570 _("_Yes"), (yes_cb), _("_No"), (no_cb))
1738 1571
1739 /** 1572 /**
1740 * A wrapper for purple_request_action() that uses @c OK and @c Cancel buttons. 1573 * A wrapper for purple_request_action() that uses @c OK and @c Cancel buttons.
1741 *
1742 * @since 2.3.0
1743 */ 1574 */
1744 #define purple_request_ok_cancel_with_hint(handle, title, primary, secondary, \ 1575 #define purple_request_ok_cancel_with_hint(handle, title, primary, secondary, \
1745 default_action, account, who, conv, \ 1576 default_action, account, who, conv, \
1746 ui_hint, user_data, ok_cb, cancel_cb) \ 1577 ui_hint, user_data, ok_cb, cancel_cb) \
1747 purple_request_action_with_hint((handle), (title), (primary), (secondary), \ 1578 purple_request_action_with_hint((handle), (title), (primary), (secondary), \
1748 (default_action), account, who, conv, (ui_hint), (user_data), 2, \ 1579 (default_action), account, who, conv, (ui_hint), (user_data), 2, \
1749 _("_OK"), (ok_cb), _("_Cancel"), (cancel_cb)) 1580 _("_OK"), (ok_cb), _("_Cancel"), (cancel_cb))
1750 1581
1751 /** 1582 /**
1752 * A wrapper for purple_request_action() that uses @c OK and @c Cancel buttons.
1753 *
1754 * @deprecated Please use purple_request_ok_cancel_with_hint instead. 1583 * @deprecated Please use purple_request_ok_cancel_with_hint instead.
1755 */ 1584 */
1756 #define purple_request_ok_cancel(handle, title, primary, secondary, \ 1585 #define purple_request_ok_cancel(handle, title, primary, secondary, \
1757 default_action, account, who, conv, \ 1586 default_action, account, who, conv, \
1758 user_data, ok_cb, cancel_cb) \ 1587 user_data, ok_cb, cancel_cb) \
1760 (default_action), account, who, conv, (user_data), 2, \ 1589 (default_action), account, who, conv, (user_data), 2, \
1761 _("_OK"), (ok_cb), _("_Cancel"), (cancel_cb)) 1590 _("_OK"), (ok_cb), _("_Cancel"), (cancel_cb))
1762 1591
1763 /** 1592 /**
1764 * A wrapper for purple_request_action() that uses Accept and Cancel buttons. 1593 * A wrapper for purple_request_action() that uses Accept and Cancel buttons.
1765 *
1766 * @since 2.3.0
1767 */ 1594 */
1768 #define purple_request_accept_cancel_with_hint(handle, title, primary, secondary, \ 1595 #define purple_request_accept_cancel_with_hint(handle, title, primary, secondary, \
1769 default_action, account, who, conv, \ 1596 default_action, account, who, conv, \
1770 ui_hint, user_data, accept_cb, cancel_cb) \ 1597 ui_hint, user_data, accept_cb, cancel_cb) \
1771 purple_request_action_with_hint((handle), (title), (primary), (secondary), \ 1598 purple_request_action_with_hint((handle), (title), (primary), (secondary), \
1772 (default_action), account, who, conv, (ui_hint), (user_data), 2, \ 1599 (default_action), account, who, conv, (ui_hint), (user_data), 2, \
1773 _("_Accept"), (accept_cb), _("_Cancel"), (cancel_cb)) 1600 _("_Accept"), (accept_cb), _("_Cancel"), (cancel_cb))
1774 1601
1775 /** 1602 /**
1776 * A wrapper for purple_request_action() that uses Accept and Cancel buttons.
1777 *
1778 * @deprecated Please use purple_request_accept_cancel_with_hint instead. 1603 * @deprecated Please use purple_request_accept_cancel_with_hint instead.
1779 */ 1604 */
1780 #define purple_request_accept_cancel(handle, title, primary, secondary, \ 1605 #define purple_request_accept_cancel(handle, title, primary, secondary, \
1781 default_action, account, who, conv, \ 1606 default_action, account, who, conv, \
1782 user_data, accept_cb, cancel_cb) \ 1607 user_data, accept_cb, cancel_cb) \
1802 * @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
1803 * @param ui_hint UI hint 1628 * @param ui_hint UI hint
1804 * @param user_data The data to pass to the callback. 1629 * @param user_data The data to pass to the callback.
1805 * 1630 *
1806 * @return A UI-specific handle. 1631 * @return A UI-specific handle.
1807 *
1808 * @since 2.3.0
1809 */ 1632 */
1810 void *purple_request_file_with_hint(void *handle, const char *title, const char *filename, 1633 void *purple_request_file_with_hint(void *handle, const char *title, const char *filename,
1811 gboolean savedialog, 1634 gboolean savedialog,
1812 GCallback ok_cb, GCallback cancel_cb, 1635 GCallback ok_cb, GCallback cancel_cb,
1813 PurpleAccount *account, const char *who, PurpleConversation *conv, 1636 PurpleAccount *account, const char *who, PurpleConversation *conv,
1814 const char *ui_hint, void *user_data); 1637 const char *ui_hint, void *user_data);
1815 1638
1816 /** 1639 /**
1817 * Displays a file selector request dialog. Returns the selected filename to
1818 * the callback. Can be used for either opening a file or saving a file.
1819 *
1820 * @param handle The plugin or connection handle. For some
1821 * things this is EXTREMELY important. See
1822 * the comments on purple_request_input.
1823 * @param title The title for the dialog (may be @c NULL)
1824 * @param filename The default filename (may be @c NULL)
1825 * @param savedialog True if this dialog is being used to save a file.
1826 * False if it is being used to open a file.
1827 * @param ok_cb The callback for the @c OK button.
1828 * @param cancel_cb The callback for the @c Cancel button.
1829 * @param account The PurpleAccount associated with this request, or NULL if none is
1830 * @param who The username of the buddy assocaited with this request, or NULL if none is
1831 * @param conv The PurpleConversation associated with this request, or NULL if none is
1832 * @param ui_hint UI hint
1833 * @param user_data The data to pass to the callback.
1834 *
1835 * @return A UI-specific handle.
1836 *
1837 * @deprecated Please use purple_request_file_with_hint() instead. 1640 * @deprecated Please use purple_request_file_with_hint() instead.
1838 */ 1641 */
1839 void *purple_request_file(void *handle, const char *title, const char *filename, 1642 void *purple_request_file(void *handle, const char *title, const char *filename,
1840 gboolean savedialog, 1643 gboolean savedialog,
1841 GCallback ok_cb, GCallback cancel_cb, 1644 GCallback ok_cb, GCallback cancel_cb,
1858 * @param conv The PurpleConversation associated with this request, or NULL if none is 1661 * @param conv The PurpleConversation associated with this request, or NULL if none is
1859 * @param ui_hint UI hint 1662 * @param ui_hint UI hint
1860 * @param user_data The data to pass to the callback. 1663 * @param user_data The data to pass to the callback.
1861 * 1664 *
1862 * @return A UI-specific handle. 1665 * @return A UI-specific handle.
1863 *
1864 * @since 2.3.0
1865 */ 1666 */
1866 void *purple_request_folder_with_hint(void *handle, const char *title, const char *dirname, 1667 void *purple_request_folder_with_hint(void *handle, const char *title, const char *dirname,
1867 GCallback ok_cb, GCallback cancel_cb, 1668 GCallback ok_cb, GCallback cancel_cb,
1868 PurpleAccount *account, const char *who, PurpleConversation *conv, 1669 PurpleAccount *account, const char *who, PurpleConversation *conv,
1869 const char *ui_hint, void *user_data); 1670 const char *ui_hint, void *user_data);
1870 1671
1871 /** 1672 /**
1872 * Displays a folder select dialog. Returns the selected filename to
1873 * the callback.
1874 *
1875 * @param handle The plugin or connection handle. For some
1876 * things this is EXTREMELY important. See
1877 * the comments on purple_request_input.
1878 * @param title The title for the dialog (may be @c NULL)
1879 * @param dirname The default directory name (may be @c NULL)
1880 * @param ok_cb The callback for the @c OK button.
1881 * @param cancel_cb The callback for the @c Cancel button.
1882 * @param account The PurpleAccount associated with this request, or NULL if none is
1883 * @param who The username of the buddy assocaited with this request, or NULL if none is
1884 * @param conv The PurpleConversation associated with this request, or NULL if none is
1885 * @param ui_hint UI hint
1886 * @param user_data The data to pass to the callback.
1887 *
1888 * @return A UI-specific handle.
1889 *
1890 * @deprecated Please use purple_request_folder_with_hint() instead. 1673 * @deprecated Please use purple_request_folder_with_hint() instead.
1891 */ 1674 */
1892 void *purple_request_folder(void *handle, const char *title, const char *dirname, 1675 void *purple_request_folder(void *handle, const char *title, const char *dirname,
1893 GCallback ok_cb, GCallback cancel_cb, 1676 GCallback ok_cb, GCallback cancel_cb,
1894 PurpleAccount *account, const char *who, PurpleConversation *conv, 1677 PurpleAccount *account, const char *who, PurpleConversation *conv,