finch/gntlog.h

   1 /* finch
   2  *
   3  * Finch 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 _FINCHLOG_H_
  23 #define _FINCHLOG_H_
  24 /**
  25  * SECTION:gntlog
  26  * @section_id: finch-gntlog
  27  * @short_description: <filename>gntlog.h</filename>
  28  * @title: Log Viewer
  29  */
  30
  31 #include "log.h"
  32 #include "account.h"
  33 #include "gntwidget.h"
  34
  35 typedef struct _FinchLogViewer FinchLogViewer;
  36
  37 /**
  38  * FinchLogViewer:
  39  * @logs: The list of logs viewed in this viewer
  40  * @window: The viewer's window
  41  * @tree:   The tree representing said treestore
  42  * @text:   The text to display said logs
  43  * @entry:  The search entry, in which search terms are entered
  44  * @flags:  The most recently used log flags
  45  * @search: The string currently being searched for
  46  *
  47  * A GNT Log Viewer.  You can look at logs with it.
  48  */
  49 struct _FinchLogViewer {
  50         GList *logs;
  51
  52         GntWidget       *window;
  53         GntWidget       *tree;
  54         GntWidget       *text;
  55         GntWidget       *entry;
  56         GntWidget       *label;
  57         PurpleLogReadFlags flags;
  58         char            *search;
  59 };
  60
  61
  62
  63 void finch_log_show(PurpleLogType type, const char *username, PurpleAccount *account);
  64 void finch_log_show_contact(PurpleContact *contact);
  65
  66 void finch_syslog_show(void);
  67
  68 /**************************************************************************/
  69 /* GNT Log Subsystem                                                      */
  70 /**************************************************************************/
  71
  72 /**
  73  * finch_log_init:
  74  *
  75  * Initializes the GNT log subsystem.
  76  */
  77 void finch_log_init(void);
  78
  79 /**
  80  * finch_log_get_handle:
  81  *
  82  * Returns the GNT log subsystem handle.
  83  *
  84  * Returns: (transfer none): The GNT log subsystem handle.
  85  */
  86 void *finch_log_get_handle(void);
  87
  88 /**
  89  * finch_log_uninit:
  90  *
  91  * Uninitializes the GNT log subsystem.
  92  */
  93 void finch_log_uninit(void);
  94
  95 #endif