code cleanup
[obnox/wireshark/wip.git] / gtk / about_dlg.h
1 /* about_dlg.h
2  * Declarations of routines for the "About" dialog
3  *
4  * $Id$
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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
23  */
24
25 #ifndef __ABOUT_DLG_H__
26 #define __ABOUT_DLG_H__
27
28 /** @file
29  *  "About" dialog box.
30  *  @ingroup dialog_group
31  */
32
33 /** Create a splash screen showed when Wireshark is started. 
34  *
35  * @param message the new message to be displayed
36  * @return the newly created window handle
37  */
38 extern GtkWidget *splash_new(char *message);
39
40 /** Update the splash screen message. 
41  *
42  * @param win the window handle from splash_new()
43  * @param message the new message to be displayed
44  */
45 extern void splash_update(GtkWidget *win, char *message);
46
47 /** Destroy the splash screen. 
48  *
49  * @param win the window handle from splash_new()
50  * @return always FALSE, so this function can be used as a callback for gtk_timeout_add()
51  */
52 extern guint splash_destroy(GtkWidget *win);
53
54 /** User requested the "About" dialog box by menu or toolbar.
55  *
56  * @param widget parent widget (unused)
57  * @param data unused
58  */
59 extern void about_wireshark_cb( GtkWidget *widget, gpointer data);
60
61
62 #endif /* __ABOUT_DLG_H__ */