src/frameslots.h

   1 /* Definitions of marked slots in frames
   2    Copyright (C) 1988, 1992, 1993, 1994 Free Software Foundation, Inc.
   3    Copyright (C) 1996 Ben Wing.
   4
   5 This file is part of XEmacs.
   6
   7 XEmacs is free software; you can redistribute it and/or modify it
   8 under the terms of the GNU General Public License as published by the
   9 Free Software Foundation; either version 2, or (at your option) any
  10 later version.
  11
  12 XEmacs is distributed in the hope that it will be useful, but WITHOUT
  13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with XEmacs; see the file COPYING.  If not, write to
  19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20 Boston, MA 02111-1307, USA.  */
  21
  22 /* Synched up with: FSF 19.30.  Split out of frame.h.  */
  23
  24 #ifdef FRAME_SLOT_DECLARATION
  25 #define MARKED_SLOT_ARRAY(slot, size) MARKED_SLOT(slot[size])
  26 #else
  27 #define MARKED_SLOT_ARRAY(slot, size) do {              \
  28     int mslotidx;                                       \
  29     for (mslotidx = 0; mslotidx < size; mslotidx++)     \
  30       {                                                 \
  31         MARKED_SLOT (slot[mslotidx]);                   \
  32       }                                                 \
  33   } while (0);
  34 #endif
  35
  36   /* device frame belongs to. */
  37   MARKED_SLOT (device);
  38
  39   /* Name of this frame: a Lisp string.
  40      NOT the same as the frame's title, even though FSF bogusly
  41      confuses the two.  The frame's name is used for resourcing
  42      and lookup purposes and is something you can count on having
  43      a specific value, while the frame's title may vary depending
  44      on the user's choice of `frame-title-format'. */
  45   MARKED_SLOT (name);
  46
  47   /* The frame which should receive keystrokes that occur in this
  48      frame, or nil if they should go to the frame itself.  This is
  49      usually nil, but if the frame is minibufferless, we can use this
  50      to redirect keystrokes to a surrogate minibuffer frame when
  51      needed.
  52
  53      Note that a value of nil is different than having the field point
  54      to the frame itself.  Whenever the Fselect_frame function is used
  55      to shift from one frame to the other, any redirections to the
  56      original frame are shifted to the newly selected frame; if
  57      focus_frame is nil, Fselect_frame will leave it alone.  */
  58   MARKED_SLOT (focus_frame);
  59
  60   /* This frame's root window.  Every frame has one.
  61      If the frame has only a minibuffer window, this is it.
  62      Otherwise, if the frame has a minibuffer window, this is its sibling.  */
  63   MARKED_SLOT (root_window);
  64
  65   /* This frame's selected window.
  66      Each frame has its own window hierarchy
  67      and one of the windows in it is selected within the frame.
  68      The selected window of the selected frame is Emacs's selected window.  */
  69   MARKED_SLOT (selected_window);
  70
  71   /* This frame's minibuffer window.
  72      Most frames have their own minibuffer windows,
  73      but only the selected frame's minibuffer window
  74      can actually appear to exist.  */
  75   MARKED_SLOT (minibuffer_window);
  76
  77   /* The most recently selected nonminibuf window.
  78      This is used by things like the toolbar code, which doesn't
  79      want the toolbar to change when moving to the minibuffer.
  80      This will only be a minibuf window if we are a minibuf-only
  81      frame. */
  82   MARKED_SLOT (last_nonminibuf_window);
  83
  84   /* frame property list */
  85   MARKED_SLOT (plist);
  86
  87   /* buffer_alist at last redisplay. */
  88   MARKED_SLOT (old_buffer_alist);
  89
  90   /* A copy of the global Vbuffer_list, to maintain a per-frame buffer
  91      ordering.  The Vbuffer_list variable and the buffer_list slot of each
  92      frame contain exactly the same data, just in different orders.  */
  93   MARKED_SLOT (buffer_alist);
  94
  95   /* Predicate for selecting buffers for other-buffer.  */
  96   MARKED_SLOT (buffer_predicate);
  97
  98   /* The current mouse pointer for the frame.  This is set by calling
  99      `set-frame-pointer'. */
 100   MARKED_SLOT (pointer);
 101
 102   /* The current icon for the frame. */
 103   MARKED_SLOT (icon);
 104
 105 #ifdef HAVE_MENUBARS
 106   /* Vector representing the menubar currently displayed.  See menubar-x.c. */
 107   MARKED_SLOT (menubar_data);
 108 #endif
 109
 110   /* specifier values cached in the struct frame: */
 111
 112 #ifdef HAVE_MENUBARS
 113   MARKED_SLOT (menubar_visible_p);
 114 #endif
 115
 116 #ifdef HAVE_SCROLLBARS
 117   /* Width and height of the scrollbars. */
 118   MARKED_SLOT (scrollbar_width);
 119   MARKED_SLOT (scrollbar_height);
 120   /* Whether the scrollbars are visible */
 121   MARKED_SLOT (horizontal_scrollbar_visible_p);
 122   MARKED_SLOT (vertical_scrollbar_visible_p);
 123   /* Scrollbars location */
 124   MARKED_SLOT (scrollbar_on_left_p);
 125   MARKED_SLOT (scrollbar_on_top_p);
 126 #endif
 127
 128 #ifdef HAVE_TOOLBARS
 129   /* The following three don't really need to be cached except
 130      that we need to know when they've changed. */
 131   MARKED_SLOT (default_toolbar_width);
 132   MARKED_SLOT (default_toolbar_height);
 133   MARKED_SLOT (default_toolbar_visible_p);
 134   MARKED_SLOT (default_toolbar_border_width);
 135
 136   /* List of toolbar buttons of current toolbars */
 137   MARKED_SLOT_ARRAY (toolbar_buttons, 4);
 138   /* Size of the toolbars.  The frame-local toolbar space is
 139      subtracted before the windows are arranged.  Window and buffer
 140      local toolbars overlay their windows. */
 141   MARKED_SLOT_ARRAY (toolbar_size, 4);
 142   /* Visibility of the toolbars.  This acts as a valve for toolbar_size. */
 143   MARKED_SLOT_ARRAY (toolbar_visible_p, 4);
 144   /* Thickness of the border around the toolbar. */
 145   MARKED_SLOT_ARRAY (toolbar_border_width, 4);
 146 #endif
 147
 148 /* Cache of subwindow instances for this frame */
 149   MARKED_SLOT (subwindow_instance_cache);
 150
 151   /* Possible frame-local default for outside margin widths. */
 152   MARKED_SLOT (left_margin_width);
 153   MARKED_SLOT (right_margin_width);
 154
 155 #undef MARKED_SLOT
 156 #undef MARKED_SLOT_ARRAY
 157 #undef FRAME_SLOT_DECLARATION