diff options
| -rw-r--r-- | gtk/layout_prefs.h | 4 | ||||
| -rw-r--r-- | gtk/nameres_prefs.h | 4 | ||||
| -rw-r--r-- | gtk/print_mswin.h | 10 | ||||
| -rw-r--r-- | gtk/print_prefs.h | 4 | ||||
| -rw-r--r-- | gtk/proto_dlg.h | 13 | ||||
| -rw-r--r-- | gtk/proto_draw.h | 164 | ||||
| -rw-r--r-- | gtk/stream_prefs.h | 4 |
7 files changed, 168 insertions, 35 deletions
diff --git a/gtk/layout_prefs.h b/gtk/layout_prefs.h index c1baef40a8..8198dbd7b1 100644 --- a/gtk/layout_prefs.h +++ b/gtk/layout_prefs.h @@ -1,7 +1,7 @@ /* layout_prefs.h * Definitions for layout preferences window * - * $Id: layout_prefs.h,v 1.4 2004/06/02 18:44:10 ulfl Exp $ + * $Id: layout_prefs.h,v 1.5 2004/06/02 20:14:50 ulfl Exp $ * * Ethereal - Network traffic analyzer * By Gerald Combs <gerald@ethereal.com> @@ -26,7 +26,7 @@ #define __LAYOUT_PREFS_H__ /** @file - * "User Interface: Layout" preferences pages. + * "User Interface: Layout" preferences page. */ /** Build a User interface layout preferences page. diff --git a/gtk/nameres_prefs.h b/gtk/nameres_prefs.h index 676847d9e7..7e7e8a621f 100644 --- a/gtk/nameres_prefs.h +++ b/gtk/nameres_prefs.h @@ -1,7 +1,7 @@ /* nameres_prefs.h * Definitions for name resolution preferences window * - * $Id: nameres_prefs.h,v 1.3 2004/06/02 18:44:10 ulfl Exp $ + * $Id: nameres_prefs.h,v 1.4 2004/06/02 20:14:51 ulfl Exp $ * * Ethereal - Network traffic analyzer * By Gerald Combs <gerald@ethereal.com> @@ -26,7 +26,7 @@ #define __NAMERES_PREFS_H__ /** @file - * "Name resolution" preferences pages. + * "Name resolution" preferences page. */ /** Build a Name resolution preferences page. diff --git a/gtk/print_mswin.h b/gtk/print_mswin.h index 2f2429f118..923dc3ff78 100644 --- a/gtk/print_mswin.h +++ b/gtk/print_mswin.h @@ -1,7 +1,7 @@ /* print_mswin.h * Printing support for MSWindows * - * $Id: print_mswin.h,v 1.4 2002/09/09 20:32:31 jmayer Exp $ + * $Id: print_mswin.h,v 1.5 2004/06/02 20:14:51 ulfl Exp $ * * Ethereal - Network traffic analyzer * By Gerald Combs <gerald@ethereal.com> @@ -25,6 +25,14 @@ #ifndef __PRINT_MSWIN_H__ #define __PRINT_MSWIN_H__ +/** @file + * Win32 specific printing. + */ + +/** Print the given file. + * + * @param file_name the file to print + */ void print_mswin(char *file_name); #endif diff --git a/gtk/print_prefs.h b/gtk/print_prefs.h index 4280afadee..d35ed2690d 100644 --- a/gtk/print_prefs.h +++ b/gtk/print_prefs.h @@ -1,7 +1,7 @@ /* print_prefs.h * Definitions for print preferences window * - * $Id: print_prefs.h,v 1.7 2004/06/02 18:44:10 ulfl Exp $ + * $Id: print_prefs.h,v 1.8 2004/06/02 20:14:51 ulfl Exp $ * * Ethereal - Network traffic analyzer * By Gerald Combs <gerald@zing.org> @@ -27,7 +27,7 @@ #define __PRINT_PREFS_H__ /** @file - * "Print" preferences pages. + * "Print" preferences page. */ /** Build a Print preferences page. diff --git a/gtk/proto_dlg.h b/gtk/proto_dlg.h index 48c15d0d17..e6844cf8cb 100644 --- a/gtk/proto_dlg.h +++ b/gtk/proto_dlg.h @@ -1,6 +1,6 @@ /* proto_dlg.h * - * $Id: proto_dlg.h,v 1.3 2003/01/26 19:35:31 deniel Exp $ + * $Id: proto_dlg.h,v 1.4 2004/06/02 20:14:51 ulfl Exp $ * * Laurent Deniel <laurent.deniel@free.fr> * @@ -27,6 +27,15 @@ #ifndef __PROTO_DLG_H__ #define __PROTO_DLG_H__ -void proto_cb(GtkWidget *, gpointer); +/** @file + * "Enabled Protocols" dialog box. + */ + +/** Show the enabled protocols dialog. + * + * @param widget parent widget (unused) + * @param data unused + */ +void proto_cb(GtkWidget *widget, gpointer data); #endif diff --git a/gtk/proto_draw.h b/gtk/proto_draw.h index 0300abce34..6bcce228b4 100644 --- a/gtk/proto_draw.h +++ b/gtk/proto_draw.h @@ -1,7 +1,7 @@ /* proto_draw.h * Definitions for GTK+ packet display structures and routines * - * $Id: proto_draw.h,v 1.25 2004/03/20 06:34:09 guy Exp $ + * $Id: proto_draw.h,v 1.26 2004/06/02 20:14:51 ulfl Exp $ * * Ethereal - Network traffic analyzer * By Gerald Combs <gerald@ethereal.com> @@ -25,55 +25,171 @@ #ifndef __GTKPACKET_H__ #define __GTKPACKET_H__ -/* Get the current text window for the notebook. */ +/** @file + * Packet tree and details panes. + */ + +/** Get the current text notebook page of the packet details notebook. + * + * @param nb_ptr the notebook widget + * @return the notebook page + */ extern GtkWidget *get_notebook_bv_ptr(GtkWidget *nb_ptr); -/* - * Get the data and length for a byte view, given the byte view page. - * Return the pointer, or NULL on error, and set "*data_len" to the length. +/** + * Get the data and length for a byte view, given the byte view page widget. + * + * @param byte_view the byte view to look at + * @param data_len set "*data_len" to the length + * @return the pointer, or NULL on error */ extern const guint8 *get_byte_view_data_and_length(GtkWidget *byte_view, guint *data_len); -/* - * Set the current text window for the notebook to the window that +/** Set the current text page of the notebook to the window that * refers to a particular tvbuff. + * + * @param nb_ptr the byte view notebook + * @param tvb the tvbuff to look at */ extern void set_notebook_page(GtkWidget *nb_ptr, tvbuff_t *tvb); -/* Redraw a given byte view window. */ -extern void redraw_hex_dump(GtkWidget *nb, frame_data *fd, field_info *finfo); +/** Redraw a given byte view window. + * + * @param nb_ptr the byte view notebook + * @param fd ??? + * @param finfo ??? + * @todo think about parameters + */ +extern void redraw_hex_dump(GtkWidget *nb_ptr, frame_data *fd, field_info *finfo); -/* Redraw all byte view windows. */ +/** Redraw all byte view windows. */ extern void redraw_hex_dump_all(void); +/** Create a new byte view (packet details pane). + * + * @return the new byte view + */ extern GtkWidget *byte_view_new(void); +/** Clear and fill all the byte view notebook tabs. + * + * @param edt current dissections + * @param tree_view the corresponding packet tree + * @param nb_ptr the byte view notebook + */ extern void add_byte_views(epan_dissect_t *edt, GtkWidget *tree_view, - GtkWidget *byte_nb_ptr); + GtkWidget *nb_ptr); +/** Gdk button click appeared, select the byte view from that position. + * + * @param widget the byte view + * @param event the button event clicked + * @return TRUE if could be selected + */ extern gboolean byte_view_select(GtkWidget *widget, GdkEventButton *event); #if GTK_MAJOR_VERSION < 2 -void packet_hex_print(GtkText *, const guint8 *, frame_data *, field_info *, - guint); -void packet_hex_reprint(GtkText *); -void set_ptree_font_all(GdkFont *font); +/** Redraw a given byte view window. + * + * @param bv the byte view + * @param pd the packet data + * @param fd the current fame + * @param finfo the current field info + * @param len the byte view length + */ +extern void packet_hex_print(GtkText *bv, const guint8 *pd, frame_data *fd, + field_info *finfo, guint len); + +/** + * Redraw the text using the saved information. Usually called if + * the preferences have changed. + * + * @param bv the byte view + */ +extern void packet_hex_reprint(GtkText *bv); + +/** Set a new font for all protocol trees. + * + * @param font the new font + */ +extern void set_ptree_font_all(GdkFont *font); #else -void packet_hex_print(GtkTextView *, const guint8 *, frame_data *, field_info *, - guint); -void packet_hex_reprint(GtkTextView *); -void set_ptree_font_all(PangoFontDescription *font); -GtkTreePath *tree_find_by_field_info(GtkTreeView *tree_view, field_info *finfo); +/** Redraw a given byte view window. + * + * @param bv the byte view + * @param pd the packet data + * @param fd the current fame + * @param finfo the current field info + * @param len the byte view length + */ +extern void packet_hex_print(GtkTextView *bv, const guint8 *pd, frame_data *fd, + field_info *finfo, guint len); + +/** + * Redraw the text using the saved information. Usually called if + * the preferences have changed. + * + * @param bv the byte view + */ +extern void packet_hex_reprint(GtkTextView *bv); + +/** Set a new font for all protocol trees. + * + * @param font the new font + */ +extern void set_ptree_font_all(PangoFontDescription *font); + +/** Find field in tree view by field_info. + * + * @param tree_view the tree view to look at + * @param finfo the field info the look for + * @return the path to the field + */ +extern GtkTreePath *tree_find_by_field_info(GtkTreeView *tree_view, field_info *finfo); #endif +/** Create a new tree view (packet details). + * + * @param prefs current preferences + * @param tree_view_p fill in the new tree view + * @return the new scrolled window (parent of the tree view) + */ extern GtkWidget * main_tree_view_new(e_prefs *prefs, GtkWidget **tree_view_p); -void proto_tree_draw(proto_tree *protocol_tree, GtkWidget *tree_view); -void expand_all_tree(proto_tree *protocol_tree, GtkWidget *tree_view); -void collapse_all_tree(proto_tree *protocol_tree, GtkWidget *tree_view); +/** Clear and redraw the whole tree view. + * + * @param protocol_tree the currently dissected protocol tree + * @param tree_view the tree view to redraw + */ +extern void proto_tree_draw(proto_tree *protocol_tree, GtkWidget *tree_view); + +/** Expand the whole tree view. + * + * @param protocol_tree the currently dissected protocol tree + * @param tree_view the tree view to redraw + */ +extern void expand_all_tree(proto_tree *protocol_tree, GtkWidget *tree_view); + +/** Collapse the whole tree view. + * + * @param protocol_tree the currently dissected protocol tree + * @param tree_view the tree view to redraw + */ +extern void collapse_all_tree(proto_tree *protocol_tree, GtkWidget *tree_view); + +/** Gdk button click appeared, select the byte view from that position. + * + * @param widget the tree view + * @param event the button event clicked + * @return TRUE if could be selected + */ extern gboolean tree_view_select(GtkWidget *widget, GdkEventButton *event); -void set_ptree_sel_browse_all(gboolean); +/** Set the selection mode of all packet tree windows. + * + * @param val GTK_SELECTION_SINGLE if TRUE, GTK_SELECTION_BROWSE if FALSE + */ +extern void set_ptree_sel_browse_all(gboolean val); #endif diff --git a/gtk/stream_prefs.h b/gtk/stream_prefs.h index 8712ad0a90..1dad1b0a36 100644 --- a/gtk/stream_prefs.h +++ b/gtk/stream_prefs.h @@ -1,7 +1,7 @@ /* stream_prefs.h * Definitions for stream preferences window * - * $Id: stream_prefs.h,v 1.5 2004/06/02 18:44:10 ulfl Exp $ + * $Id: stream_prefs.h,v 1.6 2004/06/02 20:14:51 ulfl Exp $ * * Ethereal - Network traffic analyzer * By Gerald Combs <gerald@zing.org> @@ -27,7 +27,7 @@ #define __STREAM_PREFS_H__ /** @file - * "User Interface: Colors" preferences pages. + * "User Interface: Colors" preferences page. * @todo rename functions and files from stream to colors */ |