pidgin/gtklog.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 _PIDGINLOG_H_
  23 #define _PIDGINLOG_H_
  24 /**
  25  * SECTION:gtklog
  26  * @section_id: pidgin-gtklog
  27  * @short_description: <filename>gtklog.h</filename>
  28  * @title: Log Viewer
  29  * @see_also: <link linkend="chapter-signals-gtklog">Log signals</link>
  30  */
  31
  32 #include "pidgin.h"
  33 #include "log.h"
  34
  35 #include "account.h"
  36
  37 typedef struct _PidginLogViewer PidginLogViewer;
  38
  39 /**
  40  * PidginLogViewer:
  41  * @logs:      The list of logs viewed in this viewer
  42  * @window:    The viewer's window
  43  * @treestore: The treestore containing said logs
  44  * @treeview:  The treeview representing said treestore
  45  * @web_view:  The webkit web view to display said logs
  46  * @entry:     The search entry, in which search terms are entered
  47  * @flags:     The most recently used log flags
  48  * @search:    The string currently being searched for
  49  * @label:     The label at the top of the log viewer
  50  *
  51  * A GTK+ Log Viewer.  You can look at logs with it.
  52  */
  53 struct _PidginLogViewer {
  54         GList *logs;
  55
  56         GtkWidget        *window;
  57         GtkTreeStore     *treestore;
  58         GtkWidget        *treeview;
  59         GtkWidget        *web_view;
  60         GtkWidget        *entry;
  61
  62         PurpleLogReadFlags flags;
  63         char             *search;
  64         GtkLabel         *label;
  65 };
  66
  67
  68 G_BEGIN_DECLS
  69
  70 void pidgin_log_show(PurpleLogType type, const char *buddyname, PurpleAccount *account);
  71 void pidgin_log_show_contact(PurpleContact *contact);
  72
  73 void pidgin_syslog_show(void);
  74
  75 /**************************************************************************/
  76 /* GTK+ Log Subsystem                                                     */
  77 /**************************************************************************/
  78
  79 /**
  80  * pidgin_log_init:
  81  *
  82  * Initializes the GTK+ log subsystem.
  83  */
  84 void pidgin_log_init(void);
  85
  86 /**
  87  * pidgin_log_get_handle:
  88  *
  89  * Returns the GTK+ log subsystem handle.
  90  *
  91  * Returns: The GTK+ log subsystem handle.
  92  */
  93 void *pidgin_log_get_handle(void);
  94
  95 /**
  96  * pidgin_log_uninit:
  97  *
  98  * Uninitializes the GTK+ log subsystem.
  99  */
 100 void pidgin_log_uninit(void);
 101
 102 G_END_DECLS
 103
 104 #endif