comparison libpurple/request.h @ 21564:ad718740aa71

disapproval of revision 'ea579831d8561ac6b0cde4b034383b02b3e51ae5'

21221:e98c08afb706

 * @param flag     Flags dictating what kind of blist nodes should be
 *                 included in the request field.
 * @param selected A list of PurpleBlistNode's to select by default, or @c NULL.
 *
 * @return  The new field.
 *
 * @since 2.3.0
 */
PurpleRequestField *purple_request_field_blist_nodes_new(const char *id, const char *text,
		PurpleRequestBlistFlags flag, GList *selected);

/**

 *
 * @param field   The request field.
 * @param filter  The filter function.
 *
 * @return  The old filter function, or @c NULL if there was none.
 *
 * @since 2.3.0
 */
PurpleFilterBlistFunc purple_request_field_blist_set_filter(PurpleRequestField *field, PurpleFilterBlistFunc filter);

/**
 * Get the filter function for the request field.
 *
 * @param field  The request field.
 *
 * @return  The filter function, or @c NULL if there isn't any.
 *
 * @since 2.3.0
 */
PurpleFilterBlistFunc purple_request_field_blist_get_filter(const PurpleRequestField *field);

/**
 * Add a PurpleBlistNode to the selected list.
 *
 * @param field  The request field.
 * @param node   The buddylist node to add to the list.
 *
 * @return  @c TRUE if the node is added to the list, @c FALSE if it was already in the list.
 *
 * @since 2.3.0
 */
gboolean purple_request_field_blist_add(PurpleRequestField *field, PurpleBlistNode *node);

/**
 * Remove a PurpleBlistNode from the selected list.
 *
 * @param field   The request field.
 * @param node    The buddylist node to remove from the list.
 *
 * @return @c TRUE if the node is removed from the list, @c FALSE if the node is not in the list.
 *
 * @since 2.3.0
 */
gboolean purple_request_field_blist_remove(PurpleRequestField *field, PurpleBlistNode *node);

/**
 * Set the list of selected nodes in the request field.
 *
 * @param field      The request field.
 * @param selecteds  The list of selected PurpleBlistNode's. Note that the request field
 *                   becomes the owner of the list, and so the caller should not modify it.
 *
 * @since 2.3.0
 */
void purple_request_field_blist_set_selection_list(PurpleRequestField *field, GList *selecteds);

/**
 * Get a list of the selected buddylist nodes.
 *
 * @param field  The request field.
 *
 * @return A GList of PurpleBlistNode's.
 *
 * @since 2.3.0
 */
GList *purple_request_field_blist_get_selection_list(const PurpleRequestField *field);

/*@}*/

21564:ad718740aa71

 * @param flag     Flags dictating what kind of blist nodes should be
 *                 included in the request field.
 * @param selected A list of PurpleBlistNode's to select by default, or @c NULL.
 *
 * @return  The new field.
 */
PurpleRequestField *purple_request_field_blist_nodes_new(const char *id, const char *text,
		PurpleRequestBlistFlags flag, GList *selected);

/**

 *
 * @param field   The request field.
 * @param filter  The filter function.
 *
 * @return  The old filter function, or @c NULL if there was none.
 */
PurpleFilterBlistFunc purple_request_field_blist_set_filter(PurpleRequestField *field, PurpleFilterBlistFunc filter);

/**
 * Get the filter function for the request field.
 *
 * @param field  The request field.
 *
 * @return  The filter function, or @c NULL if there isn't any.
 */
PurpleFilterBlistFunc purple_request_field_blist_get_filter(const PurpleRequestField *field);

/**
 * Add a PurpleBlistNode to the selected list.
 *
 * @param field  The request field.
 * @param node   The buddylist node to add to the list.
 *
 * @return  @c TRUE if the node is added to the list, @c FALSE if it was already in the list.
 */
gboolean purple_request_field_blist_add(PurpleRequestField *field, PurpleBlistNode *node);

/**
 * Remove a PurpleBlistNode from the selected list.
 *
 * @param field   The request field.
 * @param node    The buddylist node to remove from the list.
 *
 * @return @c TRUE if the node is removed from the list, @c FALSE if the node is not in the list.
 */
gboolean purple_request_field_blist_remove(PurpleRequestField *field, PurpleBlistNode *node);

/**
 * Set the list of selected nodes in the request field.
 *
 * @param field      The request field.
 * @param selecteds  The list of selected PurpleBlistNode's. Note that the request field
 *                   becomes the owner of the list, and so the caller should not modify it.
 */
void purple_request_field_blist_set_selection_list(PurpleRequestField *field, GList *selecteds);

/**
 * Get a list of the selected buddylist nodes.
 *
 * @param field  The request field.
 *
 * @return A GList of PurpleBlistNode's.
 */
GList *purple_request_field_blist_get_selection_list(const PurpleRequestField *field);

/*@}*/