add more details for doxygen
[obnox/wireshark/wip.git] / gtk / toolbar.h
1 /* toolbar.h
2  * Definitions for toolbar utility routines
3  * Copyright 2003, Ulf Lamping <ulf.lamping@web.de>
4  *
5  * $Id: toolbar.h,v 1.9 2004/06/04 17:16:58 ulfl Exp $
6  *
7  * Ethereal - Network traffic analyzer
8  * By Gerald Combs <gerald@ethereal.com>
9  * Copyright 1998 Gerald Combs
10  *
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License
13  * as published by the Free Software Foundation; either version 2
14  * of the License, or (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
24  */
25
26 #ifndef __TOOLBAR_H__
27 #define __TOOLBAR_H__
28
29 /** @file
30  *  The main toolbar.
31  *  @ingroup main_window_group
32  */
33
34 /** Create the main toolbar.
35  * @return the new (still hidden) toolbar
36  */
37 GtkWidget *toolbar_new(void);
38
39 /** Redraw the main toolbar. Used, when user changes preferences. */
40 void toolbar_redraw_all(void);
41
42 /** We have (or don't have) a capture file now.
43  *
44  * @param have_capture_file TRUE, if we have a capture file
45  */
46 void set_toolbar_for_capture_file(gboolean have_capture_file);
47
48 /** We have (or don't have) an unsaved capture file now.
49  *
50  * @param have_unsaved_capture_file TRUE, if we have an unsaved capture file
51  */
52 void set_toolbar_for_unsaved_capture_file(gboolean have_unsaved_capture_file);
53
54 /** We have (or don't have) a capture in progress now.
55  *
56  * @param have_capture_file TRUE, if we have a capture in progress file
57  */
58 void set_toolbar_for_capture_in_progress(gboolean have_capture_file);
59
60 /** We have (or don't have) captured packets now.
61  *
62  * @param have_captured_packets TRUE, if we have captured packets
63  */
64 void set_toolbar_for_captured_packets(gboolean have_captured_packets);
65
66 /** Set object data of some buttons (where needed). It's needed so callback 
67  *  functions can read back their required data. Acts like OBJECT_SET_DATA() 
68  *  on multiple buttons.
69  *
70  * @param key the key
71  * @param data the data to set
72  */
73 void set_toolbar_object_data(gchar *key, gpointer data);
74
75 #endif /* __TOOLBAR_H__ */