finch/gntrequest.h

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