gtk/recent.h

   1 /* recent.h
   2  * Definitions for recent "preference" handling routines
   3  * Copyright 2004, Ulf Lamping <ulf.lamping@web.de>
   4  *
   5  * $Id$
   6  *
   7  * Wireshark - Network traffic analyzer
   8  * By Gerald Combs <gerald@wireshark.org>
   9  * Copyright 1998 Gerald Combs
  10  *
  11  * This program is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU General Public License
  13  * as published by the Free Software Foundation; either version 2
  14  * of the License, or (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  24  */
  25
  26 #ifndef __RECENT_H__
  27 #define __RECENT_H__
  28
  29 #include <glib.h>
  30
  31 /** @file
  32  *  Recent user interface settings.
  33  *  @ingroup main_window_group
  34  */
  35
  36 /** ???. */
  37 #define RECENT_KEY_CAPTURE_FILE         "recent.capture_file"
  38
  39 /** ???. */
  40 #define RECENT_KEY_DISPLAY_FILTER       "recent.display_filter"
  41
  42 /** Recent settings. */
  43 typedef struct recent_settings_tag {
  44     gboolean    main_toolbar_show;
  45     gboolean    filter_toolbar_show;
  46         gboolean        airpcap_toolbar_show;
  47     gboolean    packet_list_show;
  48     gboolean    tree_view_show;
  49     gboolean    byte_view_show;
  50     gboolean    statusbar_show;
  51     gboolean    packet_list_colorize;
  52     gint        gui_time_format;
  53     gint        gui_time_precision;
  54     gint        gui_zoom_level;
  55
  56     gint        gui_geometry_main_x;
  57     gint        gui_geometry_main_y;
  58     gint        gui_geometry_main_width;
  59     gint        gui_geometry_main_height;
  60
  61     gboolean    gui_geometry_main_maximized;    /* this is valid in GTK2 only */
  62
  63     gboolean    has_gui_geometry_main_upper_pane;   /* gui_geometry_main_upper_pane is valid */
  64     gint        gui_geometry_main_upper_pane;       /* this is autodetected in GTK2 only */
  65     gboolean    has_gui_geometry_main_lower_pane;   /* gui_geometry_main_lower_pane is valid */
  66     gint        gui_geometry_main_lower_pane;       /* this is autodetected in GTK2 only */
  67     gboolean    has_gui_geometry_status_pane;       /* gui_geometry_status_pane is valid */
  68     gint        gui_geometry_status_pane;           /* this is autodetected in GTK2 only */
  69 } recent_settings_t;
  70
  71 /** Global recent settings. */
  72 extern recent_settings_t recent;
  73
  74 /** Write recent settings file.
  75  *
  76  * @return TRUE if succeeded, FALSE if failed
  77  */
  78 extern gboolean write_recent(void);
  79
  80 /** Read recent settings file (static part).
  81  *
  82  * @param rf_path_return path to recent file if function failed
  83  * @param rf_errno_return if failed
  84  */
  85 extern void recent_read_static(char **rf_path_return, int *rf_errno_return);
  86
  87 /** Read recent settings file (dynamic part).
  88  *
  89  * @param rf_path_return path to recent file if function failed
  90  * @param rf_errno_return if failed
  91  */
  92 extern void recent_read_dynamic(char **rf_path_return, int *rf_errno_return);
  93
  94 /** Write the geometry values of a single window to the recent file.
  95  *
  96  * @param key unused
  97  * @param value the geometry values
  98  * @param rf recent file handle (FILE)
  99  */
 100 extern void write_recent_geom(gpointer key, gpointer value, gpointer rf);
 101
 102 /**
 103  * Given a -o command line string, parse it and set the recent value in
 104  * question.  Return an indication of whether it succeeded or failed
 105  * in some fashion.
 106  *
 107  * @param prefarg a string of the form "<recent name>:<recent value>", as might appear
 108  * as an argument to a "-o" command line option
 109  * @return PREFS_SET_OK or PREFS_SET_SYNTAX_ERR
 110  */
 111 extern int recent_set_arg(char *prefarg);
 112
 113 #endif /* recent.h */