finch/gntlog.h

   1 /*
   2  * finch
   3  *
   4  * Finch is the legal property of its developers, whose names are too numerous
   5  * to list here.  Please refer to the COPYRIGHT file distributed with this
   6  * source distribution.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  21  */
  22
  23 #ifndef FINCH_LOG_H
  24 #define FINCH_LOG_H
  25
  26 /**
  27  * SECTION:gntlog
  28  * @section_id: finch-gntlog
  29  * @short_description: <filename>gntlog.h</filename>
  30  * @title: Log Viewer
  31  */
  32
  33 #include "log.h"
  34 #include "account.h"
  35 #include "gntwidget.h"
  36
  37 typedef struct _FinchLogViewer FinchLogViewer;
  38
  39 /**
  40  * FinchLogViewer:
  41  * @logs: The list of logs viewed in this viewer
  42  * @window: The viewer's window
  43  * @tree:   The tree representing said treestore
  44  * @text:   The text to display said logs
  45  * @entry:  The search entry, in which search terms are entered
  46  * @label:  The label for the log viewer
  47  * @flags:  The most recently used log flags
  48  * @search: The string currently being searched for
  49  *
  50  * A GNT Log Viewer.  You can look at logs with it.
  51  */
  52 struct _FinchLogViewer {
  53         GList *logs;
  54
  55         GntWidget       *window;
  56         GntWidget       *tree;
  57         GntWidget       *text;
  58         GntWidget       *entry;
  59         GntWidget       *label;
  60         PurpleLogReadFlags flags;
  61         char            *search;
  62 };
  63
  64
  65
  66 void finch_log_show(PurpleLogType type, const char *username, PurpleAccount *account);
  67 void finch_log_show_contact(PurpleContact *contact);
  68
  69 void finch_syslog_show(void);
  70
  71 /**************************************************************************/
  72 /* GNT Log Subsystem                                                      */
  73 /**************************************************************************/
  74
  75 /**
  76  * finch_log_init:
  77  *
  78  * Initializes the GNT log subsystem.
  79  */
  80 void finch_log_init(void);
  81
  82 /**
  83  * finch_log_get_handle:
  84  *
  85  * Returns the GNT log subsystem handle.
  86  *
  87  * Returns: (transfer none): The GNT log subsystem handle.
  88  */
  89 void *finch_log_get_handle(void);
  90
  91 /**
  92  * finch_log_uninit:
  93  *
  94  * Uninitializes the GNT log subsystem.
  95  */
  96 void finch_log_uninit(void);
  97
  98 #endif /* FINCH_LOG_H */
  99