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