2 * Dialog box for layout preferences
6 * Wireshark - Network traffic analyzer
7 * By Gerald Combs <gerald@wireshark.org>
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.
31 #include <epan/prefs.h>
33 #include "../globals.h"
34 #include "../ui_util.h"
36 #include "gtk/prefs_layout.h"
37 #include "gtk/gtkglobals.h"
38 #include "gtk/prefs_dlg.h"
39 #include "gtk/gui_utils.h"
41 #include "gtk/dlg_utils.h"
43 #include "../image/icon_layout_1.xpm"
44 #include "../image/icon_layout_2.xpm"
45 #include "../image/icon_layout_3.xpm"
46 #include "../image/icon_layout_4.xpm"
47 #include "../image/icon_layout_5.xpm"
48 #include "../image/icon_layout_6.xpm"
51 #define LAYOUT_QTY (layout_type_max - 1)
54 static void layout_validate_cb(GtkWidget *w _U_, gpointer data);
55 static gint fetch_enum_value(gpointer control, const enum_val_t *enumvals);
60 layout_pane_content_e content[3];
64 #define LAYOUT_TYPE_BUTTONS_KEY "layout_type_buttons"
66 #define LAYOUT_NONE_RB_KEY "layout_none_radio_button"
67 #define LAYOUT_PLIST_RB_KEY "layout_plist_radio_button"
68 #define LAYOUT_PDETAILS_RB_KEY "layout_pdetails_radio_button"
69 #define LAYOUT_PBYTES_RB_KEY "layout_pbytes_radio_button"
71 #define LAYOUT_CONTENT1_VB_KEY "layout_content1_vbox"
72 #define LAYOUT_CONTENT2_VB_KEY "layout_content2_vbox"
73 #define LAYOUT_CONTENT3_VB_KEY "layout_content3_vbox"
76 static GtkWidget *layout_content_radio_vbox(GtkWidget *main_vb, GtkTooltips *tooltips, int i, layout_pane_content_e content) {
77 GtkWidget *radio_vb, *radio_lb;
78 GtkWidget *radio_none_rb, *radio_plist_rb, *radio_pdetails_rb, *radio_pbytes_rb;
83 radio_vb = gtk_vbox_new(FALSE, 0);
84 gtk_container_set_border_width(GTK_CONTAINER(radio_vb), 6);
86 g_snprintf (buf, sizeof(buf), "Pane %d:", i);
87 radio_lb = gtk_label_new(buf);
88 gtk_misc_set_alignment(GTK_MISC(radio_lb), 0.0, 0.5);
89 gtk_container_add(GTK_CONTAINER(radio_vb), radio_lb);
91 radio_none_rb = gtk_radio_button_new_with_mnemonic_from_widget(NULL, "None");
92 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(radio_none_rb), content == layout_pane_content_none);
93 gtk_tooltips_set_tip (tooltips, radio_none_rb, "Put nothing in this pane.", NULL);
94 gtk_container_add(GTK_CONTAINER(radio_vb), radio_none_rb);
96 radio_plist_rb = gtk_radio_button_new_with_mnemonic_from_widget(GTK_RADIO_BUTTON(radio_none_rb), "Packet List");
97 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(radio_plist_rb), content == layout_pane_content_plist);
98 gtk_tooltips_set_tip (tooltips, radio_plist_rb, "Put the packet list in this pane.", NULL);
99 gtk_container_add(GTK_CONTAINER(radio_vb), radio_plist_rb);
101 radio_pdetails_rb = gtk_radio_button_new_with_mnemonic_from_widget(GTK_RADIO_BUTTON(radio_none_rb), "Packet Details");
102 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(radio_pdetails_rb), content == layout_pane_content_pdetails);
103 gtk_tooltips_set_tip (tooltips, radio_pdetails_rb, "Put the packet details tree in this pane.", NULL);
104 gtk_container_add(GTK_CONTAINER(radio_vb), radio_pdetails_rb);
106 radio_pbytes_rb = gtk_radio_button_new_with_mnemonic_from_widget(GTK_RADIO_BUTTON(radio_none_rb), "Packet Bytes");
107 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(radio_pbytes_rb), content == layout_pane_content_pbytes);
108 gtk_tooltips_set_tip (tooltips, radio_pbytes_rb, "Put the packet bytes hexdump in this pane.", NULL);
109 gtk_container_add(GTK_CONTAINER(radio_vb), radio_pbytes_rb);
111 g_object_set_data(G_OBJECT(radio_vb), LAYOUT_NONE_RB_KEY, radio_none_rb);
112 g_object_set_data(G_OBJECT(radio_vb), LAYOUT_PLIST_RB_KEY, radio_plist_rb);
113 g_object_set_data(G_OBJECT(radio_vb), LAYOUT_PDETAILS_RB_KEY, radio_pdetails_rb);
114 g_object_set_data(G_OBJECT(radio_vb), LAYOUT_PBYTES_RB_KEY, radio_pbytes_rb);
116 g_signal_connect(radio_none_rb, "toggled", G_CALLBACK(layout_validate_cb), main_vb);
117 g_signal_connect(radio_plist_rb, "toggled", G_CALLBACK(layout_validate_cb), main_vb);
118 g_signal_connect(radio_pdetails_rb, "toggled", G_CALLBACK(layout_validate_cb), main_vb);
119 g_signal_connect(radio_pbytes_rb, "toggled", G_CALLBACK(layout_validate_cb), main_vb);
125 layout_type_changed_cb (GtkToggleButton * togglebutton, gpointer user_data)
127 GtkWidget ** layout_type_buttons = (GtkWidget**) user_data;
128 static gboolean dampen_feedback_loop = FALSE;
130 if (!dampen_feedback_loop) {
132 dampen_feedback_loop = TRUE;
133 for (i=0; i<LAYOUT_QTY; ++i) {
134 GtkToggleButton * tb = GTK_TOGGLE_BUTTON(layout_type_buttons[i]);
135 gboolean active = togglebutton==tb;
136 if (gtk_toggle_button_get_active(tb) != active)
137 gtk_toggle_button_set_active (tb, active);
139 dampen_feedback_loop = FALSE;
144 static layout_pane_content_e layout_pane_get_content(GtkWidget * radio_vb) {
146 if(gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(g_object_get_data(G_OBJECT(radio_vb), LAYOUT_NONE_RB_KEY))))
147 return layout_pane_content_none;
148 if(gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(g_object_get_data(G_OBJECT(radio_vb), LAYOUT_PLIST_RB_KEY))))
149 return layout_pane_content_plist;
150 if(gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(g_object_get_data(G_OBJECT(radio_vb), LAYOUT_PDETAILS_RB_KEY))))
151 return layout_pane_content_pdetails;
152 if(gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(g_object_get_data(G_OBJECT(radio_vb), LAYOUT_PBYTES_RB_KEY))))
153 return layout_pane_content_pbytes;
155 g_assert_not_reached();
159 static void layout_pane_set_content(GtkWidget * radio_vb, layout_pane_content_e pane_content) {
162 switch(pane_content) {
163 case(layout_pane_content_none):
164 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(g_object_get_data(G_OBJECT(radio_vb), LAYOUT_NONE_RB_KEY)), TRUE);
166 case(layout_pane_content_plist):
167 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(g_object_get_data(G_OBJECT(radio_vb), LAYOUT_PLIST_RB_KEY)), TRUE);
169 case(layout_pane_content_pdetails):
170 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(g_object_get_data(G_OBJECT(radio_vb), LAYOUT_PDETAILS_RB_KEY)), TRUE);
172 case(layout_pane_content_pbytes):
173 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(g_object_get_data(G_OBJECT(radio_vb), LAYOUT_PBYTES_RB_KEY)), TRUE);
176 g_assert_not_reached();
182 static void layout_set(GtkWidget * main_vb, layout_t *layout) {
184 GtkWidget ** layout_type_buttons = g_object_get_data(G_OBJECT(main_vb), LAYOUT_TYPE_BUTTONS_KEY);
186 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(layout_type_buttons[layout->type - 1]), TRUE);
188 radio_vb = g_object_get_data(G_OBJECT(main_vb), LAYOUT_CONTENT1_VB_KEY);
189 layout_pane_set_content(radio_vb, layout->content[0]);
190 radio_vb = g_object_get_data(G_OBJECT(main_vb), LAYOUT_CONTENT2_VB_KEY);
191 layout_pane_set_content(radio_vb, layout->content[1]);
192 radio_vb = g_object_get_data(G_OBJECT(main_vb), LAYOUT_CONTENT3_VB_KEY);
193 layout_pane_set_content(radio_vb, layout->content[2]);
196 static void layout_get(GtkWidget * main_vb, layout_t *layout_out) {
198 GtkWidget ** layout_type_buttons = g_object_get_data(G_OBJECT(main_vb), LAYOUT_TYPE_BUTTONS_KEY);
201 for (i=0; i<LAYOUT_QTY; ++i) {
202 if (gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(layout_type_buttons[i]))) {
203 layout_out->type = i + 1;
208 radio_vb = g_object_get_data(G_OBJECT(main_vb), LAYOUT_CONTENT1_VB_KEY);
209 layout_out->content[0] = layout_pane_get_content(radio_vb);
210 radio_vb = g_object_get_data(G_OBJECT(main_vb), LAYOUT_CONTENT2_VB_KEY);
211 layout_out->content[1] = layout_pane_get_content(radio_vb);
212 radio_vb = g_object_get_data(G_OBJECT(main_vb), LAYOUT_CONTENT3_VB_KEY);
213 layout_out->content[2] = layout_pane_get_content(radio_vb);
216 static void layout_validate(layout_t *layout) {
218 if(layout->content[1] == layout->content[0]) {
219 layout->content[1] = layout_pane_content_none;
221 if(layout->content[2] == layout->content[0] || layout->content[2] == layout->content[1]) {
222 layout->content[2] = layout_pane_content_none;
227 static void layout_validate_cb(GtkWidget *w _U_, gpointer data) {
230 layout_get(data, &layout);
231 layout_validate(&layout);
232 layout_set(data, &layout);
236 layout_defaults_cb (GtkWidget * w _U_, gpointer data _U_)
238 layout_t default_layout = {
241 layout_pane_content_plist,
242 layout_pane_content_pdetails,
243 layout_pane_content_pbytes
247 layout_set(data, &default_layout);
250 #define SCROLLBAR_PLACEMENT_KEY "scrollbar_placement"
251 #define ALTERN_COLORS_KEY "altern_colors"
252 #define HEX_DUMP_HIGHLIGHT_STYLE_KEY "hex_dump_highlight_style"
253 #define FILTER_TOOLBAR_PLACEMENT_KEY "filter_toolbar_show_in_statusbar"
254 #define GUI_TOOLBAR_STYLE_KEY "toolbar_style"
255 #define GUI_WINDOW_TITLE_KEY "window_title"
258 #define GUI_TABLE_ROWS 5
260 static const enum_val_t scrollbar_placement_vals[] = {
261 { "FALSE", "Left", FALSE },
262 { "TRUE", "Right", TRUE },
265 static const enum_val_t altern_colors_vals[] = {
266 { "FALSE", "No", FALSE },
267 { "TRUE", "Yes", TRUE },
270 static const enum_val_t highlight_style_vals[] = {
271 { "FALSE", "Bold", FALSE },
272 { "TRUE", "Inverse", TRUE },
275 static const enum_val_t filter_toolbar_placement_vals[] = {
276 { "FALSE", "Below the main toolbar", FALSE },
277 { "TRUE", "Insert into statusbar", TRUE },
280 static const enum_val_t toolbar_style_vals[] = {
281 { "ICONS", "Icons only", TB_STYLE_ICONS },
282 { "TEXT", "Text only", TB_STYLE_TEXT },
283 { "BOTH", "Icons & Text", TB_STYLE_BOTH },
288 layout_prefs_show(void)
290 GtkWidget *main_vb, *button_hb, *type_tb;
291 GtkWidget *pane_fr, *pane_vb;
292 GtkWidget *radio_hb, *radio_vb;
293 GtkWidget *default_vb, *default_bt;
294 GtkWidget *main_tb, *hbox;
295 GtkWidget *scrollbar_om;
296 GtkWidget *altern_colors_om;
297 GtkWidget *highlight_style_om;
298 GtkWidget *toolbar_style_om;
299 GtkWidget *filter_toolbar_placement_om;
300 GtkWidget *window_title_te;
302 GtkTooltips *tooltips = gtk_tooltips_new();
304 const char ** inline_txt [LAYOUT_QTY] = {
305 icon_layout_5_xpm, icon_layout_2_xpm, icon_layout_1_xpm,
306 icon_layout_4_xpm, icon_layout_3_xpm, icon_layout_6_xpm };
307 GtkWidget ** layout_type_buttons = g_malloc (sizeof(GtkWidget*) * LAYOUT_QTY);
313 /* main vertical box */
314 main_vb = gtk_vbox_new(FALSE, 7);
315 gtk_container_set_border_width(GTK_CONTAINER(main_vb), 5);
318 pane_fr = gtk_frame_new("Panes");
319 gtk_box_pack_start(GTK_BOX(main_vb), pane_fr, FALSE, FALSE, 0);
320 gtk_widget_show(pane_fr);
322 /* pane vertical box */
323 pane_vb = gtk_vbox_new(FALSE, 7);
324 gtk_container_set_border_width(GTK_CONTAINER(pane_vb), 5);
325 gtk_container_add(GTK_CONTAINER(pane_fr), pane_vb);
326 gtk_widget_show(pane_vb);
329 button_hb = gtk_hbox_new(FALSE, 0);
330 gtk_container_set_border_width(GTK_CONTAINER(button_hb), 6);
331 gtk_box_pack_start (GTK_BOX(pane_vb), button_hb, FALSE, FALSE, 0);
334 for (i=0; i<LAYOUT_QTY; ++i)
336 type_tb = gtk_toggle_button_new ();
337 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON(type_tb),
338 (layout_type_e)(i + 1) == prefs.gui_layout_type);
340 gtk_container_add (GTK_CONTAINER(type_tb), xpm_to_widget(inline_txt[i]));
342 g_signal_connect(type_tb, "toggled", G_CALLBACK(layout_type_changed_cb), layout_type_buttons);
343 layout_type_buttons[i] = type_tb;
344 gtk_box_pack_start (GTK_BOX(button_hb), type_tb, TRUE, FALSE, 0);
347 g_object_set_data(G_OBJECT(main_vb), LAYOUT_TYPE_BUTTONS_KEY, layout_type_buttons);
350 radio_hb = gtk_hbox_new(FALSE, 0);
351 gtk_container_set_border_width(GTK_CONTAINER(radio_hb), 6);
352 gtk_box_pack_start (GTK_BOX(pane_vb), radio_hb, FALSE, FALSE, 0);
354 radio_vb = layout_content_radio_vbox(main_vb, tooltips, 1, prefs.gui_layout_content_1);
355 gtk_container_set_border_width(GTK_CONTAINER(radio_vb), 6);
356 gtk_box_pack_start (GTK_BOX(radio_hb), radio_vb, FALSE, FALSE, 0);
357 g_object_set_data(G_OBJECT(main_vb), LAYOUT_CONTENT1_VB_KEY, radio_vb);
359 radio_vb = layout_content_radio_vbox(main_vb, tooltips, 2, prefs.gui_layout_content_2);
360 gtk_container_set_border_width(GTK_CONTAINER(radio_vb), 6);
361 gtk_box_pack_start (GTK_BOX(radio_hb), radio_vb, FALSE, FALSE, 0);
362 g_object_set_data(G_OBJECT(main_vb), LAYOUT_CONTENT2_VB_KEY, radio_vb);
364 radio_vb = layout_content_radio_vbox(main_vb, tooltips, 3, prefs.gui_layout_content_3);
365 gtk_container_set_border_width(GTK_CONTAINER(radio_vb), 6);
366 gtk_box_pack_start (GTK_BOX(radio_hb), radio_vb, FALSE, FALSE, 0);
367 g_object_set_data(G_OBJECT(main_vb), LAYOUT_CONTENT3_VB_KEY, radio_vb);
369 default_vb = gtk_vbox_new(FALSE, 0);
370 default_bt = gtk_button_new_with_label("Default panes");
371 gtk_tooltips_set_tip (tooltips, default_bt,
372 "Reset the pane layout settings to default values.", NULL);
373 g_signal_connect(default_bt, "clicked", G_CALLBACK(layout_defaults_cb), main_vb);
374 gtk_box_pack_end(GTK_BOX(default_vb), default_bt, FALSE, FALSE, 0);
375 gtk_box_pack_end(GTK_BOX(radio_hb), default_vb, FALSE, FALSE, 0);
377 /* Main horizontal box */
378 /* XXX - Is there a better way to center the table? */
379 hbox = gtk_hbox_new(FALSE, 7);
380 gtk_box_pack_start (GTK_BOX(main_vb), hbox, TRUE, FALSE, 0);
383 main_tb = gtk_table_new(GUI_TABLE_ROWS, 2, FALSE);
384 gtk_box_pack_start( GTK_BOX(hbox), main_tb, FALSE, FALSE, 0 );
385 gtk_table_set_row_spacings( GTK_TABLE(main_tb), 10 );
386 gtk_table_set_col_spacings( GTK_TABLE(main_tb), 15 );
388 /* Scrollbar placement */
389 scrollbar_om = create_preference_option_menu(main_tb, pos++,
390 "Vertical scrollbar placement:", NULL, scrollbar_placement_vals,
391 prefs.gui_scrollbar_on_right);
392 gtk_tooltips_set_tip(tooltips, scrollbar_om,
393 "Select where the vertical scrollbar "
394 "will be displayed in the panes.", NULL);
395 g_object_set_data(G_OBJECT(main_vb), SCROLLBAR_PLACEMENT_KEY, scrollbar_om);
397 /* Alternating row colors in list and tree views */
398 altern_colors_om = create_preference_option_menu(main_tb, pos++,
399 "Alternating row colors in lists and trees:", NULL,
400 altern_colors_vals, prefs.gui_altern_colors);
401 gtk_tooltips_set_tip(tooltips, altern_colors_om,
402 "Select whether or not the rows of "
403 "lists and trees have alternating color.", NULL);
404 g_object_set_data(G_OBJECT(main_vb), ALTERN_COLORS_KEY, altern_colors_om);
406 /* Hex Dump highlight style */
407 highlight_style_om = create_preference_option_menu(main_tb, pos++,
408 "Hex display highlight style:", NULL, highlight_style_vals,
409 prefs.gui_hex_dump_highlight_style);
410 gtk_tooltips_set_tip(tooltips, highlight_style_om,
411 "Select the style in which the "
412 "hex dump will be displayed.", NULL);
413 g_object_set_data(G_OBJECT(main_vb), HEX_DUMP_HIGHLIGHT_STYLE_KEY, highlight_style_om);
416 toolbar_style_om = create_preference_option_menu(main_tb, pos++,
417 "Toolbar style:", NULL, toolbar_style_vals,
418 prefs.gui_toolbar_main_style);
419 gtk_tooltips_set_tip(tooltips, toolbar_style_om,
420 "Select the style in which the "
421 "toolbar will be displayed.", NULL);
422 g_object_set_data(G_OBJECT(main_vb), GUI_TOOLBAR_STYLE_KEY, toolbar_style_om);
424 /* Placement of Filter toolbar */
425 filter_toolbar_placement_om = create_preference_option_menu(main_tb, pos++,
426 "Filter toolbar placement:", NULL,
427 filter_toolbar_placement_vals, prefs.filter_toolbar_show_in_statusbar);
428 gtk_tooltips_set_tip(tooltips, filter_toolbar_placement_om,
429 "Select where the filter "
430 "toolbar will be displayed." , NULL);
431 g_object_set_data(G_OBJECT(main_vb), FILTER_TOOLBAR_PLACEMENT_KEY, filter_toolbar_placement_om);
434 window_title_te = create_preference_entry(main_tb, pos++,
435 "Custom window title (prepended to existing titles):",
436 NULL, prefs.gui_window_title);
437 gtk_entry_set_text(GTK_ENTRY(window_title_te), prefs.gui_window_title);
438 gtk_tooltips_set_tip(tooltips, window_title_te,
439 "Enter the text to be prepended to the "
440 "window title.", NULL);
441 g_object_set_data(G_OBJECT(main_vb), GUI_WINDOW_TITLE_KEY, window_title_te);
443 /* Show 'em what we got */
444 gtk_widget_show_all(main_vb);
450 fetch_enum_value(gpointer control, const enum_val_t *enumvals)
452 return fetch_preference_option_menu_val(GTK_WIDGET(control), enumvals);
456 layout_prefs_fetch(GtkWidget *w)
458 layout_t layout_fetched;
460 layout_get(w, &layout_fetched);
462 prefs.gui_layout_type = layout_fetched.type;
463 prefs.gui_layout_content_1 = layout_fetched.content[0];
464 prefs.gui_layout_content_2 = layout_fetched.content[1];
465 prefs.gui_layout_content_3 = layout_fetched.content[2];
467 prefs.gui_scrollbar_on_right = fetch_enum_value(
468 g_object_get_data(G_OBJECT(w), SCROLLBAR_PLACEMENT_KEY),
469 scrollbar_placement_vals);
471 prefs.gui_altern_colors = fetch_enum_value(
472 g_object_get_data(G_OBJECT(w), ALTERN_COLORS_KEY), altern_colors_vals);
473 prefs.filter_toolbar_show_in_statusbar = fetch_enum_value(
474 g_object_get_data(G_OBJECT(w), FILTER_TOOLBAR_PLACEMENT_KEY), filter_toolbar_placement_vals);
475 prefs.gui_hex_dump_highlight_style = fetch_enum_value(
476 g_object_get_data(G_OBJECT(w), HEX_DUMP_HIGHLIGHT_STYLE_KEY), highlight_style_vals);
477 prefs.gui_toolbar_main_style = fetch_enum_value(
478 g_object_get_data(G_OBJECT(w), GUI_TOOLBAR_STYLE_KEY), toolbar_style_vals);
480 g_free(prefs.gui_window_title);
481 prefs.gui_window_title = g_strdup(gtk_entry_get_text(
482 GTK_ENTRY(g_object_get_data(G_OBJECT(w), GUI_WINDOW_TITLE_KEY))));
486 layout_prefs_apply(GtkWidget *w _U_)
488 update_main_window_name();
489 main_widgets_rearrange();
493 layout_prefs_destroy(GtkWidget *main_vb)
495 GtkWidget ** layout_type_buttons = g_object_get_data(G_OBJECT(main_vb), LAYOUT_TYPE_BUTTONS_KEY);
497 g_free(layout_type_buttons);