libpurple/request.h

changeset 40188
80e78796edb2
parent 40187
299c65ce09e2
child 40326
cdca03a74387
equal deleted inserted replaced
40187:299c65ce09e2 40188:80e78796edb2
278 * purple_request_cpar_new: 278 * purple_request_cpar_new:
279 * 279 *
280 * Creates new parameters set for the request, which may or may not be used by 280 * Creates new parameters set for the request, which may or may not be used by
281 * the UI to display the request. 281 * the UI to display the request.
282 * 282 *
283 * Returns: (skip) (transfer full): The new parameters set. 283 * Returns: (transfer full): The new parameters set.
284 */ 284 */
285 PurpleRequestCommonParameters * 285 PurpleRequestCommonParameters *
286 purple_request_cpar_new(void); 286 purple_request_cpar_new(void);
287 287
288 /** 288 /**
289 * purple_request_cpar_from_connection: 289 * purple_request_cpar_from_connection:
290 * @gc: The #PurpleConnection. 290 * @gc: The #PurpleConnection.
291 * 291 *
292 * Creates new parameters set initially bound with the #PurpleConnection. 292 * Creates new parameters set initially bound with the #PurpleConnection.
293 * 293 *
294 * Returns: (skip) (transfer full): The new parameters set. 294 * Returns: (transfer full): The new parameters set.
295 */ 295 */
296 PurpleRequestCommonParameters * 296 PurpleRequestCommonParameters *
297 purple_request_cpar_from_connection(PurpleConnection *gc); 297 purple_request_cpar_from_connection(PurpleConnection *gc);
298 298
299 /** 299 /**
300 * purple_request_cpar_from_account: 300 * purple_request_cpar_from_account:
301 * @account: The #PurpleAccount. 301 * @account: The #PurpleAccount.
302 * 302 *
303 * Creates new parameters set initially bound with the #PurpleAccount. 303 * Creates new parameters set initially bound with the #PurpleAccount.
304 * 304 *
305 * Returns: (skip) (transfer full): The new parameters set. 305 * Returns: (transfer full): The new parameters set.
306 */ 306 */
307 PurpleRequestCommonParameters * 307 PurpleRequestCommonParameters *
308 purple_request_cpar_from_account(PurpleAccount *account); 308 purple_request_cpar_from_account(PurpleAccount *account);
309 309
310 /** 310 /**
311 * purple_request_cpar_from_conversation: 311 * purple_request_cpar_from_conversation:
312 * @conv: The #PurpleConversation. 312 * @conv: The #PurpleConversation.
313 * 313 *
314 * Creates new parameters set initially bound with the #PurpleConversation. 314 * Creates new parameters set initially bound with the #PurpleConversation.
315 * 315 *
316 * Returns: (skip) (transfer full): The new parameters set. 316 * Returns: (transfer full): The new parameters set.
317 */ 317 */
318 PurpleRequestCommonParameters * 318 PurpleRequestCommonParameters *
319 purple_request_cpar_from_conversation(PurpleConversation *conv); 319 purple_request_cpar_from_conversation(PurpleConversation *conv);
320 320
321 /** 321 /**
333 * 333 *
334 * Decreases the reference count on the parameters set. 334 * Decreases the reference count on the parameters set.
335 * 335 *
336 * The object will be destroyed when this reaches 0. 336 * The object will be destroyed when this reaches 0.
337 * 337 *
338 * Returns: (skip) (transfer full): The NULL, if object was destroyed, cpar otherwise. 338 * Returns: (transfer full): The NULL, if object was destroyed, cpar otherwise.
339 */ 339 */
340 PurpleRequestCommonParameters * 340 PurpleRequestCommonParameters *
341 purple_request_cpar_unref(PurpleRequestCommonParameters *cpar); 341 purple_request_cpar_unref(PurpleRequestCommonParameters *cpar);
342 342
343 /** 343 /**
499 * @user_data: The pointer to the variable, where user data (to be passed to 499 * @user_data: The pointer to the variable, where user data (to be passed to
500 * callback function) should be stored. 500 * callback function) should be stored.
501 * 501 *
502 * Gets the callback for the Help button. 502 * Gets the callback for the Help button.
503 * 503 *
504 * Returns: (skip) (transfer none): The callback. 504 * Returns: (transfer none): The callback.
505 */ 505 */
506 PurpleRequestHelpCb 506 PurpleRequestHelpCb
507 purple_request_cpar_get_help_cb(PurpleRequestCommonParameters *cpar, 507 purple_request_cpar_get_help_cb(PurpleRequestCommonParameters *cpar,
508 gpointer *user_data); 508 gpointer *user_data);
509 509
564 /** 564 /**
565 * purple_request_fields_new: 565 * purple_request_fields_new:
566 * 566 *
567 * Creates a list of fields to pass to purple_request_fields(). 567 * Creates a list of fields to pass to purple_request_fields().
568 * 568 *
569 * Returns: (skip) (transfer full): A PurpleRequestFields structure. 569 * Returns: (transfer full): A PurpleRequestFields structure.
570 */ 570 */
571 PurpleRequestFields *purple_request_fields_new(void); 571 PurpleRequestFields *purple_request_fields_new(void);
572 572
573 /** 573 /**
574 * purple_request_fields_destroy: 574 * purple_request_fields_destroy:
705 * @fields: The fields list. 705 * @fields: The fields list.
706 * @id: The ID of the field. 706 * @id: The ID of the field.
707 * 707 *
708 * Return the field with the specified ID. 708 * Return the field with the specified ID.
709 * 709 *
710 * Returns: (skip) (transfer none): The field, if found. 710 * Returns: (transfer none): The field, if found.
711 */ 711 */
712 PurpleRequestField *purple_request_fields_get_field( 712 PurpleRequestField *purple_request_fields_get_field(
713 const PurpleRequestFields *fields, const char *id); 713 const PurpleRequestFields *fields, const char *id);
714 714
715 /** 715 /**
802 * purple_request_field_group_new: 802 * purple_request_field_group_new:
803 * @title: The optional title to give the group. 803 * @title: The optional title to give the group.
804 * 804 *
805 * Creates a fields group with an optional title. 805 * Creates a fields group with an optional title.
806 * 806 *
807 * Returns: (skip) (transfer full): A new fields group 807 * Returns: (transfer full): A new fields group
808 */ 808 */
809 PurpleRequestFieldGroup *purple_request_field_group_new(const char *title); 809 PurpleRequestFieldGroup *purple_request_field_group_new(const char *title);
810 810
811 /** 811 /**
812 * purple_request_field_group_set_tab: 812 * purple_request_field_group_set_tab:
893 * @text: The text label of the field. 893 * @text: The text label of the field.
894 * @type: The type of field. 894 * @type: The type of field.
895 * 895 *
896 * Creates a field of the specified type. 896 * Creates a field of the specified type.
897 * 897 *
898 * Returns: (skip) (transfer full): The new field. 898 * Returns: (transfer full): The new field.
899 */ 899 */
900 PurpleRequestField *purple_request_field_new(const char *id, const char *text, 900 PurpleRequestField *purple_request_field_new(const char *id, const char *text,
901 PurpleRequestFieldType type); 901 PurpleRequestFieldType type);
902 902
903 /** 903 /**
976 * purple_request_field_get_group: 976 * purple_request_field_get_group:
977 * @field: The field. 977 * @field: The field.
978 * 978 *
979 * Returns the group for the field. 979 * Returns the group for the field.
980 * 980 *
981 * Returns: (skip) (transfer none): The UI data. 981 * Returns: (transfer none): The UI data.
982 */ 982 */
983 PurpleRequestFieldGroup *purple_request_field_get_group(const PurpleRequestField *field); 983 PurpleRequestFieldGroup *purple_request_field_get_group(const PurpleRequestField *field);
984 984
985 /** 985 /**
986 * purple_request_field_get_id: 986 * purple_request_field_get_id:
1152 * @default_value: The optional default value. 1152 * @default_value: The optional default value.
1153 * @multiline: Whether or not this should be a multiline string. 1153 * @multiline: Whether or not this should be a multiline string.
1154 * 1154 *
1155 * Creates a string request field. 1155 * Creates a string request field.
1156 * 1156 *
1157 * Returns: (skip) (transfer full): The new field. 1157 * Returns: (transfer full): The new field.
1158 */ 1158 */
1159 PurpleRequestField *purple_request_field_string_new(const char *id, 1159 PurpleRequestField *purple_request_field_string_new(const char *id,
1160 const char *text, 1160 const char *text,
1161 const char *default_value, 1161 const char *default_value,
1162 gboolean multiline); 1162 gboolean multiline);
1245 * @lower_bound: The lower bound. 1245 * @lower_bound: The lower bound.
1246 * @upper_bound: The upper bound. 1246 * @upper_bound: The upper bound.
1247 * 1247 *
1248 * Creates an integer field. 1248 * Creates an integer field.
1249 * 1249 *
1250 * Returns: (skip) (transfer full): The new field. 1250 * Returns: (transfer full): The new field.
1251 */ 1251 */
1252 PurpleRequestField *purple_request_field_int_new(const char *id, 1252 PurpleRequestField *purple_request_field_int_new(const char *id,
1253 const char *text, int default_value, int lower_bound, int upper_bound); 1253 const char *text, int default_value, int lower_bound, int upper_bound);
1254 1254
1255 /** 1255 /**
1341 * 1341 *
1342 * Creates a boolean field. 1342 * Creates a boolean field.
1343 * 1343 *
1344 * This is often represented as a checkbox. 1344 * This is often represented as a checkbox.
1345 * 1345 *
1346 * Returns: (skip) (transfer full): The new field. 1346 * Returns: (transfer full): The new field.
1347 */ 1347 */
1348 PurpleRequestField *purple_request_field_bool_new(const char *id, 1348 PurpleRequestField *purple_request_field_bool_new(const char *id,
1349 const char *text, 1349 const char *text,
1350 gboolean default_value); 1350 gboolean default_value);
1351 1351
1402 * 1402 *
1403 * Creates a multiple choice field. 1403 * Creates a multiple choice field.
1404 * 1404 *
1405 * This is often represented as a group of radio buttons. 1405 * This is often represented as a group of radio buttons.
1406 * 1406 *
1407 * Returns: (skip) (transfer full): The new field. 1407 * Returns: (transfer full): The new field.
1408 */ 1408 */
1409 PurpleRequestField * 1409 PurpleRequestField *
1410 purple_request_field_choice_new(const char *id, const char *text, 1410 purple_request_field_choice_new(const char *id, const char *text,
1411 gpointer default_value); 1411 gpointer default_value);
1412 1412
1497 * @id: The field ID. 1497 * @id: The field ID.
1498 * @text: The optional label of the field. 1498 * @text: The optional label of the field.
1499 * 1499 *
1500 * Creates a multiple list item field. 1500 * Creates a multiple list item field.
1501 * 1501 *
1502 * Returns: (skip) (transfer full): The new field. 1502 * Returns: (transfer full): The new field.
1503 */ 1503 */
1504 PurpleRequestField *purple_request_field_list_new(const char *id, const char *text); 1504 PurpleRequestField *purple_request_field_list_new(const char *id, const char *text);
1505 1505
1506 /** 1506 /**
1507 * purple_request_field_list_set_multi_select: 1507 * purple_request_field_list_set_multi_select:
1635 * @id: The field ID. 1635 * @id: The field ID.
1636 * @text: The label of the field. 1636 * @text: The label of the field.
1637 * 1637 *
1638 * Creates a label field. 1638 * Creates a label field.
1639 * 1639 *
1640 * Returns: (skip) (transfer full): The new field. 1640 * Returns: (transfer full): The new field.
1641 */ 1641 */
1642 PurpleRequestField *purple_request_field_label_new(const char *id, 1642 PurpleRequestField *purple_request_field_label_new(const char *id,
1643 const char *text); 1643 const char *text);
1644 1644
1645 /**************************************************************************/ 1645 /**************************************************************************/
1653 * @buf: The image data. 1653 * @buf: The image data.
1654 * @size: The size of the data in @buf. 1654 * @size: The size of the data in @buf.
1655 * 1655 *
1656 * Creates an image field. 1656 * Creates an image field.
1657 * 1657 *
1658 * Returns: (skip) (transfer full): The new field. 1658 * Returns: (transfer full): The new field.
1659 */ 1659 */
1660 PurpleRequestField *purple_request_field_image_new(const char *id, const char *text, 1660 PurpleRequestField *purple_request_field_image_new(const char *id, const char *text,
1661 const char *buf, gsize size); 1661 const char *buf, gsize size);
1662 1662
1663 /** 1663 /**
1722 * 1722 *
1723 * Creates an account field. 1723 * Creates an account field.
1724 * 1724 *
1725 * By default, this field will not show offline accounts. 1725 * By default, this field will not show offline accounts.
1726 * 1726 *
1727 * Returns: (skip) (transfer full): The new field. 1727 * Returns: (transfer full): The new field.
1728 */ 1728 */
1729 PurpleRequestField *purple_request_field_account_new(const char *id, 1729 PurpleRequestField *purple_request_field_account_new(const char *id,
1730 const char *text, 1730 const char *text,
1731 PurpleAccount *account); 1731 PurpleAccount *account);
1732 1732
1819 * Returns the account filter function in an account field. 1819 * Returns the account filter function in an account field.
1820 * 1820 *
1821 * This function will determine which accounts get displayed and which 1821 * This function will determine which accounts get displayed and which
1822 * don't. 1822 * don't.
1823 * 1823 *
1824 * Returns: (skip) (transfer none): The account filter function. 1824 * Returns: (transfer none): The account filter function.
1825 */ 1825 */
1826 PurpleFilterAccountFunc purple_request_field_account_get_filter( 1826 PurpleFilterAccountFunc purple_request_field_account_get_filter(
1827 const PurpleRequestField *field); 1827 const PurpleRequestField *field);
1828 1828
1829 /**************************************************************************/ 1829 /**************************************************************************/
1836 * @text: The label of the field, may be %NULL. 1836 * @text: The label of the field, may be %NULL.
1837 * @sheet: The datasheet. 1837 * @sheet: The datasheet.
1838 * 1838 *
1839 * Creates a datasheet item field. 1839 * Creates a datasheet item field.
1840 * 1840 *
1841 * Returns: (skip) (transfer full): The new field. 1841 * Returns: (transfer full): The new field.
1842 */ 1842 */
1843 PurpleRequestField *purple_request_field_datasheet_new(const char *id, 1843 PurpleRequestField *purple_request_field_datasheet_new(const char *id,
1844 const gchar *text, PurpleRequestDatasheet *sheet); 1844 const gchar *text, PurpleRequestDatasheet *sheet);
1845 1845
1846 /** 1846 /**

mercurial