Qt: Automatically scroll the packet list.
[metze/wireshark/wip.git] / ui / ui_util.h
1 /* ui_util.h
2  * Declarations of UI utility routines; these routines have GUI-independent
3  * APIs, but GUI-dependent implementations, so that they can be called by
4  * GUI-independent code to affect the GUI.
5  *
6  * Wireshark - Network traffic analyzer
7  * By Gerald Combs <gerald@wireshark.org>
8  * Copyright 1998 Gerald Combs
9  *
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.
14  *
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.
19  *
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23  */
24
25 #ifndef __UI_UTIL_H__
26 #define __UI_UTIL_H__
27
28 #include "epan/packet_info.h"
29 #include "epan/column-utils.h"
30
31 #ifdef __cplusplus
32 extern "C" {
33 #endif /* __cplusplus */
34
35 /** geometry values for use in window_get_geometry() and window_set_geometry() */
36 typedef struct window_geometry_s {
37     gchar       *key;           /**< current key in hashtable (internally used only) */
38     gboolean    set_pos;        /**< set the x and y position values */
39     gint        x;              /**< the windows x position */
40     gint        y;              /**< the windows y position */
41     gboolean    set_size;       /**< set the width and height values */
42     gint        width;          /**< the windows width */
43     gint        height;         /**< the windows height */
44
45     gboolean    set_maximized;  /**< set the maximized state (GTK2 only) */
46     gboolean    maximized;      /**< the windows maximized state (GTK2 only) */
47 } window_geometry_t;
48
49 /* update the main window */
50 extern void main_window_update(void);
51 /* quit a nested main window */
52 extern void main_window_nested_quit(void);
53 /* quit the main window */
54 extern void main_window_quit(void);
55
56 /* read from a pipe (callback) */
57 typedef gboolean (*pipe_input_cb_t) (gint source, gpointer user_data);
58 /* install callback function, called if pipe input is available */
59 extern void pipe_input_set_handler(gint source, gpointer user_data, int *child_process, pipe_input_cb_t input_cb);
60
61 /* packet_list.c */
62
63 void packet_list_clear(void);
64 void packet_list_freeze(void);
65 void packet_list_recreate_visible_rows(void);
66 void packet_list_thaw(void);
67 void packet_list_next(void);
68 void packet_list_prev(void);
69 guint packet_list_append(column_info *cinfo, frame_data *fdata);
70 frame_data *packet_list_get_row_data(gint row);
71 void packet_list_set_selected_row(gint row);
72 void packet_list_enable_color(gboolean enable);
73 void packet_list_queue_draw(void);
74 void packet_list_select_first_row(void);
75 void packet_list_select_last_row(void);
76 void packet_list_moveto_end(void);
77 gboolean packet_list_check_end(void); /* GTK+ only */
78 gboolean packet_list_select_row_from_data(frame_data *fdata_needle);
79 void packet_list_resize_column(gint col);
80
81 #ifdef __cplusplus
82 }
83 #endif /* __cplusplus */
84
85 #endif /* __UI_UTIL_H__ */
86
87 /*
88  * Editor modelines
89  *
90  * Local Variables:
91  * c-basic-offset: 4
92  * tab-width: 8
93  * indent-tabs-mode: nil
94  * End:
95  *
96  * ex: set shiftwidth=4 tabstop=8 expandtab:
97  * :indentSize=4:tabSize=8:noTabs=true:
98  */