name change

[obnox/wireshark/wip.git] / gtk / help_dlg.h

diff --git a/gtk/help_dlg.h b/gtk/help_dlg.h
index 1e4fb470004f8ca8df0d2b79b66038a1cc37127b..33e788a3a2e3390e900a9827c850a7f405da519a 100644 (file)
--- a/gtk/help_dlg.h
+++ b/gtk/help_dlg.h
@@ -1,10 +1,10 @@
 /* help_dlg.h
  *
- * $Id: help_dlg.h,v 1.7 2004/06/01 17:33:36 ulfl Exp $
+ * $Id$
  *
  * Laurent Deniel <laurent.deniel@free.fr>
  *
- * Ethereal - Network traffic analyzer
+ * Wireshark - Network traffic analyzer
  * By Gerald Combs <gerald@zing.org>
  * Copyright 2000 Gerald Combs
  *
@@ -29,24 +29,76 @@
 
 /** @file
  * "Help" dialog box.
+ *  @ingroup dialog_group
  */
 
-/** User requested the "Help" dialog box by menu or toolbar.
+typedef enum {
+    /* pages online at www.ethereal.com */
+    ONLINEPAGE_HOME,
+    ONLINEPAGE_WIKI,
+    ONLINEPAGE_USERGUIDE,
+    ONLINEPAGE_FAQ,
+    ONLINEPAGE_DOWNLOAD,
+    ONLINEPAGE_SAMPLE_FILES,
+
+    /* local manual pages */
+    LOCALPAGE_MAN_ETHEREAL = 100,
+    LOCALPAGE_MAN_ETHEREAL_FILTER,
+    LOCALPAGE_MAN_TETHEREAL,
+    LOCALPAGE_MAN_DUMPCAP,
+    LOCALPAGE_MAN_MERGECAP,
+    LOCALPAGE_MAN_EDITCAP,
+    LOCALPAGE_MAN_TEXT2PCAP,
+
+    /* help pages (textfiles or local HTML User's Guide) */
+    HELP_CONTENT = 200,
+    HELP_GETTING_STARTED,           /* currently unused */
+    HELP_CAPTURE_OPTIONS_DIALOG,
+    HELP_CAPTURE_FILTERS_DIALOG,
+    HELP_DISPLAY_FILTERS_DIALOG,
+    HELP_COLORING_RULES_DIALOG,
+    HELP_PRINT_DIALOG,
+    HELP_FIND_DIALOG,
+    HELP_FILESET_DIALOG,
+    HELP_GOTO_DIALOG,
+    HELP_CAPTURE_INTERFACES_DIALOG,
+    HELP_ENABLED_PROTOCOLS_DIALOG,
+    HELP_DECODE_AS_DIALOG,
+    HELP_DECODE_AS_SHOW_DIALOG,
+    HELP_FOLLOW_TCP_STREAM_DIALOG,  /* currently unused */
+    HELP_STATS_SUMMARY_DIALOG,
+    HELP_STATS_PROTO_HIERARCHY_DIALOG,
+    HELP_STATS_ENDPOINTS_DIALOG,
+    HELP_STATS_CONVERSATIONS_DIALOG,
+    HELP_STATS_IO_GRAPH_DIALOG,
+    HELP_CAPTURE_INTERFACES_DETAILS_DIALOG,
+    HELP_PREFERENCES_DIALOG
+} topic_action_e;
+
+
+/** Open a specific topic (create a "Help" dialog box or open a webpage).
  *
  * @param widget parent widget (unused)
- * @param data unused
+ * @param topic the topic to display
  */
-void help_cb(GtkWidget *widget, gpointer data);
+void topic_cb(GtkWidget *widget, topic_action_e topic);
 
-/** Create a "Help" dialog box and start with a specific topic.
- *  Will show the first page if topic is not found.
+/** Open a specific topic called from a menu item.
  *
  * @param widget parent widget (unused)
- * @param topic the topic to display (a string)
+ * @param data user_data (unused)
+ * @param topic the topic to display
+ */
+void topic_menu_cb(GtkWidget *widget _U_, gpointer data _U_, topic_action_e topic);
+
+/** Check, if a specific topic is available.
+ *
+ * @param action the topic action to display
+ * @return TRUE, if topic is available, FALSE if not
  */
-void help_topic_cb(GtkWidget *widget, gpointer topic);
+gboolean topic_available(topic_action_e action);
 
-/** Redraw all the text widgets, to use a new font. */
+/** Redraw all the help dialog text widgets, to use a new font. */
 void help_redraw(void);
 
 #endif