annotate lisp/widget.el @ 31898:a73424672d42

*** empty log message ***
author Gerd Moellmann <gerd@gnu.org>
date Tue, 26 Sep 2000 11:12:19 +0000
parents 490de0786afa
children b174db545cfd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17334
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
1 ;;; widget.el --- a library of user interface components.
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
2 ;;
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
3 ;; Copyright (C) 1996, 1997 Free Software Foundation, Inc.
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
4 ;;
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
5 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
6 ;; Keywords: help, extensions, faces, hypermedia
18258
e83bc8150072 Synched with 1.9920.
Per Abrahamsen <abraham@dina.kvl.dk>
parents: 18139
diff changeset
7 ;; Version: 1.9920
17334
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
8 ;; X-URL: http://www.dina.kvl.dk/~abraham/custom/
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
9
17520
f33d7729b6a1 Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 17415
diff changeset
10 ;; This file is part of GNU Emacs.
f33d7729b6a1 Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 17415
diff changeset
11
f33d7729b6a1 Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 17415
diff changeset
12 ;; GNU Emacs is free software; you can redistribute it and/or modify
f33d7729b6a1 Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 17415
diff changeset
13 ;; it under the terms of the GNU General Public License as published by
f33d7729b6a1 Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 17415
diff changeset
14 ;; the Free Software Foundation; either version 2, or (at your option)
f33d7729b6a1 Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 17415
diff changeset
15 ;; any later version.
f33d7729b6a1 Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 17415
diff changeset
16
f33d7729b6a1 Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 17415
diff changeset
17 ;; GNU Emacs is distributed in the hope that it will be useful,
f33d7729b6a1 Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 17415
diff changeset
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
f33d7729b6a1 Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 17415
diff changeset
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
f33d7729b6a1 Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 17415
diff changeset
20 ;; GNU General Public License for more details.
f33d7729b6a1 Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 17415
diff changeset
21
f33d7729b6a1 Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 17415
diff changeset
22 ;; You should have received a copy of the GNU General Public License
f33d7729b6a1 Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 17415
diff changeset
23 ;; along with GNU Emacs; see the file COPYING. If not, write to the
f33d7729b6a1 Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 17415
diff changeset
24 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
f33d7729b6a1 Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 17415
diff changeset
25 ;; Boston, MA 02111-1307, USA.
f33d7729b6a1 Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 17415
diff changeset
26
17334
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
27 ;;; Commentary:
25179
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
28 ;;
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
29 ;; The widget library is partially documented in the `widget' Info
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
30 ;; file.
17334
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
31 ;;
25179
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
32 ;; This file only contains the code needed to define new widget types.
17334
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
33 ;; Everything else is autoloaded from `wid-edit.el'.
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
34
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
35 ;;; Code:
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
36
25179
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
37 ;; Doing this is unnecessary in Emacs 20. Kept as dummy in case
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
38 ;; external libraries call it. We save a kb or two of purespace by
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
39 ;; dummying-out such definitions generally.
17334
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
40 (defmacro define-widget-keywords (&rest keys)
25179
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
41 ;;; ;; Don't use backquote, since that makes trouble trying to
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
42 ;;; ;; re-bootstrap from just the .el files.
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
43 ;;; (list 'eval-and-compile
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
44 ;;; (list 'let (list (list 'keywords (list 'quote keys)))
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
45 ;;; (list 'while 'keywords
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
46 ;;; (list 'or (list 'boundp (list 'car 'keywords))
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
47 ;;; (list 'set (list 'car 'keywords) (list 'car 'keywords)))
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
48 ;;; (list 'setq 'keywords (list 'cdr 'keywords)))))
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
49 )
17334
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
50
25179
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
51 ;;;(define-widget-keywords :documentation-indent
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
52 ;;; :complete-function :complete :button-overlay
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
53 ;;; :field-overlay
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
54 ;;; :documentation-shown :button-prefix
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
55 ;;; :button-suffix :mouse-down-action :glyph-up :glyph-down :glyph-inactive
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
56 ;;; :prompt-internal :prompt-history :prompt-match
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
57 ;;; :prompt-value :deactivate :active
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
58 ;;; :inactive :activate :sibling-args :delete-button-args
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
59 ;;; :insert-button-args :append-button-args :button-args
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
60 ;;; :tag-glyph :off-glyph :on-glyph :valid-regexp
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
61 ;;; :secret :sample-face :sample-face-get :case-fold
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
62 ;;; :create :convert-widget :format :value-create :offset :extra-offset
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
63 ;;; :tag :doc :from :to :args :value :action
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
64 ;;; :value-set :value-delete :match :parent :delete :menu-tag-get
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
65 ;;; :value-get :choice :void :menu-tag :on :off :on-type :off-type
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
66 ;;; :notify :entry-format :button :children :buttons :insert-before
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
67 ;;; :delete-at :format-handler :widget :value-pos :value-to-internal
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
68 ;;; :indent :size :value-to-external :validate :error :directory
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
69 ;;; :must-match :type-error :value-inline :inline :match-inline :greedy
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
70 ;;; :button-face-get :button-face :value-face :keymap :entry-from
c7ee317291f8 (define-widget-keywords): Make dummy definition and comment-out its use.
Dave Love <fx@gnu.org>
parents: 21788
diff changeset
71 ;;; :entry-to :help-echo :documentation-property :tab-order)
17334
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
72
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
73 (defun define-widget (name class doc &rest args)
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
74 "Define a new widget type named NAME from CLASS.
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
75
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
76 NAME and CLASS should both be symbols, CLASS should be one of the
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
77 existing widget types, or nil to create the widget from scratch.
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
78
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
79 After the new widget has been defined, the following two calls will
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
80 create identical widgets:
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
81
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
82 * (widget-create NAME)
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
83
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
84 * (apply 'widget-create CLASS ARGS)
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
85
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
86 The third argument DOC is a documentation string for the widget."
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
87 (put name 'widget-type (cons class args))
17550
d6545cfb6c5a Synched with custom 1.90.
Per Abrahamsen <abraham@dina.kvl.dk>
parents: 17520
diff changeset
88 (put name 'widget-documentation doc)
d6545cfb6c5a Synched with custom 1.90.
Per Abrahamsen <abraham@dina.kvl.dk>
parents: 17520
diff changeset
89 name)
17334
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
90
30147
490de0786afa (widget-plist-member): New alias.
Dave Love <fx@gnu.org>
parents: 25179
diff changeset
91 ;; This is used by external widget code (in W3, at least).
490de0786afa (widget-plist-member): New alias.
Dave Love <fx@gnu.org>
parents: 25179
diff changeset
92 (defalias 'widget-plist-member 'plist-member)
490de0786afa (widget-plist-member): New alias.
Dave Love <fx@gnu.org>
parents: 25179
diff changeset
93
17334
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
94 ;;; The End.
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
95
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
96 (provide 'widget)
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
97
1effe507ea85 Initial revision
Per Abrahamsen <abraham@dina.kvl.dk>
parents:
diff changeset
98 ;; widget.el ends here