Move the new files to the same places as in automake.
[obnox/wireshark/wip.git] / ui / 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 #ifdef __cplusplus
30 extern "C" {
31 #endif /* __cplusplus */
32
33 #include <glib.h>
34
35 /** @file
36  *  Recent user interface settings.
37  *  @ingroup main_window_group
38  */
39
40 /** ???. */
41 #define RECENT_KEY_CAPTURE_FILE         "recent.capture_file"
42
43 /** ???. */
44 #define RECENT_KEY_DISPLAY_FILTER       "recent.display_filter"
45
46 #define RECENT_KEY_COL_WIDTH            "column.width"
47
48 #define RECENT_KEY_CAPTURE_FILTER       "recent.capture_filter"
49
50 #define RECENT_KEY_REMOTE_HOST          "recent.remote_host"
51
52 typedef struct _col_width_data {
53   gint   cfmt;
54   gchar *cfield;
55   gint   width;
56   gchar  xalign;
57 } col_width_data;
58
59 /** Defines used in col_width_data.xalign */
60 #define COLUMN_XALIGN_DEFAULT  0
61 #define COLUMN_XALIGN_LEFT    'L'
62 #define COLUMN_XALIGN_CENTER  'C'
63 #define COLUMN_XALIGN_RIGHT   'R'
64
65 /** Recent settings. */
66 typedef struct recent_settings_tag {
67     gboolean    main_toolbar_show;
68     gboolean    filter_toolbar_show;
69     gboolean    airpcap_toolbar_show;
70     gboolean    airpcap_driver_check_show;
71     gboolean    packet_list_show;
72     gboolean    tree_view_show;
73     gboolean    byte_view_show;
74     gboolean    statusbar_show;
75     gboolean    packet_list_colorize;
76     gint        gui_time_format;
77     gint        gui_time_precision;
78     gint        gui_seconds_format;
79     gint        gui_zoom_level;
80     gint        gui_bytes_view;
81
82     gint        gui_geometry_main_x;
83     gint        gui_geometry_main_y;
84     gint        gui_geometry_main_width;
85     gint        gui_geometry_main_height;
86
87     gboolean    gui_geometry_main_maximized;
88
89     gboolean    has_gui_geometry_main_upper_pane;   /* gui_geometry_main_upper_pane is valid */
90     gint        gui_geometry_main_upper_pane;
91     gboolean    has_gui_geometry_main_lower_pane;   /* gui_geometry_main_lower_pane is valid */
92     gint        gui_geometry_main_lower_pane;
93     gboolean    has_gui_geometry_status_pane;       /* gui_geometry_status_pane is valid */
94     gint        gui_geometry_status_pane_left;
95     gint        gui_geometry_status_pane_right;
96     gint        gui_geometry_wlan_stats_pane;
97     gboolean    privs_warn_if_elevated;
98     gboolean    privs_warn_if_no_npf;
99     GList      *col_width_list;                     /* column widths */
100     gchar      *gui_fileopen_remembered_dir;        /* folder of last capture loaded in File Open dialog */
101 } recent_settings_t;
102
103 /** Global recent settings. */
104 extern recent_settings_t recent;
105
106 /** Write recent settings file.
107  *
108  * @return TRUE if succeeded, FALSE if failed
109  */
110 extern gboolean write_recent(void);
111
112 /** Write profile recent settings file.
113  *
114  * @return TRUE if succeeded, FALSE if failed
115  */
116 extern gboolean write_profile_recent(void);
117
118 /** Read recent settings file (static part).
119  *
120  * @param rf_path_return path to recent file if function failed
121  * @param rf_errno_return if failed
122  */
123 extern void recent_read_static(char **rf_path_return, int *rf_errno_return);
124
125 /** Read profile recent settings file (static part).
126  *
127  * @param rf_path_return path to recent file if function failed
128  * @param rf_errno_return if failed
129  */
130 extern void recent_read_profile_static(char **rf_path_return, int *rf_errno_return);
131
132 /** Read recent settings file (dynamic part).
133  *
134  * @param rf_path_return path to recent file if function failed
135  * @param rf_errno_return if failed
136  */
137 extern void recent_read_dynamic(char **rf_path_return, int *rf_errno_return);
138
139 /** Write the geometry values of a single window to the recent file.
140  *
141  * @param key unused
142  * @param value the geometry values
143  * @param rf recent file handle (FILE)
144  */
145 extern void write_recent_geom(gpointer key, gpointer value, gpointer rf);
146
147 /**
148  * Given a -o command line string, parse it and set the recent value in
149  * question.  Return an indication of whether it succeeded or failed
150  * in some fashion.
151  *
152  * @param prefarg a string of the form "<recent name>:<recent value>", as might appear
153  * as an argument to a "-o" command line option
154  * @return PREFS_SET_OK or PREFS_SET_SYNTAX_ERR
155  */
156 extern int recent_set_arg(char *prefarg);
157
158 /** Get the column width for the given column
159  *
160  * @param col column number
161  */
162 extern gint recent_get_column_width(gint col);
163
164 /** Set the column width for the given column
165  *
166  * @param col column number
167  * @param width column width
168  */
169 extern void recent_set_column_width(gint col, gint width);
170
171 /** Get the column xalign for the given column
172  *
173  * @param col column number
174  */
175 extern gchar recent_get_column_xalign(gint col);
176
177 /** Set the column xalign for the given column
178  *
179  * @param col column number
180  * @param xalign column alignment
181  */
182 extern void recent_set_column_xalign(gint col, gchar xalign);
183
184 #ifdef __cplusplus
185 }
186 #endif /* __cplusplus */
187
188 #endif /* recent.h */