aboutsummaryrefslogtreecommitdiffstats
path: root/ui/gtk/help_dlg.h
diff options
context:
space:
mode:
Diffstat (limited to 'ui/gtk/help_dlg.h')
-rw-r--r--ui/gtk/help_dlg.h136
1 files changed, 136 insertions, 0 deletions
diff --git a/ui/gtk/help_dlg.h b/ui/gtk/help_dlg.h
new file mode 100644
index 0000000000..1626ff5093
--- /dev/null
+++ b/ui/gtk/help_dlg.h
@@ -0,0 +1,136 @@
+/* help_dlg.h
+ *
+ * $Id$
+ *
+ * Laurent Deniel <laurent.deniel@free.fr>
+ *
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald@wireshark.org>
+ * Copyright 2000 Gerald Combs
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ *
+ */
+
+#ifndef __HELP_DLG_H__
+#define __HELP_DLG_H__
+
+/** @file
+ * "Help" dialog box.
+ * @ingroup dialog_group
+ */
+
+typedef enum {
+ /* pages online at www.wireshark.org */
+ ONLINEPAGE_HOME,
+ ONLINEPAGE_WIKI,
+ ONLINEPAGE_USERGUIDE,
+ ONLINEPAGE_FAQ,
+ ONLINEPAGE_DOWNLOAD,
+ ONLINEPAGE_SAMPLE_FILES,
+ ONLINEPAGE_CAPTURE_SETUP,
+ ONLINEPAGE_NETWORK_MEDIA,
+ ONLINEPAGE_SAMPLE_CAPTURES,
+ ONLINEPAGE_SECURITY,
+ ONLINEPAGE_CHIMNEY,
+
+ /* local manual pages */
+ LOCALPAGE_MAN_WIRESHARK = 100,
+ LOCALPAGE_MAN_WIRESHARK_FILTER,
+ LOCALPAGE_MAN_TSHARK,
+ LOCALPAGE_MAN_RAWSHARK,
+ 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_CONFIG_PROFILES_DIALOG,
+ HELP_MANUAL_ADDR_RESOLVE_DIALOG,
+ HELP_PRINT_DIALOG,
+ HELP_FIND_DIALOG,
+ HELP_FILESET_DIALOG,
+ HELP_FIREWALL_DIALOG,
+ HELP_GOTO_DIALOG,
+ HELP_CAPTURE_INTERFACES_DIALOG,
+ HELP_ENABLED_PROTOCOLS_DIALOG,
+ HELP_DECODE_AS_DIALOG,
+ HELP_DECODE_AS_SHOW_DIALOG,
+ HELP_FOLLOW_STREAM_DIALOG,
+ HELP_EXPERT_INFO_DIALOG,
+ HELP_STATS_SUMMARY_DIALOG,
+ HELP_STATS_PROTO_HIERARCHY_DIALOG,
+ HELP_STATS_ENDPOINTS_DIALOG,
+ HELP_STATS_CONVERSATIONS_DIALOG,
+ HELP_STATS_IO_GRAPH_DIALOG,
+ HELP_STATS_COMPARE_FILES_DIALOG,
+ HELP_STATS_LTE_MAC_TRAFFIC_DIALOG,
+ HELP_STATS_LTE_RLC_TRAFFIC_DIALOG,
+ HELP_STATS_WLAN_TRAFFIC_DIALOG,
+ HELP_CAPTURE_INTERFACE_OPTIONS_DIALOG,
+ HELP_CAPTURE_INTERFACES_DETAILS_DIALOG,
+ HELP_PREFERENCES_DIALOG,
+ HELP_CAPTURE_INFO_DIALOG,
+ HELP_EXPORT_FILE_DIALOG,
+ HELP_EXPORT_BYTES_DIALOG,
+ HELP_EXPORT_OBJECT_LIST,
+ HELP_OPEN_DIALOG,
+ HELP_MERGE_DIALOG,
+ HELP_IMPORT_DIALOG,
+ HELP_SAVE_DIALOG,
+ HELP_EXPORT_FILE_WIN32_DIALOG,
+ HELP_EXPORT_BYTES_WIN32_DIALOG,
+ HELP_OPEN_WIN32_DIALOG,
+ HELP_MERGE_WIN32_DIALOG,
+ HELP_SAVE_WIN32_DIALOG,
+ HELP_TIME_SHIFT_DIALOG,
+ HELP_FILTER_SAVE_DIALOG
+} topic_action_e;
+
+
+/** Open a specific topic (create a "Help" dialog box or open a webpage).
+ *
+ * @param widget parent widget (unused)
+ * @param topic the topic to display
+ */
+void topic_cb(GtkWidget *widget, topic_action_e topic);
+
+/** Open a specific topic called from a menu item.
+ *
+ * @param widget parent widget (unused)
+ * @param event A GdkEventButton *event
+ * @param user_data the topic to display
+ * @return TRUE
+ */
+gboolean topic_menu_cb(GtkWidget *widget _U_, GdkEventButton *event _U_, gpointer user_data);
+
+/** Redraw all the help dialog text widgets, to use a new font. */
+void help_redraw(void);
+
+
+/** Open the help dialog and show a specific HTML help page. */
+void help_topic_html(const gchar *topic);
+
+/** get the url string of one of the ONLINEPAGE_xxx values */
+const char *topic_online_url(topic_action_e action);
+
+
+#endif