GTK3 typo fixes:
[obnox/wireshark/wip.git] / gtk / new_packet_list.h
1 /* new_packet_list.h
2  *
3  * $Id$
4  *
5  * Wireshark - Network traffic analyzer
6  * By Gerald Combs <gerald@wireshark.org>
7  * Copyright 1998 Gerald Combs
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
22  * USA.
23  */
24
25 #ifndef __NEW_PACKET_LIST_H__
26 #define __NEW_PACKET_LIST_H__
27
28 #include <gtk/gtk.h>
29
30 /** @file
31  *  @ingroup main_window_group
32  */
33
34 #define RECENT_KEY_COL_WIDTH                "column.width"
35
36 typedef enum {
37   COLUMN_SELECTED_SORT_ASCENDING,
38   COLUMN_SELECTED_SORT_DESCENDING,
39   COLUMN_SELECTED_SORT_NONE,
40   COLUMN_SELECTED_TOGGLE_RESOLVED,
41   COLUMN_SELECTED_ALIGN_LEFT,
42   COLUMN_SELECTED_ALIGN_CENTER,
43   COLUMN_SELECTED_ALIGN_RIGHT,
44   COLUMN_SELECTED_ALIGN_DEFAULT,
45   COLUMN_SELECTED_RESIZE,
46   COLUMN_SELECTED_CHANGE,
47   COLUMN_SELECTED_HIDE,
48   COLUMN_SELECTED_REMOVE
49 } COLUMN_SELECTED_E;
50
51 /** Create the packet list */
52 GtkWidget *new_packet_list_create(void);
53 /** Recreate the packetr list */
54 void new_packet_list_recreate(void);
55 void new_packet_list_toggle_visible_column (gint col_id);
56 void new_packet_list_set_all_columns_visible (void);
57 void new_packet_list_column_menu_cb (GtkWidget *w, gpointer data, COLUMN_SELECTED_E action);
58 void new_packet_list_resize_columns_cb(GtkWidget *widget _U_, gpointer data _U_);
59 gboolean new_packet_list_get_event_row_column(GdkEventButton *event_button, gint *physical_row, gint *row, gint *column);
60 guint new_packet_list_get_column_id (gint col_num);
61
62 /** Set the font of the packet list window.
63  *
64  * @param font new font
65  */
66 extern void new_packet_list_set_font(PangoFontDescription *font);
67
68 /** Mark the currently selected packet.
69  *
70  * @param widget parent widget (unused)
71  * @param data unused
72  */
73 extern void new_packet_list_mark_frame_cb(GtkWidget *widget, gpointer data);
74
75 /** Toggle Mark on all displayed packets.
76  *
77  * @param widget parent widget (unused)
78  * @param data unused
79  */
80 extern void new_packet_list_toggle_mark_all_displayed_frames_cb(GtkWidget *w _U_, gpointer data _U_);
81
82 /** Mark all displayed packets.
83  *
84  * @param widget parent widget (unused)
85  * @param data unused
86  */
87 extern void new_packet_list_mark_all_displayed_frames_cb(GtkWidget *w _U_, gpointer data _U_);
88
89 /** UnMark all packets in the capture.
90  *
91  * @param widget parent widget (unused)
92  * @param data unused
93  */
94 extern void new_packet_list_unmark_all_displayed_frames_cb(GtkWidget *w _U_, gpointer data _U_);
95
96 /** Ignore the currently selected packet.
97  *
98  * @param widget parent widget (unused)
99  * @param data unused
100  */
101 extern void new_packet_list_ignore_frame_cb(GtkWidget *widget, gpointer data);
102
103 /** Ignore/Unignore all displayed packets.
104  *
105  * @param widget parent widget (unused)
106  * @param data unused
107  */
108 extern void new_packet_list_ignore_all_displayed_frames_cb(GtkWidget *w _U_, gpointer data _U_);
109
110 /** Un-ignore all packets in the list.
111  *
112  * @param widget parent widget (unused)
113  * @param data unused
114  */
115 extern void new_packet_list_unignore_all_frames_cb(GtkWidget *w _U_, gpointer data _U_);
116
117 /** Un-Time Reference all packets in the capture.
118  *
119  * @param widget parent widget (unused)
120  * @param data unused
121  */
122 extern void new_packet_list_untime_reference_all_frames_cb(GtkWidget *w _U_, gpointer data _U_);
123
124 /** Different modes of copying summary data */
125 typedef enum {
126     CS_TEXT, /**< Packet summary data (tab separated) */
127     CS_CSV   /**< Packet summary data (comma separated) */
128 } copy_summary_type;
129
130 /** Called when user clicks on menu item to copy summary data.
131  *
132  *  @param w Not used.
133  *  @param data Not used.
134  *  @param copy_type Mode in which to copy data (e.g. tab-separated, CSV)
135  */
136 void new_packet_list_copy_summary_cb(GtkWidget * w _U_, gpointer data _U_, copy_summary_type copy_type);
137
138 /** Write all packet list geometry values to the recent file.
139  *
140  *  @param rf recent file handle from caller
141  */
142 extern void new_packet_list_recent_write_all(FILE *rf);
143
144 GtkWidget * new_packet_list_get_widget(void);
145 void new_packet_list_colorize_packets(void);
146
147 /** Set the selection mode of the packet list window.
148  *
149  * @param val TRUE for GTK_SELECTION_SINGLE, FALSE for GTK_SELECTION_BROWSE
150  * @param force_set TRUE to force setting of the selection mode even if it
151  *                  was already set (used within packet_list_recreate).
152  */
153 extern void new_packet_list_set_sel_browse(gboolean val, gboolean force_set);
154
155 #endif /* __NEW_PACKET_LIST_H__ */