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