ui/help_url.h

   1 /** @file
   2  *
   3  * Some content from gtk/help_dlg.h by Laurent Deniel <laurent.deniel@free.fr>
   4  *
   5  * Wireshark - Network traffic analyzer
   6  * By Gerald Combs <gerald@wireshark.org>
   7  * Copyright 2000 Gerald Combs
   8  *
   9  * SPDX-License-Identifier: GPL-2.0-or-later*
  10  */
  11
  12 #ifndef __HELP_URL_H__
  13 #define __HELP_URL_H__
  14
  15 #include <ws_attributes.h>
  16
  17 #ifdef __cplusplus
  18 extern "C" {
  19 #endif /* __cplusplus */
  20
  21 /** @file help_url.h
  22  * "Help" URLs.
  23  */
  24
  25 typedef enum {
  26     TOPIC_ACTION_NONE,
  27
  28     /* pages online at www.wireshark.org */
  29     ONLINEPAGE_HOME,
  30     ONLINEPAGE_WIKI,
  31     ONLINEPAGE_USERGUIDE,
  32     ONLINEPAGE_FAQ,
  33     ONLINEPAGE_DOWNLOAD,
  34     ONLINEPAGE_DOCS,
  35     ONLINEPAGE_SAMPLE_FILES,
  36     ONLINEPAGE_CAPTURE_SETUP,
  37     ONLINEPAGE_NETWORK_MEDIA,
  38     ONLINEPAGE_SAMPLE_CAPTURES,
  39     ONLINEPAGE_SECURITY,
  40     ONLINEPAGE_ASK,
  41     ONLINEPAGE_DFILTER_REF,
  42
  43     /* local manual pages */
  44     LOCALPAGE_MAN_WIRESHARK = 100,
  45     LOCALPAGE_MAN_WIRESHARK_FILTER,
  46     LOCALPAGE_MAN_CAPINFOS,
  47     LOCALPAGE_MAN_DUMPCAP,
  48     LOCALPAGE_MAN_EDITCAP,
  49     LOCALPAGE_MAN_MERGECAP,
  50     LOCALPAGE_MAN_RAWSHARK,
  51     LOCALPAGE_MAN_REORDERCAP,
  52     LOCALPAGE_MAN_TEXT2PCAP,
  53     LOCALPAGE_MAN_TSHARK,
  54
  55     /* Release Notes */
  56     LOCALPAGE_RELEASE_NOTES,
  57
  58     /* help pages (textfiles or HTML User's Guide) */
  59     HELP_CONTENT = 200,
  60     HELP_GETTING_STARTED,           /* currently unused */
  61     HELP_CAPTURE_OPTIONS,           /* currently unused */
  62     HELP_CAPTURE_FILTERS_DIALOG,
  63     HELP_DISPLAY_FILTERS_DIALOG,
  64     HELP_FILTER_EXPRESSION_DIALOG,
  65     HELP_DISPLAY_MACRO_DIALOG,
  66     HELP_COLORING_RULES_DIALOG,
  67     HELP_CONFIG_PROFILES_DIALOG,
  68     HELP_PRINT_DIALOG,
  69     HELP_FIND_DIALOG,
  70     HELP_FILESET_DIALOG,
  71     HELP_FIREWALL_DIALOG,
  72     HELP_GOTO_DIALOG,
  73     HELP_CAPTURE_OPTIONS_DIALOG,
  74     HELP_CAPTURE_MANAGE_INTERFACES_DIALOG,
  75     HELP_ENABLED_PROTOCOLS_DIALOG,
  76     HELP_ENABLED_HEURISTICS_DIALOG,
  77     HELP_DECODE_AS_DIALOG,
  78     HELP_DECODE_AS_SHOW_DIALOG,
  79     HELP_FOLLOW_STREAM_DIALOG,
  80     HELP_SHOW_PACKET_BYTES_DIALOG,
  81     HELP_EXPERT_INFO_DIALOG,
  82     HELP_EXTCAP_OPTIONS_DIALOG,
  83     HELP_STATS_SUMMARY_DIALOG,
  84     HELP_STATS_PROTO_HIERARCHY_DIALOG,
  85     HELP_STATS_ENDPOINTS_DIALOG,
  86     HELP_STATS_CONVERSATIONS_DIALOG,
  87     HELP_STATS_IO_GRAPH_DIALOG,
  88     HELP_STATS_LTE_MAC_TRAFFIC_DIALOG,
  89     HELP_STATS_LTE_RLC_TRAFFIC_DIALOG,
  90     HELP_STATS_TCP_STREAM_GRAPHS_DIALOG,
  91     HELP_STATS_WLAN_TRAFFIC_DIALOG,
  92     HELP_CAPTURE_INTERFACE_OPTIONS_DIALOG,
  93     HELP_PREFERENCES_DIALOG,
  94     HELP_CAPTURE_INFO_DIALOG,
  95     HELP_EXPORT_FILE_DIALOG,
  96     HELP_EXPORT_BYTES_DIALOG,
  97     HELP_EXPORT_PDUS_DIALOG,
  98     HELP_STRIP_HEADERS_DIALOG,
  99     HELP_EXPORT_OBJECT_LIST,
 100     HELP_OPEN_DIALOG,
 101     HELP_MERGE_DIALOG,
 102     HELP_IMPORT_DIALOG,
 103     HELP_SAVE_DIALOG,
 104     HELP_EXPORT_FILE_WIN32_DIALOG,
 105     HELP_OPEN_WIN32_DIALOG,
 106     HELP_MERGE_WIN32_DIALOG,
 107     HELP_SAVE_WIN32_DIALOG,
 108     HELP_TIME_SHIFT_DIALOG,
 109     HELP_TELEPHONY_VOIP_CALLS_DIALOG,
 110     HELP_TELEPHONY_RTP_ANALYSIS_DIALOG,
 111     HELP_TELEPHONY_RTP_STREAMS_DIALOG,
 112     HELP_NEW_PACKET_DIALOG,
 113     HELP_IAX2_ANALYSIS_DIALOG,
 114     HELP_TELEPHONY_RTP_PLAYER_DIALOG,
 115     HELP_STAT_FLOW_GRAPH
 116 } topic_action_e;
 117
 118 /** Given a page in the Wireshark User's Guide return its URL. Returns a
 119  *  URL to a local file if present, or to the online guide if the local
 120  *  file is unavailable.
 121  *
 122  * @param page A page in the User's Guide.
 123  * @return A static URL. The return value must be freed with g_free().
 124  */
 125 WS_RETNONNULL char *user_guide_url(const char *page);
 126
 127 /** Given a topic action return its URL. If the attempt fails NULL
 128  *  will be returned.
 129  *
 130  * @param action Topic action.
 131  * @return A static URL. The return value must be freed with g_free().
 132  */
 133 WS_RETNONNULL char *topic_action_url(topic_action_e action);
 134
 135 /** Open a specific topic (create a "Help" dialog box or open a webpage).
 136  *
 137  * @param topic the topic to display
 138  */
 139 void topic_action(topic_action_e topic);
 140
 141 #ifdef __cplusplus
 142 }
 143 #endif /* __cplusplus */
 144
 145 #endif /* __HELP_URL_H__ */