pidgin/gtkrequest.h

   1 /* pidgin
   2  *
   3  * Pidgin 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 _PIDGINREQUEST_H_
  23 #define _PIDGINREQUEST_H_
  24 /**
  25  * SECTION:gtkrequest
  26  * @section_id: pidgin-gtkrequest
  27  * @short_description: <filename>gtkrequest.h</filename>
  28  * @title: Request API
  29  */
  30
  31 #include "request.h"
  32
  33 G_BEGIN_DECLS
  34
  35 /**
  36  * pidgin_request_get_ui_ops:
  37  *
  38  * Returns the UI operations structure for GTK+ request functions.
  39  *
  40  * Returns: The GTK+ UI request operations structure.
  41  */
  42 PurpleRequestUiOps *pidgin_request_get_ui_ops(void);
  43
  44 /**
  45  * pidgin_request_get_dialog_window:
  46  * @ui_handle: The UI handle.
  47  *
  48  * Gets dialog window for specified libpurple request.
  49  *
  50  * Returns: The dialog window.
  51  */
  52 GtkWindow *
  53 pidgin_request_get_dialog_window(void *ui_handle);
  54
  55 /**************************************************************************/
  56 /* GTK+ Requests Subsystem                                                */
  57 /**************************************************************************/
  58
  59 /**
  60  * pidgin_request_get_handle:
  61  *
  62  * Returns the gtk requests subsystem handle.
  63  *
  64  * Returns: The requests subsystem handle.
  65  */
  66 void *pidgin_request_get_handle(void);
  67
  68 /**
  69  * pidgin_request_init:
  70  *
  71  * Initializes the GTK+ requests subsystem.
  72  */
  73 void pidgin_request_init(void);
  74
  75 /**
  76  * pidgin_request_uninit:
  77  *
  78  * Uninitializes the GTK+ requests subsystem.
  79  */
  80 void pidgin_request_uninit(void);
  81
  82 G_END_DECLS
  83
  84 #endif /* _PIDGINREQUEST_H_ */