2 * Header file for display filter dialog used by gui taps
3 * Copyright 2003 Lars Roland
7 * Wireshark - Network traffic analyzer
8 * By Gerald Combs <gerald@wireshark.org>
9 * Copyright 1998 Gerald Combs
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.
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.
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.
26 #ifndef __TAP_DFILTER_DLG_H__
27 #define __TAP_DFILTER_DLG_H__
30 * You can easily add a display filter dialog for your gui tap by using
31 * the following infrastructure:
33 * Define a global structure of tap_dfilter_dlg within your tap source file.
35 * 1) a title string for the Dialog Window
36 * 2) the init string, which is the same as the string after "-z" option without
37 * the filter string and without the separating comma.
38 * 3) a pointer to the init function of the tap, which will be called when you click
39 * on the start button in the display filter dialog.
40 * 4) the index with "-1"
42 * Within register_tap_menu_yourtap(void), call register_dfilter_stat()
43 * with a pointer to the tap_dfilter_dlg structure, a string for the
44 * menu item (don't put "..." at the end, register_dfilter_stat() will
45 * add it for you), and the REGISTER_STAT_GROUP_ value for the stat
46 * group to which your stat should belong.
50 * tap_dfilter_dlg my_tap_dfilter_dlg = {"My Title", "myproto,mytap", gtk_mytap_init, -1};
52 * register_tap_menu_mytap(void) {
53 * register_dfilter_stat(&my_tap_dfilter_dlg, "My Menu Item",
54 * REGISTER_STAT_GROUP_my_group);
57 * See also: h225_ras_srt.c or h225_counter.c
61 typedef struct _tap_dfilter_dlg {
62 const char *win_title; /* title */
63 const char *init_string; /* the string to call the tap without a filter via "-z" option */
64 void (* tap_init_cb)(const char *,void*); /* callback to init function of the tap */
65 gint index; /* initiate this value always with "-1" */
69 * Register a stat that has a display filter dialog.
70 * We register it both as a command-line stat and a menu item stat.
72 void register_dfilter_stat(tap_dfilter_dlg *info, const char *name,
73 register_stat_group_t group);
75 /* This will update the titles of the dialog windows when we load a new capture file. */
76 void tap_dfilter_dlg_update (void);
78 #endif /* __TAP_DFILTER_DLG_H__ */