]> code.delx.au - gnu-emacs/blobdiff - src/termhooks.h
(set_frame_menubar): Don't call DrawMenuBar.
[gnu-emacs] / src / termhooks.h
index 443e4c6933130e37a62a558dd9a29db68d83d4ba..8405cac3b8898e2a2460b9e2cf89424fb4eeb5ee 100644 (file)
@@ -1,6 +1,7 @@
 /* Hooks by which low level terminal operations
    can be made to call other routines.
-   Copyright (C) 1985, 1986, 1993, 1994 Free Software Foundation, Inc.
+   Copyright (C) 1985, 1986, 1993, 1994, 2002, 2003, 2004,
+                 2005, 2006 Free Software Foundation, Inc.
 
 This file is part of GNU Emacs.
 
@@ -16,8 +17,8 @@ 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., 59 Temple Place - Suite 330,
-Boston, MA 02111-1307, USA.  */
+the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+Boston, MA 02110-1301, USA.  */
 
 \f
 /* Miscellanea.   */
@@ -162,7 +163,7 @@ extern void (*set_vertical_scroll_bar_hook)
 
 /* Arrange for all scroll bars on FRAME to be removed at the next call
    to `*judge_scroll_bars_hook'.  A scroll bar may be spared if
-   `*redeem_scroll_bar_hook' is applied to its window before the judgement. 
+   `*redeem_scroll_bar_hook' is applied to its window before the judgement.
 
    This should be applied to each frame each time its window tree is
    redisplayed, even if it is not displaying scroll bars at the moment;
@@ -179,7 +180,7 @@ extern void (*condemn_scroll_bars_hook) P_ ((struct frame *frame));
 extern void (*redeem_scroll_bar_hook) P_ ((struct window *window));
 
 /* Remove all scroll bars on FRAME that haven't been saved since the
-   last call to `*condemn_scroll_bars_hook'.  
+   last call to `*condemn_scroll_bars_hook'.
 
    This should be applied to each frame after each time its window
    tree is redisplayed, even if it is not displaying scroll bars at the
@@ -240,28 +241,23 @@ enum event_kind
                                   the mouse click occurred in.
                                   .timestamp gives a timestamp (in
                                   milliseconds) for the click.  */
