gtk/stat_menu.h

   1 /* stat_menu.h
   2  * Menu definitions for use by stats
   3  *
   4  * $Id$
   5  *
   6  * Ethereal - Network traffic analyzer
   7  * By Gerald Combs <gerald@ethereal.com>
   8  * Copyright 1998 Gerald Combs
   9  *
  10  * This program is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU General Public License
  12  * as published by the Free Software Foundation; either version 2
  13  * of the License, or (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  23  */
  24
  25 #ifndef __GTKGUISTATMENU_H__
  26 #define __GTKGUISTATMENU_H__
  27
  28 #ifdef __cplusplus
  29 extern "C" {
  30 #endif /* __cplusplus */
  31
  32 /** @file
  33  * Add a new menu item for a stat.
  34  */
  35
  36 /** The menu group this stat should be registered in. */
  37 typedef enum {
  38     REGISTER_STAT_GROUP_NONE,
  39     REGISTER_STAT_GROUP_GENERIC,
  40     REGISTER_STAT_GROUP_CONVERSATION_LIST,
  41     REGISTER_STAT_GROUP_ENDPOINT_LIST,
  42     REGISTER_STAT_GROUP_RESPONSE_TIME,
  43     REGISTER_STAT_GROUP_TELEPHONY
  44     /* XXX - split into telephony and VoIP? */
  45 } REGISTER_STAT_GROUP_E;
  46
  47 /**
  48  * Add a new menu item for a stat.
  49  * This must be called after we've created the main menu, so it can't
  50  * be called from the routine that registers stats - we have to introduce
  51  * another per-stat registration routine.
  52  *
  53  * @param name the menu label
  54  *
  55  * @param group the menu group this stat should be registered to
  56  *
  57  * @param callback gets called when the menu item is selected; it should do
  58  * the work of creating the stat window.
  59  *
  60  * @param selected_packet_enabled gets called by set_menus_for_selected_packet();
  61  * it's passed a pointer to the "frame_data" structure for the current frame,
  62  * if any, and to the "epan_dissect_t" structure for that frame, if any, and
  63  * should return TRUE if the stat will work now (which might depend on whether
  64  * a frame is selected and, if one is, on the frame) and FALSE if not.
  65  *
  66  * @param selected_tree_row_enabled gets called by
  67  * set_menus_for_selected_tree_row(); it's passed a pointer to the
  68  * "field_info" structure for the currently selected field, if any,
  69  * and should return TRUE if the stat will work now (which might depend on
  70  * whether a tree row is selected and, if one is, on the tree row) and
  71  * FALSE if not.
  72  *
  73  * @param callback_data data for callback function
  74  */
  75 extern void register_stat_menu_item(
  76     const char *name,
  77     REGISTER_STAT_GROUP_E group,
  78     GtkItemFactoryCallback callback,
  79     gboolean (*selected_packet_enabled)(frame_data *, epan_dissect_t *),
  80     gboolean (*selected_tree_row_enabled)(field_info *),
  81     gpointer callback_data);
  82
  83 #ifdef __cplusplus
  84 }
  85 #endif /* __cplusplus */
  86
  87 #endif /* __GTKGUISTATMENU_H__ */