libpurple/request.h

changeset 38716
b9bed228745a
parent 37624
a61e614c743d
child 38745
f4376b1f4682
equal deleted inserted replaced
38715:98d5a19c04a9 38716:b9bed228745a
541 * purple_request_fields_get_groups: 541 * purple_request_fields_get_groups:
542 * @fields: The fields list. 542 * @fields: The fields list.
543 * 543 *
544 * Returns a list of all groups in a field list. 544 * Returns a list of all groups in a field list.
545 * 545 *
546 * Returns: (transfer none): A list of groups. 546 * Returns: (element-type PurpleRequestFieldGroup) (transfer none): A list of groups.
547 */ 547 */
548 GList *purple_request_fields_get_groups(const PurpleRequestFields *fields); 548 GList *purple_request_fields_get_groups(const PurpleRequestFields *fields);
549 549
550 /** 550 /**
551 * purple_request_fields_set_tab_names: 551 * purple_request_fields_set_tab_names:
586 * purple_request_fields_get_required: 586 * purple_request_fields_get_required:
587 * @fields: The fields list. 587 * @fields: The fields list.
588 * 588 *
589 * Returns a list of all required fields. 589 * Returns a list of all required fields.
590 * 590 *
591 * Returns: (transfer none): The list of required fields. 591 * Returns: (element-type PurpleRequestField) (transfer none): The list of required fields.
592 */ 592 */
593 const GList *purple_request_fields_get_required( 593 const GList *purple_request_fields_get_required(
594 const PurpleRequestFields *fields); 594 const PurpleRequestFields *fields);
595 595
596 /** 596 /**
597 * purple_request_fields_get_validatable: 597 * purple_request_fields_get_validatable:
598 * @fields: The fields list. 598 * @fields: The fields list.
599 * 599 *
600 * Returns a list of all validated fields. 600 * Returns a list of all validated fields.
601 * 601 *
602 * Returns: (transfer none): The list of validated fields. 602 * Returns: (element-type PurpleRequestField) (transfer none): The list of validated fields.
603 */ 603 */
604 const GList *purple_request_fields_get_validatable( 604 const GList *purple_request_fields_get_validatable(
605 const PurpleRequestFields *fields); 605 const PurpleRequestFields *fields);
606 606
607 /** 607 /**
608 * purple_request_fields_get_autosensitive: 608 * purple_request_fields_get_autosensitive:
609 * @fields: The fields list. 609 * @fields: The fields list.
610 * 610 *
611 * Returns a list of all fields with sensitivity callback added. 611 * Returns a list of all fields with sensitivity callback added.
612 * 612 *
613 * Returns: (transfer none): The list of fields with automatic sensitivity 613 * Returns: (element-type PurpleRequestField) (transfer none): The list of
614 * callback. 614 * fields with automatic sensitivity callback.
615 */ 615 */
616 const GList * 616 const GList *
617 purple_request_fields_get_autosensitive(const PurpleRequestFields *fields); 617 purple_request_fields_get_autosensitive(const PurpleRequestFields *fields);
618 618
619 /** 619 /**
814 * purple_request_field_group_get_fields: 814 * purple_request_field_group_get_fields:
815 * @group: The group. 815 * @group: The group.
816 * 816 *
817 * Returns a list of all fields in a group. 817 * Returns a list of all fields in a group.
818 * 818 *
819 * Returns: (transfer none): The list of fields in the group. 819 * Returns: (element-type PurpleRequestField) (transfer none): The list of fields in the group.
820 */ 820 */
821 GList *purple_request_field_group_get_fields( 821 GList *purple_request_field_group_get_fields(
822 const PurpleRequestFieldGroup *group); 822 const PurpleRequestFieldGroup *group);
823 823
824 /** 824 /**
1519 void purple_request_field_list_clear_selected(PurpleRequestField *field); 1519 void purple_request_field_list_clear_selected(PurpleRequestField *field);
1520 1520
1521 /** 1521 /**
1522 * purple_request_field_list_set_selected: 1522 * purple_request_field_list_set_selected:
1523 * @field: The field. 1523 * @field: The field.
1524 * @items: The list of selected items, which is not modified or freed. 1524 * @items: (element-type utf8) (transfer none): The list of selected items.
1525 * 1525 *
1526 * Sets a list of selected items in a list field. 1526 * Sets a list of selected items in a list field.
1527 */ 1527 */
1528 void purple_request_field_list_set_selected(PurpleRequestField *field, 1528 void purple_request_field_list_set_selected(PurpleRequestField *field,
1529 GList *items); 1529 GList *items);
1547 * Returns a list of selected items in a list field. 1547 * Returns a list of selected items in a list field.
1548 * 1548 *
1549 * To retrieve the data for each item, use 1549 * To retrieve the data for each item, use
1550 * purple_request_field_list_get_data(). 1550 * purple_request_field_list_get_data().
1551 * 1551 *
1552 * Returns: (transfer none): The list of selected items. 1552 * Returns: (element-type utf8) (transfer none): The list of selected items.
1553 */ 1553 */
1554 GList *purple_request_field_list_get_selected( 1554 GList *purple_request_field_list_get_selected(
1555 const PurpleRequestField *field); 1555 const PurpleRequestField *field);
1556 1556
1557 /** 1557 /**
1558 * purple_request_field_list_get_items: 1558 * purple_request_field_list_get_items:
1559 * @field: The field. 1559 * @field: The field.
1560 * 1560 *
1561 * Returns a list of items in a list field. 1561 * Returns a list of items in a list field.
1562 * 1562 *
1563 * Returns: (transfer none): The list of items. 1563 * Returns: (element-type utf8) (transfer none): The list of items.
1564 */ 1564 */
1565 GList *purple_request_field_list_get_items(const PurpleRequestField *field); 1565 GList *purple_request_field_list_get_items(const PurpleRequestField *field);
1566 1566
1567 /** 1567 /**
1568 * purple_request_field_list_get_icons: 1568 * purple_request_field_list_get_icons:
1570 * 1570 *
1571 * Returns a list of icons in a list field. 1571 * Returns a list of icons in a list field.
1572 * 1572 *
1573 * The icons will correspond with the items, in order. 1573 * The icons will correspond with the items, in order.
1574 * 1574 *
1575 * Returns: (transfer none): The list of icons or %NULL (i.e. the empty #GList) 1575 * Returns: (element-type utf8) (transfer none): The list of icons or %NULL (i.e. the empty #GList)
1576 * if no items have icons. 1576 * if no items have icons.
1577 */ 1577 */
1578 GList *purple_request_field_list_get_icons(const PurpleRequestField *field); 1578 GList *purple_request_field_list_get_icons(const PurpleRequestField *field);
1579 1579
1580 /**************************************************************************/ 1580 /**************************************************************************/

mercurial