-#if defined(WINDOWSNT) || defined(MAC_OSX)
-  MOUSE_WHEEL_EVENT,           /* A mouse-wheel event is generated 
-                                  on WINDOWSNT or MAC_OSX by a 
-                                  wheel on a mouse (e.g., MS Intellimouse).
-                                  The event contains a delta that corresponds
-                                  to the amount and direction that the wheel
-                                  is rotated.  This delta is typically
-                                  used to implement a scroll or zoom.
-                                  .code gives the delta.
-                                  .modifiers holds the state of the
-                                  modifier keys.
+  WHEEL_EVENT,                 /* A wheel event is generated by a
+                                  wheel on a mouse (e.g., MS
+                                  Intellimouse).
+                                  .modifiers holds the rotate
+                                  direction (up or down), and the
+                                  state of the modifier keys.
                                   .x and .y give the mouse position,
                                   in characters, within the window.
                                   .frame_or_window gives the frame
                                   the wheel event occurred in.
                                   .timestamp gives a timestamp (in
-                                  milliseconds) for the wheel event.  */
-#endif
-#ifdef WINDOWSNT
-  LANGUAGE_CHANGE_EVENT,       /* A LANGUAGE_CHANGE_EVENT is generated
-                                  on WINDOWSNT when the keyboard layout
-                                  or input language is changed by the
+                                  milliseconds) for the event.  */
+#if defined (WINDOWSNT) || defined (MAC_OS)
+  LANGUAGE_CHANGE_EVENT,       /* A LANGUAGE_CHANGE_EVENT is
+                                  generated on WINDOWSNT or Mac OS
+                                  when the keyboard layout or input
+                                  language is changed by the
                                   user.  */
 #endif
   SCROLL_BAR_CLICK_EVENT,      /* .code gives the number of the mouse button
@@ -282,7 +278,7 @@ enum event_kind
                                   by MS-Windows scroll bar controls. */
 #endif
   SELECTION_REQUEST_EVENT,     /* Another X client wants a selection from us.
-                                  See `struct selection_event'.  */
+                                  See `struct selection_input_event'.  */
   SELECTION_CLEAR_EVENT,       /* Another X client cleared our selection.  */
   BUFFER_SWITCH_EVENT,         /* A process filter has switched buffers.  */
   DELETE_WINDOW_EVENT,         /* An X client said "delete this window".  */
@@ -297,14 +293,14 @@ enum event_kind
   DRAG_N_DROP_EVENT,           /* A drag-n-drop event is generated when
                                   files selected outside of Emacs are dropped
                                   onto an Emacs window.
-                                  Currently used only on Windows NT.
-                                  .modifiers holds the state of the 
+                                  .modifiers holds the state of the
                                   modifier keys.
                                   .x and .y give the mouse position,
                                   in characters, within the window.
-                                  .frame_or_window is a cons of the frame
-                                  in which the drop was made and a list of
-                                  the filenames of the dropped files.
+                                  .frame_or_window is the frame in
+                                  which the drop was made.
+                                  .arg is a platform-dependent
+                                  representation of the dropped items.
                                   .timestamp gives a timestamp (in
                                   milliseconds) for the click.  */
   USER_SIGNAL_EVENT,           /* A user signal.
@@ -330,12 +326,22 @@ enum event_kind
 
   /* Queued from XTread_socket when session manager sends
      save yourself before shutdown. */
-  SAVE_SESSION_EVENT
+  SAVE_SESSION_EVENT,
+
+#ifdef MAC_OS
+  /* Generated when an Apple event, a HICommand event, or a Services
+     menu event is received and the corresponding handler is
+     registered.  Members `x' and `y' are for the event class and ID
+     symbols, respectively.  Member `code' points to the Apple event
+     descriptor.  Parameters for Non-Apple events are converted to
+     those in Apple events.  */
+  MAC_APPLE_EVENT
+#endif
 };
 
 /* If a struct input_event has a kind which is SELECTION_REQUEST_EVENT
    or SELECTION_CLEAR_EVENT, then its contents are really described
-   by `struct selection_event'; see xterm.h.  */
+   by `struct selection_input_event'; see xterm.h.  */
 
 /* The keyboard input buffer is an array of these structures.  Each one
    represents some sort of input event - a keystroke, a mouse click, or
@@ -346,7 +352,7 @@ struct input_event
 {
   /* What kind of event was this?  */
   enum event_kind kind;
-  
+
   /* For an ASCII_KEYSTROKE_EVENT and MULTIBYTE_CHAR_KEYSTROKE_EVENT,
      this is the character.
      For a NON_ASCII_KEYSTROKE_EVENT, this is the keysym code.
@@ -361,7 +367,7 @@ struct input_event
   unsigned long timestamp;
 
   /* This is padding just to put the frame_or_window field
-     past the size of struct selection_event.  */
+     past the size of struct selection_input_event.  */
   int *padding[2];
 
   /* This field is copied into a vector while the event is in the queue,
@@ -377,8 +383,10 @@ struct input_event
   Lisp_Object arg;
 };
 
+#define EVENT_INIT(event) bzero (&(event), sizeof (struct input_event))
+
 /* Called to read input events.  */
-extern int (*read_socket_hook) P_ ((int, struct input_event *, int, int));
+extern int (*read_socket_hook) P_ ((int, int, struct input_event *));
 
 /* Called when a frame's display becomes entirely up to date.  */
 extern void (*frame_up_to_date_hook) P_ ((struct frame *));
@@ -386,7 +394,7 @@ extern void (*frame_up_to_date_hook) P_ ((struct frame *));
 
 /* Bits in the modifiers member of the input_event structure.
    Note that reorder_modifiers assumes that the bits are in canonical
-   order.  
+   order.
 
    The modifiers applied to mouse clicks are rather ornate.  The
    window-system-specific code should store mouse clicks with
@@ -434,3 +442,6 @@ enum {
 };
 
 #endif
+
+/* arch-tag: 33a00ecc-52b5-4186-a410-8801ac9f087d
+   (do not change this comment) */