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
  44     /* local manual pages */
  45     LOCALPAGE_MAN_WIRESHARK = 100,
  46     LOCALPAGE_MAN_WIRESHARK_FILTER,
  47     LOCALPAGE_MAN_TSHARK,
  48     LOCALPAGE_MAN_DUMPCAP,
  49     LOCALPAGE_MAN_MERGECAP,
  50     LOCALPAGE_MAN_EDITCAP,
  51     LOCALPAGE_MAN_TEXT2PCAP,
  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_COLORING_RULES_DIALOG,
  60     HELP_PRINT_DIALOG,
  61     HELP_FIND_DIALOG,
  62     HELP_FILESET_DIALOG,
  63     HELP_GOTO_DIALOG,
  64     HELP_CAPTURE_INTERFACES_DIALOG,
  65     HELP_ENABLED_PROTOCOLS_DIALOG,
  66     HELP_DECODE_AS_DIALOG,
  67     HELP_DECODE_AS_SHOW_DIALOG,
  68     HELP_FOLLOW_TCP_STREAM_DIALOG,  /* currently unused */
  69     HELP_STATS_SUMMARY_DIALOG,
  70     HELP_STATS_PROTO_HIERARCHY_DIALOG,
  71     HELP_STATS_ENDPOINTS_DIALOG,
  72     HELP_STATS_CONVERSATIONS_DIALOG,
  73     HELP_STATS_IO_GRAPH_DIALOG,
  74     HELP_CAPTURE_INTERFACES_DETAILS_DIALOG,
  75     HELP_PREFERENCES_DIALOG
  76 } topic_action_e;
  77
  78
  79 /** Open a specific topic (create a "Help" dialog box or open a webpage).
  80  *
  81  * @param widget parent widget (unused)
  82  * @param topic the topic to display
  83  */
  84 void topic_cb(GtkWidget *widget, topic_action_e topic);
  85
  86 /** Open a specific topic called from a menu item.
  87  *
  88  * @param widget parent widget (unused)
  89  * @param data user_data (unused)
  90  * @param topic the topic to display
  91  */
  92 void topic_menu_cb(GtkWidget *widget _U_, gpointer data _U_, topic_action_e topic);
  93
  94 /** Check, if a specific topic is available.
  95  *
  96  * @param action the topic action to display
  97  * @return TRUE, if topic is available, FALSE if not
  98  */
  99 gboolean topic_available(topic_action_e action);
 100
 101 /** Redraw all the help dialog text widgets, to use a new font. */
 102 void help_redraw(void);
 103
 104 #endif