gtk/help_dlg.h

   1 /* help_dlg.h
   2  *
   3  * $Id$
   4  *
   5  * Laurent Deniel <laurent.deniel@free.fr>
   6  *
   7  * Ethereal - Network traffic analyzer
   8  * By Gerald Combs <gerald@zing.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 /** User requested the "Help" dialog box by menu or toolbar.
  36  *
  37  * @param widget parent widget (unused)
  38  * @param data unused
  39  */
  40 void help_cb(GtkWidget *widget, gpointer data);
  41
  42 /** Create a "Help" dialog box and start with a specific topic.
  43  *  Will show the first page if topic is not found.
  44  *
  45  * @param widget parent widget (unused)
  46  * @param topic the topic to display (a string)
  47  */
  48 void help_topic_cb(GtkWidget *widget, gpointer topic);
  49
  50 /** Redraw all the text widgets, to use a new font. */
  51 void help_redraw(void);
  52
  53 typedef enum {
  54     /* pages online at www.ethereal.com */
  55     ONLINEPAGE_HOME,
  56     ONLINEPAGE_USERGUIDE,
  57     ONLINEPAGE_FAQ,
  58     ONLINEPAGE_DOWNLOAD,
  59     ONLINEPAGE_SAMPLE_FILES,
  60
  61     /* local manual pages */
  62     LOCALPAGE_MAN_ETHEREAL = 100,
  63     LOCALPAGE_MAN_ETHEREAL_FILTER,
  64     LOCALPAGE_MAN_TETHEREAL,
  65     LOCALPAGE_MAN_MERGECAP,
  66     LOCALPAGE_MAN_EDITCAP,
  67     LOCALPAGE_MAN_TEXT2PCAP,
  68
  69     /* local help pages (User's Guide) */
  70 #ifdef ETHEREAL_EUG_DIR
  71     HELP_CONTENT = 200,
  72     HELP_CAPTURE_OPTIONS_DIALOG,
  73     HELP_CAPTURE_FILTERS_DIALOG,
  74     HELP_DISPLAY_FILTERS_DIALOG
  75 #endif
  76 } url_page_action_e;
  77
  78
  79 /** User requested one of the html pages.
  80  *
  81  * @param action the page to show
  82  */
  83 extern void
  84 url_page_action(url_page_action_e action);
  85
  86 /** User requested one of the html pages by button click.
  87  *
  88  * @param widget parent widget (unused)
  89  * @param action the page to show
  90  */
  91 extern void
  92 url_page_cb(GtkWidget *w _U_, url_page_action_e action);
  93
  94 /** User requested one of the html pages by menu.
  95  *
  96  * @param widget parent widget (unused)
  97  * @param data unused
  98  * @param action the page to show
  99  */
 100 extern void url_page_menu_cb( GtkWidget *widget, gpointer data, url_page_action_e action);
 101
 102 #endif