-;;; tool-bar.el --- Setting up the tool bar
+;;; tool-bar.el --- setting up the tool bar
;;
-;; Copyright (C) 2000 Free Software Foundation, Inc.
+;; Copyright (C) 2000, 2001 Free Software Foundation, Inc.
;;
;; Author: Dave Love <fx@gnu.org>
;; Keywords: mouse frames
;; bindings for the global tool bar with convenience functions
;; `tool-bar-add-item' and `tool-bar-add-item-from-menu'.
+;; The normal global binding for [tool-bar] (below) uses the value of
+;; `tool-bar-map' as the actual keymap to define the tool bar. Modes
+;; may either bind items under the [tool-bar] prefix key of the local
+;; map to add to the global bar or may set `tool-bar-map'
+;; buffer-locally to override it. (Some items are removed from the
+;; global bar in modes which have `special' as their `mode-class'
+;; properlty.)
+
+;; Todo: Somehow make tool bars easily customizable by the naive?
+
;;; Code:
;;;###autoload
(define-minor-mode tool-bar-mode
"Toggle use of the tool bar.
-With ARG, display the tool bar if and only if ARG is positive.
+With numeric ARG, display the tool bar if and only if ARG is positive.
See `tool-bar-add-item' and `tool-bar-add-item-from-menu' for
conveniently adding tool bar items."
- nil nil nil
:global t
:group 'mouse
:group 'frames
- (let ((lines (if tool-bar-mode 1 0)))
- ;; Alter existing frames...
- (mapc (lambda (frame)
- (modify-frame-parameters frame
- (list (cons 'tool-bar-lines lines))))
- (frame-list))
- ;; ...and future ones.
- (let ((elt (assq 'tool-bar-lines default-frame-alist)))
- (if elt
- (setcdr elt lines)
- (add-to-list 'default-frame-alist (cons 'tool-bar-lines lines))))))
-
-(defvar tool-bar-global-map (let ((map (make-sparse-keymap)))
- (global-set-key [tool-bar] map))
- "Keymap for the tool bar in the global map.")
+ (and (display-images-p)
+ (let ((lines (if tool-bar-mode 1 0)))
+ ;; Alter existing frames...
+ (mapc (lambda (frame)
+ (modify-frame-parameters frame
+ (list (cons 'tool-bar-lines lines))))
+ (frame-list))
+ ;; ...and future ones.
+ (let ((elt (assq 'tool-bar-lines default-frame-alist)))
+ (if elt
+ (setcdr elt lines)
+ (add-to-list 'default-frame-alist (cons 'tool-bar-lines lines)))))
+ (if (and tool-bar-mode
+ (display-graphic-p)
+ (= 1 (length (default-value 'tool-bar-map)))) ; not yet setup
+ (tool-bar-setup))))
+
+(defvar tool-bar-map (make-sparse-keymap)
+ "Keymap for the tool bar.
+Define this locally to override the global tool bar.")
+
+(global-set-key [tool-bar]
+ '(menu-item "tool bar" ignore
+ :filter (lambda (ignore) tool-bar-map)))
;;;###autoload
-(defun tool-bar-add-item (icon def key &optional map &rest props)
+(defun tool-bar-add-item (icon def key &rest props)
"Add an item to the tool bar.
ICON names the image, DEF is the key definition and KEY is a symbol
-for the fake function key in the menu keymap. MAP is the tool bar
-keymap in which to define the item; it defaults to
-`tool-bar-global-map'. Remaining arguments PROPS are additional items
-to add to the menu item specification. See Info node `(elisp)Tool
-Bar'. Items are added from left to right.
-
-ICON is the base name of a file cnntaining the image to use. The
-function will try to use first ICON.xpm, then ICON.xbm using
-`find-image'. If PROPS contains `:enable', a `disabled' version of
-the icon is generated automatically using the Laplace algorithm (see
-Info node `(elisp)Image Descriptors')."
- (let ((image (find-image `((:type xbm :file ,(concat icon ".xbm"))
- (:type xpm :file ,(concat icon ".xpm"))))))
- (when image
+for the fake function key in the menu keymap. Remaining arguments
+PROPS are additional items to add to the menu item specification. See
+Info node `(elisp)Tool Bar'. Items are added from left to right.
+
+ICON is the base name of a file containing the image to use. The
+function will first try to use ICON.xpm, then ICON.pbm, and finally
+ICON.xbm, using `find-image'.
+
+Keybindings are made in the map `tool-bar-map'. To define items in
+some local map, bind `tool-bar-map' with `let' around calls of this
+function."
+ (let* ((fg (face-attribute 'tool-bar :foreground))
+ (bg (face-attribute 'tool-bar :background))
+ (colors (nconc (if (eq fg 'unspecified) nil (list :foreground fg))
+ (if (eq bg 'unspecified) nil (list :background bg))))
+ (image (find-image
+ (if (display-color-p)
+ (list (list :type 'xpm :file (concat icon ".xpm"))
+ (append (list :type 'pbm :file (concat icon ".pbm"))
+ colors)
+ (append (list :type 'xbm :file (concat icon ".xbm"))
+ colors))
+ (list (append (list :type 'pbm :file (concat icon ".pbm"))
+ colors)
+ (append (list :type 'xbm :file (concat icon ".xbm"))
+ colors)
+ (list :type 'xpm :file (concat icon ".xpm")))))))
+ (when (and (display-images-p) image)
(unless (image-mask-p image)
(setq image (append image '(:mask heuristic))))
- (define-key-after (or map tool-bar-global-map) (vector key)
+ (define-key-after tool-bar-map (vector key)
`(menu-item ,(symbol-name key) ,def :image ,image ,@props)))))
+;;;###autoload
(defun tool-bar-add-item-from-menu (command icon &optional map &rest props)
"Define tool bar binding for COMMAND using the given ICON in keymap MAP.
The binding of COMMAND is looked up in the menu bar in MAP (default
`global-map') and modified to add an image specification for ICON, which
is looked for as by `tool-bar-add-item'.
-MAP must contain appropriate keymaps bound to `[menu-bar]' and
-`[tool-bar]'.
-PROPS is a list of additional properties to add to the binding."
+MAP must contain an appropriate keymap bound to `[menu-bar]'.
+PROPS is a list of additional properties to add to the binding.
+
+Keybindings are made in the map `tool-bar-map'. To define items in
+some local map, bind `tool-bar-map' with `let' around calls of this
+function."
(unless map
(setq map global-map))
(let* ((menu-bar-map (lookup-key map [menu-bar]))
(keys (where-is-internal command menu-bar-map))
- (tb-map (key-binding [tool-bar] map))
- (image (find-image `((:type xpm :file ,(concat icon ".xpm"))
- (:type xbm :file ,(concat icon ".xbm")))))
+ (fg (face-attribute 'tool-bar :foreground))
+ (bg (face-attribute 'tool-bar :background))
+ (colors (nconc (if (eq fg 'unspecified) nil (list :foreground fg))
+ (if (eq bg 'unspecified) nil (list :background bg))))
+ (spec (if (display-color-p)
+ (list (list :type 'xpm :file (concat icon ".xpm"))
+ (append (list :type 'pbm :file (concat icon ".pbm"))
+ colors)
+ (append (list :type 'xbm :file (concat icon ".xbm"))
+ colors))
+ (list (append (list :type 'pbm :file (concat icon ".pbm"))
+ colors)
+ (append (list :type 'xbm :file (concat icon ".xbm"))
+ colors)
+ (list :type 'xpm :file (concat icon ".xpm")))))
+ (image (find-image spec))
submap key)
- (when image
+ (when (and (display-images-p) image)
;; We'll pick up the last valid entry in the list of keys if
;; there's more than one.
(dolist (k keys)
key kk)))))
(when (and (symbolp submap) (boundp submap))
(setq submap (eval submap)))
- (define-key-after tb-map (vector key)
- (append (cdr (assq key (cdr submap))) (list :image image) props)))))
+ (unless (image-mask-p image)
+ (setq image (append image '(:mask heuristic))))
+ (let ((defn (assq key (cdr submap))))
+ (if (eq (cadr defn) 'menu-item)
+ (define-key-after tool-bar-map (vector key)
+ (append (cdr defn) (list :image image) props))
+ (setq defn (cdr defn))
+ (define-key-after tool-bar-map (vector key)
+ (append `(menu-item ,(car defn) ,(cddr defn))
+ (list :image image) props)))))))
;;; Set up some global items. Additions/deletions up for grabs.
-(tool-bar-add-item-from-menu 'save-buffers-kill-emacs "exit")
-(tool-bar-add-item-from-menu 'find-file "new")
-(tool-bar-add-item-from-menu 'dired "open")
-(tool-bar-add-item-from-menu 'kill-this-buffer "close")
-(tool-bar-add-item-from-menu 'save-buffer "save" nil
- :visible '(not (eq 'special (get major-mode
- 'mode-class))))
-(tool-bar-add-item-from-menu 'write-file "saveas" nil
- :visible '(not (eq 'special (get major-mode
- 'mode-class))))
-(tool-bar-add-item-from-menu 'undo "undo" nil
- :visible '(not (eq 'special (get major-mode
- 'mode-class))))
-(tool-bar-add-item-from-menu 'kill-region "cut" nil
- :visible '(not (eq 'special (get major-mode
- 'mode-class))))
-(tool-bar-add-item-from-menu 'menu-bar-kill-ring-save "copy")
-(tool-bar-add-item-from-menu 'yank "paste" nil
- :visible '(not (eq 'special (get major-mode
- 'mode-class))))
-(tool-bar-add-item-from-menu 'nonincremental-search-forward "search")
-;;(tool-bar-add-item-from-menu 'ispell-buffer "spell")
-
-;; There's no icon appropriate for News and we need a command rather
-;; than a lambda for Read Mail.
-;;(tool-bar-add-item-from-menu 'compose-mail "mail_compose")
-
-(tool-bar-add-item-from-menu 'print-buffer "print")
-(tool-bar-add-item "preferences" 'customize 'customize nil
- :help "Edit preferences (customize)")
-(tool-bar-add-item "help"
- (lambda ()
- (interactive)
- (let ((p (mouse-position)))
- (x-popup-menu (list (list (cadr p) (cddr p)) (car p))
- menu-bar-help-menu)))
- 'help nil :help "Pop up the Help menu")
+(defun tool-bar-setup ()
+ ;; People say it's bad to have EXIT on the tool bar, since users
+ ;; might inadvertently click that button.
+ ;;(tool-bar-add-item-from-menu 'save-buffers-kill-emacs "exit")
+ (tool-bar-add-item-from-menu 'find-file "new")
+ (tool-bar-add-item-from-menu 'dired "open")
+ (tool-bar-add-item-from-menu 'kill-this-buffer "close")
+ (tool-bar-add-item-from-menu 'save-buffer "save" nil
+ :visible '(or buffer-file-name
+ (not (eq 'special
+ (get major-mode
+ 'mode-class)))))
+ (tool-bar-add-item-from-menu 'write-file "saveas" nil
+ :visible '(or buffer-file-name
+ (not (eq 'special
+ (get major-mode
+ 'mode-class)))))
+ (tool-bar-add-item-from-menu 'undo "undo" nil
+ :visible '(not (eq 'special (get major-mode
+ 'mode-class))))
+ (tool-bar-add-item-from-menu 'kill-region "cut" nil
+ :visible '(not (eq 'special (get major-mode
+ 'mode-class))))
+ (tool-bar-add-item-from-menu 'menu-bar-kill-ring-save "copy")
+ (tool-bar-add-item-from-menu 'yank "paste" nil
+ :visible '(not (eq 'special (get major-mode
+ 'mode-class))))
+ (tool-bar-add-item-from-menu 'nonincremental-search-forward "search")
+ ;;(tool-bar-add-item-from-menu 'ispell-buffer "spell")
+
+ ;; There's no icon appropriate for News and we need a command rather
+ ;; than a lambda for Read Mail.
+ ;;(tool-bar-add-item-from-menu 'compose-mail "mail_compose")
+
+ (tool-bar-add-item-from-menu 'print-buffer "print")
+ (tool-bar-add-item "preferences" 'customize 'customize
+ :help "Edit preferences (customize)")
+
+ (tool-bar-add-item "help" (lambda ()
+ (interactive)
+ (popup-menu menu-bar-help-menu))
+ 'help
+ :help "Pop up the Help menu")
+ )
(provide 'tool-bar)
HCoop / bpt / emacs.git / blobdiff