2 * Definitions for color filters
6 * Ethereal - Network traffic analyzer
7 * By Gerald Combs <gerald@ethereal.com>
8 * Copyright 1998 Gerald Combs
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public License
12 * as published by the Free Software Foundation; either version 2
13 * of the License, or (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 #ifndef __COLOR_FILTERS_H__
25 #define __COLOR_FILTERS_H__
31 /* Data for a color filter. */
32 typedef struct _color_filter {
33 gchar *filter_name; /* name of the filter */
34 gchar *filter_text; /* text of the filter expression */
35 color_t bg_color; /* background color for packets that match */
36 color_t fg_color; /* foreground color for packets that match */
37 dfilter_t *c_colorfilter; /* compiled filter expression */
38 void *edit_dialog; /* if filter is being edited, dialog
40 gboolean marked; /* set if the filter is marked in the color dialog box */
43 /* List of all color filters. */
44 extern GSList *color_filter_list;
46 /** Init the color filters. */
47 void color_filters_init(void);
49 /** Save filters in users filter file.
51 * @return TRUE if write succeeded
53 gboolean color_filters_write(void);
55 /** Delete users filter file and reload global filters.
57 * @return TRUE if write succeeded
59 gboolean color_filters_revert(void);
61 /** Load filters (import) from some other filter file.
63 * @param path the path to the filter file
64 * @param arg the color filter widget
65 * @return TRUE, if read succeeded
67 gboolean color_filters_import(gchar *path, gpointer arg);
69 /** Save filters (export) to some other filter file.
71 * @param path the path to the filter file
72 * @param only_marked TRUE if only the marked filters should be saved
73 * @return TRUE, if write succeeded
75 gboolean color_filters_export(gchar *path, gboolean only_marked);
77 /** @todo don't what this function is for, please add explanation
79 void color_filters_prime_edt(epan_dissect_t *edt);
81 /** Color filters currently used?
83 * @return TRUE, if filters are used
85 gboolean color_filters_used(void);
87 /** En-/disable color filters
89 * @param enable TRUE to enable (default)
92 color_filters_enable(gboolean enable);
94 /** Colorize a specific packet.
96 * @param row the row in the packet list
97 * @param edt the dissected packet
98 * @return the matching color filter or NULL
101 color_filters_colorize_packet(gint row, epan_dissect_t *edt);
103 /** Create a new color filter.
105 * @param name the name of the filter
106 * @param filter_string the filter string
107 * @param bg_color background color
108 * @param fg_color foreground color
109 * @return the new color filter
111 color_filter_t *color_filter_new(const gchar *name, const gchar *filter_string,
112 color_t *bg_color, color_t *fg_color);
114 /** Remove the color filter.
116 * @param colorf the color filter to be removed
118 void color_filter_remove(color_filter_t *colorf);
120 /** Add a color filter.
122 * @param colorf the new color filter
123 * @param arg the color filter widget
125 void color_filter_add_cb (color_filter_t *colorf, gpointer arg);