Write this item more similarly to other items
[pidgin-git.git] / pidgin / gtkdebug.h
blob75f0a8535e3e64a118640823d0175e02b464c4ee
1 /**
2 * @file gtkdebug.h GTK+ Debug API
3 * @ingroup pidgin
4 */
6 /* pidgin
8 * Pidgin 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.
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.
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.
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
26 #ifndef _PIDGINDEBUG_H_
27 #define _PIDGINDEBUG_H_
29 #include "debug.h"
31 /**
32 * Initializes the GTK+ debug system.
34 void pidgin_debug_init(void);
36 /**
37 * Uninitialized the GTK+ debug system.
39 void pidgin_debug_uninit(void);
41 /**
42 * Get the handle for the GTK+ debug system.
44 * @return the handle to the debug system
46 void *pidgin_debug_get_handle(void);
48 /**
49 * Shows the debug window.
51 void pidgin_debug_window_show(void);
53 /**
54 * Hides the debug window.
56 void pidgin_debug_window_hide(void);
58 /**
59 * Returns the UI operations structure for GTK+ debug output.
61 * @return The GTK+ UI debug operations structure.
63 PurpleDebugUiOps *pidgin_debug_get_ui_ops(void);
65 #endif /* _PIDGINDEBUG_H_ */