Add 2012 to FSF copyright years for Emacs files
[bpt/emacs.git] / lwlib / lwlib.h
index a6ab8b9..97c61e1 100644 (file)
@@ -1,3 +1,25 @@
+/*
+Copyright (C) 1992, 1993 Lucid, Inc.
+Copyright (C) 1994, 1999-2012  Free Software Foundation, Inc.
+
+This file is part of the Lucid Widget Library.
+
+The Lucid Widget Library is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 1, or (at your option)
+any later version.
+
+The Lucid Widget Library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with GNU Emacs; see the file COPYING.  If not, write to
+the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+Boston, MA 02110-1301, USA.  */
+
+
 #ifndef LWLIB_H
 #define LWLIB_H
 
 
 /*
 ** Widget values depend on the Widget type:
-** 
+**
 ** widget:   (name value key enabled data contents/selected)
 **
 ** label:    ("name" "string" NULL NULL NULL NULL)
 ** button:   ("name" "string" "key" T/F data <default-button-p>)
-** button w/menu: 
+** button w/menu:
 **           ("name" "string" "key" T/F data (label|button|button w/menu...))
 ** menubar:  ("name" NULL NULL T/F data (button w/menu))
 ** selectable thing:
@@ -54,7 +76,7 @@ enum menu_separator
   SEPARATOR_SHADOW_ETCHED_IN_DASH,
   SEPARATOR_SHADOW_ETCHED_OUT_DASH,
 
-  /* The following are supported by XEmacs' Lucid menus.  */
+  /* The following are supported by Lucid menus.  */
   SEPARATOR_SHADOW_DOUBLE_ETCHED_IN,
   SEPARATOR_SHADOW_DOUBLE_ETCHED_OUT,
   SEPARATOR_SHADOW_DOUBLE_ETCHED_IN_DASH,
@@ -64,13 +86,17 @@ enum menu_separator
 typedef struct _widget_value
 {
   /* name of widget */
+  Lisp_Object   lname;
   char*                name;
   /* value (meaning depend on widget type) */
   char*                value;
-  /* keyboard equivalent. no implications for XtTranslations */ 
+  /* keyboard equivalent. no implications for XtTranslations */
+  Lisp_Object   lkey;
   char*                key;
-  /* Help string or null if none.  */
-  char         *help;
+  /* Help string or nil if none.
+     GC finds this string through the frame's menu_bar_vector
+     or through menu_items.  */
+  Lisp_Object  help;
   /* true if enabled */
   Boolean      enabled;
   /* true if selected */
@@ -103,61 +129,64 @@ typedef struct _widget_value
 } widget_value;
 
 
