libpurple/request.h

branch
gtkdoc-conversion
changeset 35394
38facb8226d4
parent 35393
00f876b129bc
child 35395
bf3f004adbf1
equal deleted inserted replaced
35393:00f876b129bc 35394:38facb8226d4
482 /** 482 /**
483 * Returns a list of all groups in a field list. 483 * Returns a list of all groups in a field list.
484 * 484 *
485 * @fields: The fields list. 485 * @fields: The fields list.
486 * 486 *
487 * Returns: (TODO const): A list of groups. 487 * Returns: (transfer none): A list of groups.
488 */ 488 */
489 GList *purple_request_fields_get_groups(const PurpleRequestFields *fields); 489 GList *purple_request_fields_get_groups(const PurpleRequestFields *fields);
490 490
491 /** 491 /**
492 * Set tab names for a field list. 492 * Set tab names for a field list.
523 /** 523 /**
524 * Returns a list of all required fields. 524 * Returns a list of all required fields.
525 * 525 *
526 * @fields: The fields list. 526 * @fields: The fields list.
527 * 527 *
528 * Returns: (TODO const): The list of required fields. 528 * Returns: (transfer none): The list of required fields.
529 */ 529 */
530 const GList *purple_request_fields_get_required( 530 const GList *purple_request_fields_get_required(
531 const PurpleRequestFields *fields); 531 const PurpleRequestFields *fields);
532 532
533 /** 533 /**
534 * Returns a list of all validated fields. 534 * Returns a list of all validated fields.
535 * 535 *
536 * @fields: The fields list. 536 * @fields: The fields list.
537 * 537 *
538 * Returns: (TODO const): The list of validated fields. 538 * Returns: (transfer none): The list of validated fields.
539 */ 539 */
540 const GList *purple_request_fields_get_validatable( 540 const GList *purple_request_fields_get_validatable(
541 const PurpleRequestFields *fields); 541 const PurpleRequestFields *fields);
542 542
543 /** 543 /**
544 * Returns a list of all fields with sensitivity callback added. 544 * Returns a list of all fields with sensitivity callback added.
545 * 545 *
546 * @fields: The fields list. 546 * @fields: The fields list.
547 * 547 *
548 * Returns: (TODO const): The list of fields with automatic sensitivity callback. 548 * Returns: (transfer none): The list of fields with automatic sensitivity callback.
549 */ 549 */
550 const GList * 550 const GList *
551 purple_request_fields_get_autosensitive(const PurpleRequestFields *fields); 551 purple_request_fields_get_autosensitive(const PurpleRequestFields *fields);
552 552
553 /** 553 /**
733 /** 733 /**
734 * Returns a list of all fields in a group. 734 * Returns a list of all fields in a group.
735 * 735 *
736 * @group: The group. 736 * @group: The group.
737 * 737 *
738 * Returns: (TODO const): The list of fields in the group. 738 * Returns: (transfer none): The list of fields in the group.
739 */ 739 */
740 GList *purple_request_field_group_get_fields( 740 GList *purple_request_field_group_get_fields(
741 const PurpleRequestFieldGroup *group); 741 const PurpleRequestFieldGroup *group);
742 742
743 /** 743 /**
744 * Returns a list of all fields in a group. 744 * Returns a list of all fields in a group.
745 * 745 *
746 * @group: The group. 746 * @group: The group.
747 * 747 *
748 * Returns: (TODO const): The list of fields in the group. 748 * Returns: (transfer none): The list of fields in the group.
749 */ 749 */
750 PurpleRequestFields *purple_request_field_group_get_fields_list( 750 PurpleRequestFields *purple_request_field_group_get_fields_list(
751 const PurpleRequestFieldGroup *group); 751 const PurpleRequestFieldGroup *group);
752 752
753 /*@}*/ 753 /*@}*/
1301 /** 1301 /**
1302 * Returns a list of elements in a choice field. 1302 * Returns a list of elements in a choice field.
1303 * 1303 *
1304 * @field: The field. 1304 * @field: The field.
1305 * 1305 *
1306 * Returns: (TODO const): The list of pairs <label, value>. 1306 * Returns: (transfer none): The list of pairs <label, value>.
1307 */ 1307 */
1308 GList * 1308 GList *
1309 purple_request_field_choice_get_elements(const PurpleRequestField *field); 1309 purple_request_field_choice_get_elements(const PurpleRequestField *field);
1310 1310
1311 /** 1311 /**
1419 * To retrieve the data for each item, use 1419 * To retrieve the data for each item, use
1420 * purple_request_field_list_get_data(). 1420 * purple_request_field_list_get_data().
1421 * 1421 *
1422 * @field: The field. 1422 * @field: The field.
1423 * 1423 *
1424 * Returns: (TODO const): The list of selected items. 1424 * Returns: (transfer none): The list of selected items.
1425 */ 1425 */
1426 GList *purple_request_field_list_get_selected( 1426 GList *purple_request_field_list_get_selected(
1427 const PurpleRequestField *field); 1427 const PurpleRequestField *field);
1428 1428
1429 /** 1429 /**
1430 * Returns a list of items in a list field. 1430 * Returns a list of items in a list field.
1431 * 1431 *
1432 * @field: The field. 1432 * @field: The field.
1433 * 1433 *
1434 * Returns: (TODO const): The list of items. 1434 * Returns: (transfer none): The list of items.
1435 */ 1435 */
1436 GList *purple_request_field_list_get_items(const PurpleRequestField *field); 1436 GList *purple_request_field_list_get_items(const PurpleRequestField *field);
1437 1437
1438 /** 1438 /**
1439 * Returns a list of icons in a list field. 1439 * Returns a list of icons in a list field.
1440 * 1440 *
1441 * The icons will correspond with the items, in order. 1441 * The icons will correspond with the items, in order.
1442 * 1442 *
1443 * @field: The field. 1443 * @field: The field.
1444 * 1444 *
1445 * Returns: (TODO const): The list of icons or %NULL (i.e. the empty GList) if no 1445 * Returns: (transfer none): The list of icons or %NULL (i.e. the empty GList) if no
1446 * items have icons. 1446 * items have icons.
1447 */ 1447 */
1448 GList *purple_request_field_list_get_icons(const PurpleRequestField *field); 1448 GList *purple_request_field_list_get_icons(const PurpleRequestField *field);
1449 1449
1450 /*@}*/ 1450 /*@}*/
1691 /** 1691 /**
1692 * Returns a datasheet for a field. 1692 * Returns a datasheet for a field.
1693 * 1693 *
1694 * @field: The field. 1694 * @field: The field.
1695 * 1695 *
1696 * Returns: (TODO const): The datasheet object. 1696 * Returns: (transfer none): The datasheet object.
1697 */ 1697 */
1698 PurpleRequestDatasheet *purple_request_field_datasheet_get_sheet( 1698 PurpleRequestDatasheet *purple_request_field_datasheet_get_sheet(
1699 PurpleRequestField *field); 1699 PurpleRequestField *field);
1700 1700
1701 /*@}*/ 1701 /*@}*/

mercurial