pidgin/pidgindebug.h

/* pidgin
 *
 * Pidgin is the legal property of its developers, whose names are too numerous
 * to list here.  Please refer to the COPYRIGHT file distributed with this
 * source distribution.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
 */

#if !defined(PIDGIN_GLOBAL_HEADER_INSIDE) && !defined(PIDGIN_COMPILATION)
# error "only <pidgin.h> may be included directly"
#endif

#ifndef PIDGIN_DEBUG_H
#define PIDGIN_DEBUG_H

#include <purple.h>

#include "pidginversion.h"

G_BEGIN_DECLS

/**
 * PidginDebugWindow:
 *
 * The debug window.
 *
 * Since: 3.0
 */

#define PIDGIN_TYPE_DEBUG_WINDOW (pidgin_debug_window_get_type())

PIDGIN_AVAILABLE_IN_3_0
G_DECLARE_FINAL_TYPE(PidginDebugWindow, pidgin_debug_window, PIDGIN, DEBUG_WINDOW, GtkWindow)

/**
 * pidgin_debug_init_handler:
 *
 * Initialize handler for GLib logging system.
 *
 * This must be called early if you want to capture logs at startup, and avoid
 * printing them out.
 *
 * Since: 3.0
 */
PIDGIN_AVAILABLE_IN_3_0
void pidgin_debug_init_handler(void);

/**
 * pidgin_debug_get_settings:
 *
 * Gets the [class@Gio.Settings] for debug handling. This value is only valid
 * after calling [func@debug_init].
 *
 * Returns: (transfer none): The settings for the debug window.
 *
 * Since: 3.0
 */
PIDGIN_AVAILABLE_IN_3_0
GSettings *pidgin_debug_get_settings(void);

/**
 * pidgin_debug_set_print_enabled:
 * @enable: Whether or not to use the default GLib logging handler.
 *
 * Set whether the debug logging messages are sent the default GLib logging
 * handler.
 *
 * This will print to the console, if Pidgin is run from there.
 *
 * Since: 3.0
 */
PIDGIN_AVAILABLE_IN_3_0
void pidgin_debug_set_print_enabled(gboolean enable);

/**
 * pidgin_debug_init:
 *
 * Perform necessary initializations.
 *
 * Since: 2.0
 */
PIDGIN_AVAILABLE_IN_ALL
void pidgin_debug_init(void);

/**
 * pidgin_debug_uninit:
 *
 * Perform necessary uninitializations.
 *
 * Since: 2.0
 */
PIDGIN_AVAILABLE_IN_ALL
void pidgin_debug_uninit(void);

/**
 * pidgin_debug_window_show:
 *
 * Shows the debug window.
 *
 * Since: 2.0
 */
PIDGIN_AVAILABLE_IN_ALL
void pidgin_debug_window_show(void);

/**
 * pidgin_debug_window_hide:
 *
 * Hides the debug window.
 *
 * Since: 2.0
 */
PIDGIN_AVAILABLE_IN_ALL
void pidgin_debug_window_hide(void);

G_END_DECLS

#endif /* PIDGIN_DEBUG_H */