-typedef void (*lw_callback) (/* Widget w, LWLIB_ID id, void* data */);
-
-void  lw_register_widget (/* char* type, char* name, LWLIB_ID id,
-                         widget_value* val, lw_callback pre_activate_cb,
-                         lw_callback selection_cb,
-                         lw_callback post_activate_cb */);
-Widget lw_get_widget (/* LWLIB_ID id, Widget parent, Boolean pop_up_p */);
-Widget lw_make_widget (/* LWLIB_ID id, Widget parent, Boolean pop_up_p */);
-Widget lw_create_widget (/* char* type, char* name, LWLIB_ID id,
-                        widget_value* val, Widget parent, Boolean pop_up_p,
-                        lw_callback pre_activate_cb,
-                        lw_callback selection_cb,
-                        lw_callback post_activate_cb */);
-LWLIB_ID lw_get_widget_id (/* Widget w */);
-void lw_modify_all_widgets (/* LWLIB_ID id, widget_value* val, Boolean deep_p */);
-void lw_destroy_widget (/* Widget w */);
-void lw_destroy_all_widgets (/* LWLIB_ID id */);
-void lw_destroy_everything (/* void */);
-void lw_destroy_all_pop_ups (/* void */);
-Widget lw_raise_all_pop_up_widgets (/* void */);
-widget_value* lw_get_all_values (/* LWLIB_ID id */);
-Boolean lw_get_some_values (/* LWLIB_ID id, widget_value* val */);
-void lw_pop_up_all_widgets (/* LWLIB_ID id */);
-void lw_pop_down_all_widgets (/* LWLIB_ID id */);
-widget_value *malloc_widget_value ();
-void free_widget_value (/* widget_value * */);
-void lw_popup_menu (/* Widget */);
+typedef void (*lw_callback) (Widget w, LWLIB_ID id, void* data);
+
+void  lw_register_widget (const char* type, const char* name, LWLIB_ID id,
+                          widget_value* val, lw_callback pre_activate_cb,
+                          lw_callback selection_cb,
+                          lw_callback post_activate_cb,
+                          lw_callback highlight_cb);
+Widget lw_get_widget (LWLIB_ID id, Widget parent, Boolean pop_up_p);
+Widget lw_make_widget (LWLIB_ID id, Widget parent, Boolean pop_up_p);
+Widget lw_create_widget (const char* type, const char* name, LWLIB_ID id,
+                         widget_value* val, Widget parent, Boolean pop_up_p,
+                         lw_callback pre_activate_cb,
+                         lw_callback selection_cb,
+                         lw_callback post_activate_cb,
+                         lw_callback highlight_cb);
+LWLIB_ID lw_get_widget_id (Widget w);
+int lw_modify_all_widgets (LWLIB_ID id, widget_value* val, Boolean deep_p);
+void lw_destroy_widget (Widget w);
+void lw_destroy_all_widgets (LWLIB_ID id);
+void lw_destroy_everything (void);
+void lw_destroy_all_pop_ups (void);
+Widget lw_raise_all_pop_up_widgets (void);
+widget_value* lw_get_all_values (LWLIB_ID id);
+Boolean lw_get_some_values (LWLIB_ID id, widget_value* val);
+void lw_pop_up_all_widgets (LWLIB_ID id);
+void lw_pop_down_all_widgets (LWLIB_ID id);
+widget_value *malloc_widget_value (void);
+void free_widget_value (widget_value *);
+void lw_popup_menu (Widget, XEvent *);
 
 /* Toolkit independent way of focusing on a Widget at the Xt level. */
-void lw_set_keyboard_focus (/* Widget parent, Widget w */);
+void lw_set_keyboard_focus (Widget parent, Widget w);
 
 /* Silly Energize hack to invert the "sheet" button */
-void lw_show_busy (/* Widget w, Boolean busy */);
+void lw_show_busy (Widget w, Boolean busy);
 
 /* Silly hack to assist with Lucid/Athena geometry management. */
-void lw_refigure_widget (/* Widget w, Boolean doit */);
+void lw_refigure_widget (Widget w, Boolean doit);
 
 /* Toolkit independent way of determining if an event occurred on a
    menubar. */
-Boolean lw_window_is_in_menubar (/* Window win, Widget menubar_widget */);
+Boolean lw_window_is_in_menubar (Window win, Widget menubar_widget);
 
 /* Manage resizing: TRUE permits resizing widget w; FALSE disallows it. */
-void lw_allow_resizing (/* Widget w, Boolean flag */);
+void lw_allow_resizing (Widget w, Boolean flag);
 
 /* Set up the main window. */
-void lw_set_main_areas (/* Widget parent,
-                          Widget menubar,
-                          Widget work_area */);
+void lw_set_main_areas (Widget parent,
+                        Widget menubar,
+                        Widget work_area);
 
 /* Value is non-zero if LABEL is a menu separator.  If it is, *TYPE is
    set to an appropriate enumerator of type enum menu_separator.
    MOTIF_P non-zero means map separator types not supported by Motif
    to similar ones that are supported.  */
 
-int lw_separator_p (/* char *label, enum menu_separator *type,
-                   int motif_p */);
+int lw_separator_p (const char *label, enum menu_separator *type,
+                    int motif_p);
 
 #endif /* LWLIB_H */
+