gtk/help_dlg.h

   1 /* help_dlg.h
   2  *
   3  * $Id$
   4  *
   5  * Laurent Deniel <laurent.deniel@free.fr>
   6  *
   7  * Wireshark - Network traffic analyzer
   8  * By Gerald Combs <gerald@wireshark.org>
   9  * Copyright 2000 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
  27 #ifndef __HELP_DLG_H__
  28 #define __HELP_DLG_H__
  29
  30 /** @file
  31  * "Help" dialog box.
  32  *  @ingroup dialog_group
  33  */
  34
  35 typedef enum {
  36     /* pages online at www.wireshark.org */
  37     ONLINEPAGE_HOME,
  38     ONLINEPAGE_WIKI,
  39     ONLINEPAGE_USERGUIDE,
  40     ONLINEPAGE_FAQ,
  41     ONLINEPAGE_DOWNLOAD,
  42     ONLINEPAGE_SAMPLE_FILES,
  43     ONLINEPAGE_CAPTURE_SETUP,
  44     ONLINEPAGE_NETWORK_MEDIA,
  45     ONLINEPAGE_SAMPLE_CAPTURES,
  46     ONLINEPAGE_SECURITY,
  47     ONLINEPAGE_CHIMNEY,
  48
  49     /* local manual pages */
  50     LOCALPAGE_MAN_WIRESHARK = 100,
  51     LOCALPAGE_MAN_WIRESHARK_FILTER,
  52     LOCALPAGE_MAN_TSHARK,
  53     LOCALPAGE_MAN_RAWSHARK,
  54     LOCALPAGE_MAN_DUMPCAP,
  55     LOCALPAGE_MAN_MERGECAP,
  56     LOCALPAGE_MAN_EDITCAP,
  57     LOCALPAGE_MAN_TEXT2PCAP,
  58
  59     /* help pages (textfiles or local HTML User's Guide) */
  60     HELP_CONTENT = 200,
  61     HELP_GETTING_STARTED,           /* currently unused */
  62     HELP_CAPTURE_OPTIONS_DIALOG,
  63     HELP_CAPTURE_FILTERS_DIALOG,
  64     HELP_DISPLAY_FILTERS_DIALOG,
  65     HELP_COLORING_RULES_DIALOG,
  66     HELP_CONFIG_PROFILES_DIALOG,
  67     HELP_MANUAL_ADDR_RESOLVE_DIALOG,
  68     HELP_PRINT_DIALOG,
  69     HELP_FIND_DIALOG,
  70     HELP_FILESET_DIALOG,
  71     HELP_FIREWALL_DIALOG,
  72     HELP_GOTO_DIALOG,
  73     HELP_CAPTURE_INTERFACES_DIALOG,
  74     HELP_ENABLED_PROTOCOLS_DIALOG,
  75     HELP_DECODE_AS_DIALOG,
  76     HELP_DECODE_AS_SHOW_DIALOG,
  77     HELP_FOLLOW_STREAM_DIALOG,
  78     HELP_EXPERT_INFO_DIALOG,
  79     HELP_STATS_SUMMARY_DIALOG,
  80     HELP_STATS_PROTO_HIERARCHY_DIALOG,
  81     HELP_STATS_ENDPOINTS_DIALOG,
  82     HELP_STATS_CONVERSATIONS_DIALOG,
  83     HELP_STATS_IO_GRAPH_DIALOG,
  84     HELP_STATS_COMPARE_FILES_DIALOG,
  85     HELP_STATS_LTE_MAC_TRAFFIC_DIALOG,
  86     HELP_STATS_LTE_RLC_TRAFFIC_DIALOG,
  87     HELP_STATS_WLAN_TRAFFIC_DIALOG,
  88     HELP_CAPTURE_INTERFACE_OPTIONS_DIALOG,
  89     HELP_CAPTURE_INTERFACES_DETAILS_DIALOG,
  90     HELP_PREFERENCES_DIALOG,
  91     HELP_CAPTURE_INFO_DIALOG,
  92     HELP_EXPORT_FILE_DIALOG,
  93     HELP_EXPORT_BYTES_DIALOG,
  94     HELP_EXPORT_OBJECT_LIST,
  95     HELP_OPEN_DIALOG,
  96     HELP_MERGE_DIALOG,
  97     HELP_SAVE_DIALOG,
  98     HELP_EXPORT_FILE_WIN32_DIALOG,
  99     HELP_EXPORT_BYTES_WIN32_DIALOG,
 100     HELP_OPEN_WIN32_DIALOG,
 101     HELP_MERGE_WIN32_DIALOG,
 102     HELP_SAVE_WIN32_DIALOG
 103 } topic_action_e;
 104
 105
 106 /** Open a specific topic (create a "Help" dialog box or open a webpage).
 107  *
 108  * @param widget parent widget (unused)
 109  * @param topic the topic to display
 110  */
 111 void topic_cb(GtkWidget *widget, topic_action_e topic);
 112
 113 /** Open a specific topic called from a menu item.
 114  *
 115  * @param widget parent widget (unused)
 116  * @param event A GdkEventButton *event
 117  * @param user_data the topic to display
 118  * @return TRUE
 119  */
 120 gboolean topic_menu_cb(GtkWidget *widget _U_, GdkEventButton *event _U_, gpointer user_data);
 121
 122 /** Redraw all the help dialog text widgets, to use a new font. */
 123 void help_redraw(void);
 124
 125
 126 /** Open the help dialog and show a specific HTML help page. */
 127 void help_topic_html(const gchar *topic);
 128
 129 /** get the url string of one of the ONLINEPAGE_xxx values */
 130 const char *topic_online_url(topic_action_e action);
 131
 132
 133 #endif