finch/gntlog.h

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