lisp/toolbar/tool-bar.el

   1 ;;; tool-bar.el --- Setting up the tool bar
   2 ;;
   3 ;; Copyright (C) 2000 Free Software Foundation, Inc.
   4 ;;
   5 ;; Author: Dave Love <fx@gnu.org>
   6 ;; Keywords: mouse frames
   7
   8 ;; This file is part of GNU Emacs.
   9
  10 ;; GNU Emacs is free software; you can redistribute it and/or modify
  11 ;; it under the terms of the GNU General Public License as published by
  12 ;; the Free Software Foundation; either version 2, or (at your option)
  13 ;; any later version.
  14
  15 ;; GNU Emacs is distributed in the hope that it will be useful,
  16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 ;; GNU General Public License for more details.
  19
  20 ;; You should have received a copy of the GNU General Public License
  21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  23 ;; Boston, MA 02111-1307, USA.
  24
  25 ;;; Commentary:
  26
  27 ;; Provides `tool-bar-mode' to control display of the tool -bar and
  28 ;; bindings for the global tool bar with convenience functions
  29 ;; `tool-bar-add-item' and `tool-bar-add-item-from-menu'.
  30
  31 ;; The normal global binding for [tool-bar] (below) uses the value of
  32 ;; `tool-bar-map' as the actual keymap to define the tool bar.  Modes
  33 ;; may either bind items under the [tool-bar] prefix key of the local
  34 ;; map to add to the global bar or may set `tool-bar-map'
  35 ;; buffer-locally to override it.  (Some items are removed from the
  36 ;; global bar in modes which have `special' as their `mode-class'
  37 ;; properlty.)
  38
  39 ;; Todo: Somehow make tool bars easily customizable by the naive?
  40
  41 ;;; Code:
  42
  43 ;;;###autoload
  44 (define-minor-mode tool-bar-mode
  45   "Toggle use of the tool bar.
  46 With ARG, display the tool bar if and only if ARG is positive.
  47
  48 See `tool-bar-add-item' and `tool-bar-add-item-from-menu' for
  49 conveniently adding tool bar items."
  50   :global t
  51   :group 'mouse
  52   :group 'frames
  53   (let ((lines (if tool-bar-mode 1 0)))
  54     ;; Alter existing frames...
  55     (mapc (lambda (frame)
  56             (modify-frame-parameters frame
  57                                      (list (cons 'tool-bar-lines lines))))
  58           (frame-list))
  59     ;; ...and future ones.
  60     (let ((elt (assq 'tool-bar-lines default-frame-alist)))
  61       (if elt
  62           (setcdr elt lines)
  63         (add-to-list 'default-frame-alist (cons 'tool-bar-lines lines)))))
  64   (if (and tool-bar-mode
  65            (display-graphic-p)
  66            (= 1 (length (default-value 'tool-bar-map)))) ; not yet setup
  67       (tool-bar-setup)))
  68
  69 (defvar tool-bar-map (make-sparse-keymap)
  70   "Keymap for the tool bar.
  71 Define this locally to override the global tool bar.")
  72
  73 (global-set-key [tool-bar]
  74                 '(menu-item "tool bar" ignore
  75                             :filter (lambda (ignore) tool-bar-map)))
  76
  77 ;;;###autoload
  78 (defun tool-bar-add-item (icon def key &rest props)
  79   "Add an item to the tool bar.
  80 ICON names the image, DEF is the key definition and KEY is a symbol
  81 for the fake function key in the menu keymap.  Remaining arguments
  82 PROPS are additional items to add to the menu item specification.  See
  83 Info node `(elisp)Tool Bar'.  Items are added from left to right.
  84
  85 ICON is the base name of a file cnntaining the image to use.  The
  86 function will try to use first ICON.xpm, ICON.pbm then ICON.xbm using
  87 `find-image'.
  88
  89 Keybindings are made in the map `tool-bar-map'.  To define items in
  90 some local map, bind `tool-bar-map' with `let' around calls of this
  91 function."
  92   (let* ((fg (face-foreground 'tool-bar))
  93          (bg (face-background 'tool-bar))
  94          (image (find-image
  95                 (if (display-color-p)
  96                      `((:type xpm :file ,(concat icon ".xpm"))
  97                        (:type pbm :file ,(concat icon ".pbm")
  98                         :background ,bg
  99                         :foreground ,fg)
 100                        (:type xbm :file ,(concat icon ".xbm")
 101                         :background ,bg
 102                         :foreground ,fg))
 103                    `((:type pbm :file ,(concat icon ".pbm")
 104                       :background ,bg
 105                       :foreground ,fg)
 106                      (:type xbm :file ,(concat icon ".xbm")
 107                       :background ,bg
 108                       :foreground ,fg)
 109                      (:type xpm :file ,(concat icon ".xpm")))))))
 110     (when image
 111       (unless (image-mask-p image)
 112         (setq image (append image '(:mask heuristic))))
 113       (define-key-after tool-bar-map (vector key)
 114         `(menu-item ,(symbol-name key) ,def :image ,image ,@props)))))
 115
 116 ;;;###autoload
 117 (defun tool-bar-add-item-from-menu (command icon &optional map &rest props)
 118   "Define tool bar binding for COMMAND using the given ICON in keymap MAP.
 119 The binding of COMMAND is looked up in the menu bar in MAP (default
 120 `global-map') and modified to add an image specification for ICON, which
 121 is looked for as by `tool-bar-add-item'.
 122 MAP must contain an appropriate keymap bound to `[menu-bar]'.
 123 PROPS is a list of additional properties to add to the binding.
 124
 125 Keybindings are made in the map `tool-bar-map'.  To define items in
 126 some local map, bind `tool-bar-map' with `let' around calls of this
 127 function."
 128   (unless map
 129     (setq map global-map))
 130   (let* ((menu-bar-map (lookup-key map [menu-bar]))
 131          (keys (where-is-internal command menu-bar-map))
 132          (fg (face-foreground 'tool-bar))
 133          (bg (face-background 'tool-bar))
 134          (image (find-image
 135                  (if (display-color-p)
 136                      `((:type xpm :file ,(concat icon ".xpm"))
 137                        (:type pbm :file ,(concat icon ".pbm")
 138                         :background ,bg
 139                         :foreground ,fg)
 140                        (:type xbm :file ,(concat icon ".xbm")
 141                         :background ,bg
 142                         :foreground ,fg))
 143                    `((:type pbm :file ,(concat icon ".pbm")
 144                       :background ,bg
 145                       :foreground ,fg)
 146                      (:type xbm :file ,(concat icon ".xbm")
 147                       :background ,bg
 148                       :foreground ,fg)
 149                      (:type xpm :file ,(concat icon ".xpm"))))))
 150          submap key)
 151     (when image
 152       ;; We'll pick up the last valid entry in the list of keys if
 153       ;; there's more than one.
 154       (dolist (k keys)
 155         ;; We're looking for a binding of the command in a submap of
 156         ;; the menu bar map, so the key sequence must be two or more
 157         ;; long.
 158         (if (and (vectorp k)
 159                  (> (length k) 1))
 160             (let ((m (lookup-key menu-bar-map (substring k 0 -1)))
 161                   ;; Last element in the bound key sequence:
 162                   (kk (aref k (1- (length k)))))
 163               (if (and (keymapp m)
 164                        (symbolp kk))
 165                   (setq submap m
 166                         key kk)))))
 167       (when (and (symbolp submap) (boundp submap))
 168         (setq submap (eval submap)))
 169       (unless (image-mask-p image)
 170         (setq image (append image '(:mask heuristic))))
 171       (define-key-after tool-bar-map (vector key)
 172         (append (cdr (assq key (cdr submap))) (list :image image) props)))))
 173
 174 ;;; Set up some global items.  Additions/deletions up for grabs.
 175
 176 (defun tool-bar-setup ()
 177   (tool-bar-add-item-from-menu 'save-buffers-kill-emacs "exit")
 178   (tool-bar-add-item-from-menu 'find-file "new")
 179   (tool-bar-add-item-from-menu 'dired "open")
 180   (tool-bar-add-item-from-menu 'kill-this-buffer "close")
 181   (tool-bar-add-item-from-menu 'save-buffer "save" nil
 182                                :visible '(not (eq 'special (get major-mode
 183                                                                 'mode-class))))
 184   (tool-bar-add-item-from-menu 'write-file "saveas" nil
 185                                :visible '(not (eq 'special (get major-mode
 186                                                                 'mode-class))))
 187   (tool-bar-add-item-from-menu 'undo "undo" nil
 188                                :visible '(not (eq 'special (get major-mode
 189                                                                 'mode-class))))
 190   (tool-bar-add-item-from-menu 'kill-region "cut" nil
 191                                :visible '(not (eq 'special (get major-mode
 192                                                                 'mode-class))))
 193   (tool-bar-add-item-from-menu 'menu-bar-kill-ring-save "copy")
 194   (tool-bar-add-item-from-menu 'yank "paste" nil
 195                                :visible '(not (eq 'special (get major-mode
 196                                                                 'mode-class))))
 197   (tool-bar-add-item-from-menu 'nonincremental-search-forward "search")
 198   ;;(tool-bar-add-item-from-menu 'ispell-buffer "spell")
 199
 200   ;; There's no icon appropriate for News and we need a command rather
 201   ;; than a lambda for Read Mail.
 202   ;;(tool-bar-add-item-from-menu 'compose-mail "mail_compose")
 203
 204   (tool-bar-add-item-from-menu 'print-buffer "print")
 205   (tool-bar-add-item "preferences" 'customize 'customize
 206                      :help "Edit preferences (customize)")
 207
 208   (tool-bar-add-item "help" (lambda ()
 209                               (interactive)
 210                               (popup-menu menu-bar-help-menu))
 211                      'help
 212                      :help "Pop up the Help menu")
 213   )
 214
 215 (provide 'tool-bar)
 216
 217 ;;; tool-bar.el ends here