update.
[chise/xemacs-chise.git.1] / lisp / gutter-items.el
index 054aa59..8ac62f6 100644 (file)
@@ -39,7 +39,8 @@ Do not set this. Use `set-glyph-image' to change the properties of the tab.")
 (defcustom gutter-buffers-tab-visible-p
   (gutter-element-visible-p default-gutter-visible-p 'buffers-tab)
   "Whether the buffers tab is globally visible. 
-This option should be set through the options menu."
+
+There are side-effects, so don't setq it; use Customize or the options menu."
   :group 'buffers-tab
   :type 'boolean
   :set #'(lambda (var val)
@@ -75,7 +76,7 @@ a large number or nil will slow down tab responsiveness."
   :group 'buffers-tab)
 
 (defcustom buffers-tab-omit-function 'buffers-menu-omit-invisible-buffers
-  "*If non-nil, a function specifying the buffers to omit from the buffers tab.
+  "*A function specifying the buffers to omit from the buffers tab, or nil.
 This is passed a buffer and should return non-nil if the buffer should be
 omitted.  The default value `buffers-menu-omit-invisible-buffers' omits
 buffers that are normally considered \"invisible\" (those whose name
@@ -84,27 +85,31 @@ begins with a space)."
                 function)
   :group 'buffers-tab)
 
-(defcustom buffers-tab-selection-function 'select-buffers-tab-buffers-by-mode
-  "*If non-nil, a function specifying the buffers to select from the
-buffers tab.  This is passed two buffers and should return non-nil if
-the second buffer should be selected.  The default value
-`select-buffers-tab-buffers-by-mode' groups buffers by major mode and
-by `buffers-tab-grouping-regexp'."
-
-  :type '(choice (const :tag "None" nil)
-                function)
+(make-obsolete-variable 'buffers-tab-selection-function
+                       'buffers-tab-filter-functions)
+(defcustom buffers-tab-selection-function nil
+  "*A function specifying buffers to display in the buffers tab, or nil.
+Don't use this---it is never consulted.  Use `buffers-tab-filter-functions'
+instead.
+
+The function must take arguments (BUF1 BUF2).  BUF1 is a candidate for
+display in the buffers tab control.  BUF2 is current (first in the buffers
+list).  Return non-nil if BUF1 should be added to the tab control."
+  :type '(choice function (const :tag "None" nil))
   :group 'buffers-tab)
 
-(defcustom buffers-tab-filter-functions (list buffers-tab-selection-function)
-  "*If non-nil, a list of functions specifying the buffers to select 
-from the buffers tab.
-Each function in the list is passed two buffers, the buffer to
-potentially select and the context buffer, and should return non-nil
-if the first buffer should be selected.  The default value groups
-buffers by major mode and by `buffers-tab-grouping-regexp'."
+(defcustom buffers-tab-filter-functions '(select-buffers-tab-buffers-by-mode)
+  "*A list of functions specifying buffers to display in the buffers tab.
 
-  :type '(choice (const :tag "None" nil)
-                sexp)
+If nil, all buffers are kept, up to `buffers-tab-max-size', in usual order.
+Otherwise, each function in the list must take arguments (BUF1 BUF2).
+BUF1 is the candidate, and BUF2 is the current buffer (first in the buffers
+list).  The function should return non-nil if BUF1 should be added to the
+buffers tab.  BUF1 will be omitted if any of the functions returns nil.
+
+Defaults to `select-buffers-tab-buffers-by-mode', which adds BUF1 if BUF1 and
+BUF2 have the same major mode, or both match `buffers-tab-grouping-regexp'."
+  :type '(repeat function)
   :group 'buffers-tab)
 
 (defcustom buffers-tab-sort-function nil
@@ -118,7 +123,7 @@ list in `buffer-list' order (usual most-recently-selected-first)."
   :group 'buffers-tab)
 
 (make-face 'buffers-tab "Face for displaying the buffers tab.")
-(set-face-parent 'buffers-tab 'default)
+(set-face-parent 'buffers-tab 'modeline)
 
 (defcustom buffers-tab-face 'buffers-tab
   "*Face to use for displaying the buffers tab."
@@ -415,8 +420,8 @@ side-by-side."
     (setq progress-glyph-height 16)
     (setq progress-layout-instantiator
          `[layout
-           :orientation horizontal
-           :margin-width 4
+           :orientation vertical :margin-width 4
+           :horizontally-justify left :vertically-justify center
            :items (,progress-gauge-instantiator
                    [button
                     :pixel-height (eval progress-glyph-height)
@@ -429,8 +434,8 @@ side-by-side."
     (setq progress-glyph-height 24)
     (setq progress-layout-instantiator
          `[layout 
-           :orientation vertical :justify left
-           :margin-width 4
+           :orientation vertical :margin-width 4
+           :horizontally-justify left :vertically-justify center
            :items (,progress-text-instantiator
                    [layout 
                     :orientation horizontal
@@ -447,7 +452,8 @@ side-by-side."
 
 (defun set-progress-abort-instantiator (&optional locale)
   (set-glyph-image progress-abort-glyph
-                  `[layout :orientation vertical :justify left
+                  `[layout :orientation vertical
+                           :horizontally-justify left :vertically-justify center
                            :items (,progress-text-instantiator
                                    [layout
                                     :margin-width 4
@@ -664,8 +670,10 @@ If the only argument is nil, clear any existing progress gauge."
 
 (defun progress-feedback-with-label (label fmt &optional value &rest args)
   "Print a progress gauge and message in the bottom gutter area of the frame.
-First argument LABEL is an identifier for this progress gauge.  The rest of the
-arguments are the same as to `format'."
+LABEL is an identifier for this progress gauge.
+FMT is a format string to be passed to `format' along with ARGS.
+Optional VALUE is the current degree of progress, an integer 0-100.
+The remaining ARGS are passed with FMT `(apply #'format FMT ARGS)'."
   ;; #### sometimes the buffer gets changed temporarily. I don't know
   ;; why this is, so protect against it.
   (save-excursion