finch/gntrequest.h

   1 /**
   2  * @file gntrequest.h GNT Request API
   3  * @ingroup finch
   4  */
   5
   6 /* finch
   7  *
   8  * Finch is the legal property of its developers, whose names are too numerous
   9  * to list here.  Please refer to the COPYRIGHT file distributed with this
  10  * source distribution.
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  25  */
  26 #ifndef _GNT_REQUEST_H
  27 #define _GNT_REQUEST_H
  28
  29 #include "request.h"
  30 #include "gnt.h"
  31
  32 /**********************************************************************
  33  * @name GNT Request API
  34  **********************************************************************/
  35 /*@{*/
  36
  37 /**
  38  * Get the ui-functions.
  39  *
  40  * @return The PurpleRequestUiOps structure populated with the appropriate functions.
  41  */
  42 PurpleRequestUiOps *finch_request_get_ui_ops(void);
  43
  44 /**
  45  * Perform necessary initializations.
  46  */
  47 void finch_request_init(void);
  48
  49 /**
  50  * Perform necessary uninitializations.
  51  */
  52 void finch_request_uninit(void);
  53
  54 /**
  55  * Save the request fields in preferences where the id attribute of each field is the
  56  * id of a preference.
  57  */
  58 void finch_request_save_in_prefs(gpointer null, PurpleRequestFields *fields);
  59
  60 /**
  61  * Create a widget field for a request-field.
  62  *
  63  * @param field   The request field.
  64  *
  65  * @return A GntWidget for the request field.
  66  * @since 2.4.0
  67  */
  68 GntWidget *finch_request_field_get_widget(PurpleRequestField *field);
  69 /*@}*/
  70
  71 #endif