src/menu.h

   1 /* Functions to manipulate menus.
   2    Copyright (C) 2008-2014 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Emacs.
   5
   6 GNU Emacs is free software: you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation, either version 3 of the License, or
   9 (at your option) any later version.
  10
  11 GNU Emacs is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #ifndef MENU_H
  20 #define MENU_H
  21
  22 #include "systime.h" /* for Time */
  23 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS)
  24 #include "../lwlib/lwlib.h" /* for widget_value */
  25 #endif
  26
  27 #ifdef HAVE_NTGUI
  28 /* This is based on the one in ../lwlib/lwlib.h, with unused portions
  29    removed.  HAVE_NTGUI cannot include lwlib.h, as that pulls in X11
  30    headers.  */
  31
  32 enum button_type
  33 {
  34   BUTTON_TYPE_NONE,
  35   BUTTON_TYPE_TOGGLE,
  36   BUTTON_TYPE_RADIO
  37 };
  38
  39 typedef struct _widget_value
  40 {
  41   /* name of widget */
  42   Lisp_Object   lname;
  43   const char*   name;
  44   /* value (meaning depend on widget type) */
  45   const char*   value;
  46   /* keyboard equivalent. no implications for XtTranslations */
  47   Lisp_Object   lkey;
  48   const char*   key;
  49   /* Help string or nil if none.
  50      GC finds this string through the frame's menu_bar_vector
  51      or through menu_items.  */
  52   Lisp_Object   help;
  53   /* true if enabled */
  54   unsigned char enabled;
  55   /* true if selected */
  56   unsigned char selected;
  57   /* The type of a button.  */
  58   enum button_type button_type;
  59   /* true if menu title */
  60   unsigned char title;
  61   /* Contents of the sub-widgets, also selected slot for checkbox */
  62   struct _widget_value* contents;
  63   /* data passed to callback */
  64   void  *call_data;
  65   /* next one in the list */
  66   struct _widget_value* next;
  67 } widget_value;
  68
  69 extern Lisp_Object Qunsupported__w32_dialog;
  70 #endif
  71
  72 extern void x_set_menu_bar_lines (struct frame *f,
  73                                   Lisp_Object value,
  74                                   Lisp_Object oldval);
  75
  76 extern void init_menu_items (void);
  77 extern void finish_menu_items (void) ATTRIBUTE_CONST;
  78 extern void discard_menu_items (void);
  79 extern void save_menu_items (void);
  80 extern bool parse_single_submenu (Lisp_Object, Lisp_Object, Lisp_Object);
  81 extern void list_of_panes (Lisp_Object);
  82 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NTGUI) \
  83   || defined (HAVE_NS)
  84 extern void free_menubar_widget_value_tree (widget_value *);
  85 extern void update_submenu_strings (widget_value *);
  86 extern void find_and_call_menu_selection (struct frame *, int,
  87                                           Lisp_Object, void *);
  88 extern widget_value *make_widget_value (const char *, char *, bool, Lisp_Object);
  89 extern widget_value *digest_single_submenu (int, int, bool);
  90 #endif
  91
  92 #ifdef HAVE_X_WINDOWS
  93 extern void mouse_position_for_popup (struct frame *f, int *x, int *y);
  94 #endif
  95
  96 extern Lisp_Object w32_menu_show (struct frame *, int, int, int, int,
  97                                   Lisp_Object, const char **);
  98 extern Lisp_Object ns_menu_show (struct frame *, int, int, bool, bool,
  99                                  Lisp_Object, const char **);
 100 extern Lisp_Object xmenu_show (struct frame *, int, int, bool, bool,
 101                                Lisp_Object, const char **);
 102 extern Lisp_Object tty_menu_show (struct frame *, int, int, bool, bool,
 103                                   Lisp_Object, bool, const char **);
 104 extern ptrdiff_t menu_item_width (const unsigned char *);
 105 #endif /* MENU_H */