view finch/gntrequest.h @ 27829:2f05586afa12

propagate from branch 'im.pidgin.pidgin' (head 018afa661b9c72b48f2277e33e2fe55cc8b19235) to branch 'im.pidgin.pidgin.yaz' (head 0a588adc7efbf9575fd8245aa8ac7775a7e03026)

/**
 * @file gntrequest.h GNT Request API
 * @ingroup finch
 */

/* finch
 *
 * Finch is the legal property of its developers, whose names are too numerous
 * to list here.  Please refer to the COPYRIGHT file distributed with this
 * source distribution.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
 */
#ifndef _GNT_REQUEST_H
#define _GNT_REQUEST_H

#include "request.h"
#include "gnt.h"

/**********************************************************************
 * @name GNT Request API
 **********************************************************************/
/*@{*/

/**
 * Get the ui-functions.
 *
 * @return The PurpleRequestUiOps structure populated with the appropriate functions.
 */
PurpleRequestUiOps *finch_request_get_ui_ops(void);

/**
 * Perform necessary initializations.
 */
void finch_request_init(void);

/**
 * Perform necessary uninitializations.
 */
void finch_request_uninit(void);

/**
 * Save the request fields in preferences where the id attribute of each field is the
 * id of a preference.
 */
void finch_request_save_in_prefs(gpointer null, PurpleRequestFields *fields);

/**
 * Create a widget field for a request-field.
 *
 * @param field   The request field.
 *
 * @return A GntWidget for the request field.
 * @since 2.4.0
 */
GntWidget *finch_request_field_get_widget(PurpleRequestField *field);
/*@}*/

#endif