Wireshark  2.9.0-477-g68ec514b
The Wireshark network protocol analyzer
help_url.h
Go to the documentation of this file.
1 /* help_dlg.h
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 #ifdef __cplusplus
16 extern "C" {
17 #endif /* __cplusplus */
18 
23 typedef enum {
24  TOPIC_ACTION_NONE,
25 
26  /* pages online at www.wireshark.org */
27  ONLINEPAGE_HOME,
28  ONLINEPAGE_WIKI,
29  ONLINEPAGE_USERGUIDE,
30  ONLINEPAGE_FAQ,
31  ONLINEPAGE_DOWNLOAD,
32  ONLINEPAGE_DOCS,
33  ONLINEPAGE_SAMPLE_FILES,
34  ONLINEPAGE_CAPTURE_SETUP,
35  ONLINEPAGE_NETWORK_MEDIA,
36  ONLINEPAGE_SAMPLE_CAPTURES,
37  ONLINEPAGE_SECURITY,
38  ONLINEPAGE_CHIMNEY,
39  ONLINEPAGE_ASK,
40 
41  /* local manual pages */
42  LOCALPAGE_MAN_WIRESHARK = 100,
43  LOCALPAGE_MAN_WIRESHARK_FILTER,
44  LOCALPAGE_MAN_CAPINFOS,
45  LOCALPAGE_MAN_DUMPCAP,
46  LOCALPAGE_MAN_EDITCAP,
47  LOCALPAGE_MAN_MERGECAP,
48  LOCALPAGE_MAN_RAWSHARK,
49  LOCALPAGE_MAN_REORDERCAP,
50  LOCALPAGE_MAN_TEXT2PCAP,
51  LOCALPAGE_MAN_TSHARK,
52 
53  /* help pages (textfiles or local HTML User's Guide) */
54  HELP_CONTENT = 200,
55  HELP_GETTING_STARTED, /* currently unused */
56  HELP_CAPTURE_OPTIONS_DIALOG,
57  HELP_CAPTURE_FILTERS_DIALOG,
58  HELP_DISPLAY_FILTERS_DIALOG,
59  HELP_FILTER_EXPRESSION_DIALOG,
60  HELP_COLORING_RULES_DIALOG,
61  HELP_CONFIG_PROFILES_DIALOG,
62  HELP_MANUAL_ADDR_RESOLVE_DIALOG, /* GTK+ only? */
63  HELP_PRINT_DIALOG,
64  HELP_FIND_DIALOG,
65  HELP_FILESET_DIALOG,
66  HELP_FIREWALL_DIALOG,
67  HELP_GOTO_DIALOG,
68  HELP_CAPTURE_INTERFACES_DIALOG,
69  HELP_CAPTURE_MANAGE_INTERFACES_DIALOG,
70  HELP_ENABLED_PROTOCOLS_DIALOG,
71  HELP_ENABLED_HEURISTICS_DIALOG,
72  HELP_DECODE_AS_DIALOG,
73  HELP_DECODE_AS_SHOW_DIALOG,
74  HELP_FOLLOW_STREAM_DIALOG,
75  HELP_SHOW_PACKET_BYTES_DIALOG,
76  HELP_EXPERT_INFO_DIALOG,
77  HELP_EXTCAP_OPTIONS_DIALOG,
78  HELP_STATS_SUMMARY_DIALOG,
79  HELP_STATS_PROTO_HIERARCHY_DIALOG,
80  HELP_STATS_ENDPOINTS_DIALOG,
81  HELP_STATS_CONVERSATIONS_DIALOG,
82  HELP_STATS_IO_GRAPH_DIALOG,
83  HELP_STATS_COMPARE_FILES_DIALOG,
84  HELP_STATS_LTE_MAC_TRAFFIC_DIALOG,
85  HELP_STATS_LTE_RLC_TRAFFIC_DIALOG,
86  HELP_STATS_TCP_STREAM_GRAPHS_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_IMPORT_DIALOG,
98  HELP_SAVE_DIALOG,
99  HELP_EXPORT_FILE_WIN32_DIALOG,
100  HELP_EXPORT_BYTES_WIN32_DIALOG,
101  HELP_OPEN_WIN32_DIALOG,
102  HELP_MERGE_WIN32_DIALOG,
103  HELP_SAVE_WIN32_DIALOG,
104  HELP_TIME_SHIFT_DIALOG,
105  HELP_FILTER_SAVE_DIALOG,
106  HELP_TELEPHONY_VOIP_CALLS_DIALOG,
107  HELP_RTP_ANALYSIS_DIALOG,
108  HELP_NEW_PACKET_DIALOG,
109  HELP_IAX2_ANALYSIS_DIALOG,
110  HELP_TELEPHONY_RTP_PLAYER_DIALOG
111 } topic_action_e;
112 
118 const char *topic_online_url(topic_action_e action);
119 
128 gchar *user_guide_url(const gchar *page);
129 
138 gchar *topic_action_url(topic_action_e action);
139 
144 void topic_action(topic_action_e topic);
145 
146 #ifdef __cplusplus
147 }
148 #endif /* __cplusplus */
149 
150 #endif /* __HELP_URL_H__ */
151 
152 /*
153  * Editor modelines
154  *
155  * Local Variables:
156  * c-basic-offset: 4
157  * tab-width: 8
158  * indent-tabs-mode: nil
159  * End:
160  *
161  * ex: set shiftwidth=4 tabstop=8 expandtab:
162  * :indentSize=4:tabSize=8:noTabs=true:
163  */
gchar * topic_action_url(topic_action_e action)
Definition: help_url.c:120
const char * topic_online_url(topic_action_e action)
Definition: help_url.c:28
void topic_action(topic_action_e topic)
Definition: wireshark_application.cpp:134
gchar * user_guide_url(const gchar *page)
Definition: help_url.c:79