pidgin/gtkdebug.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 _PIDGINDEBUG_H_
  23 #define _PIDGINDEBUG_H_
  24 /**
  25  * SECTION:gtkdebug
  26  * @section_id: pidgin-gtkdebug
  27  * @short_description: <filename>gtkdebug.h</filename>
  28  * @title: Debug API
  29  */
  30
  31 #include "debug.h"
  32
  33 G_BEGIN_DECLS
  34
  35 /**
  36  * pidgin_debug_init:
  37  *
  38  * Initializes the GTK+ debug system.
  39  */
  40 void pidgin_debug_init(void);
  41
  42 /**
  43  * pidgin_debug_uninit:
  44  *
  45  * Uninitialized the GTK+ debug system.
  46  */
  47 void pidgin_debug_uninit(void);
  48
  49 /**
  50  * pidgin_debug_get_handle:
  51  *
  52  * Get the handle for the GTK+ debug system.
  53  *
  54  * Returns: the handle to the debug system
  55  */
  56 void *pidgin_debug_get_handle(void);
  57
  58 /**
  59  * pidgin_debug_window_show:
  60  *
  61  * Shows the debug window.
  62  */
  63 void pidgin_debug_window_show(void);
  64
  65 /**
  66  * pidgin_debug_window_hide:
  67  *
  68  * Hides the debug window.
  69  */
  70 void pidgin_debug_window_hide(void);
  71
  72 /**
  73  * pidgin_debug_get_ui_ops:
  74  *
  75  * Returns the UI operations structure for GTK+ debug output.
  76  *
  77  * Returns: The GTK+ UI debug operations structure.
  78  */
  79 PurpleDebugUiOps *pidgin_debug_get_ui_ops(void);
  80
  81 G_END_DECLS
  82
  83 #endif /* _PIDGINDEBUG_H_ */