widget.el 3.75 KB
Newer Older
1
;;; widget.el --- a library of user interface components
Per Abrahamsen's avatar
Per Abrahamsen committed
2
;;
3
;; Copyright (C) 1996-1997, 2001-2011 Free Software Foundation, Inc.
Per Abrahamsen's avatar
Per Abrahamsen committed
4 5 6
;;
;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
;; Keywords: help, extensions, faces, hypermedia
Per Abrahamsen's avatar
Per Abrahamsen committed
7
;; Version: 1.9920
Per Abrahamsen's avatar
Per Abrahamsen committed
8
;; X-URL: http://www.dina.kvl.dk/~abraham/custom/
9
;; Package: emacs
Per Abrahamsen's avatar
Per Abrahamsen committed
10

Richard M. Stallman's avatar
Richard M. Stallman committed
11 12
;; This file is part of GNU Emacs.

13
;; GNU Emacs is free software: you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
14
;; it under the terms of the GNU General Public License as published by
15 16
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Richard M. Stallman's avatar
Richard M. Stallman committed
17 18 19 20 21 22 23

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
24
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Richard M. Stallman's avatar
Richard M. Stallman committed
25

Per Abrahamsen's avatar
Per Abrahamsen committed
26
;;; Commentary:
27
;;
28 29
;; The widget library is partially documented in the `widget' Info
;; file.
Per Abrahamsen's avatar
Per Abrahamsen committed
30
;;
31
;; This file only contains the code needed to define new widget types.
Per Abrahamsen's avatar
Per Abrahamsen committed
32 33 34 35
;; Everything else is autoloaded from `wid-edit.el'.

;;; Code:

36 37 38
;; Doing this is unnecessary in Emacs 20.  Kept as dummy in case
;; external libraries call it.  We save a kb or two of purespace by
;; dummying-out such definitions generally.
Per Abrahamsen's avatar
Per Abrahamsen committed
39
(defmacro define-widget-keywords (&rest keys)
40 41 42 43 44 45 46 47
  ;; ;; Don't use backquote, since that makes trouble trying to
  ;; ;; re-bootstrap from just the .el files.
  ;; (list 'eval-and-compile
  ;;   (list 'let (list (list 'keywords (list 'quote keys)))
  ;;     (list 'while 'keywords
  ;; 	(list 'or (list 'boundp (list 'car 'keywords))
  ;; 	  (list 'set (list 'car 'keywords) (list 'car 'keywords)))
  ;; 	(list 'setq 'keywords (list 'cdr 'keywords)))))
48 49
  )

50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
;;(define-widget-keywords :documentation-indent
;;  :complete-function :complete :button-overlay
;;  :field-overlay
;;  :documentation-shown :button-prefix
;;  :button-suffix :mouse-down-action :glyph-up :glyph-down :glyph-inactive
;;  :prompt-internal :prompt-history :prompt-match
;;  :prompt-value  :deactivate :active
;;  :inactive :activate :sibling-args :delete-button-args
;;  :insert-button-args :append-button-args :button-args
;;  :tag-glyph :off-glyph :on-glyph :valid-regexp
;;  :secret :sample-face :sample-face-get :case-fold
;;  :create :convert-widget :format :value-create :offset :extra-offset
;;  :tag :doc :from :to :args :value :action
;;  :value-set :value-delete :match :parent :delete :menu-tag-get
;;  :value-get :choice :void :menu-tag :on :off :on-type :off-type
;;  :notify :entry-format :button :children :buttons :insert-before
;;  :delete-at :format-handler :widget :value-pos :value-to-internal
;;  :indent :size :value-to-external :validate :error :directory
;;  :must-match :type-error :value-inline :inline :match-inline :greedy
;;  :button-face-get :button-face :value-face :keymap :entry-from
;;  :entry-to :help-echo :documentation-property :tab-order)
Per Abrahamsen's avatar
Per Abrahamsen committed
71

72
(put 'define-widget 'doc-string-elt 3)  ;`declare' doesn't work in functions.
Per Abrahamsen's avatar
Per Abrahamsen committed
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
(defun define-widget (name class doc &rest args)
  "Define a new widget type named NAME from CLASS.

NAME and CLASS should both be symbols, CLASS should be one of the
existing widget types, or nil to create the widget from scratch.

After the new widget has been defined, the following two calls will
create identical widgets:

* (widget-create NAME)

* (apply 'widget-create CLASS ARGS)

The third argument DOC is a documentation string for the widget."
  (put name 'widget-type (cons class args))
88
  (put name 'widget-documentation (purecopy doc))
Per Abrahamsen's avatar
Per Abrahamsen committed
89
  name)
Per Abrahamsen's avatar
Per Abrahamsen committed
90

Dave Love's avatar
Dave Love committed
91 92 93
;; This is used by external widget code (in W3, at least).
(defalias 'widget-plist-member 'plist-member)

Per Abrahamsen's avatar
Per Abrahamsen committed
94 95 96 97
;;; The End.

(provide 'widget)

98
;;; widget.el ends here