finch/gntrequest.h

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