Initial git import
[sxemacs] / lisp / widget.el
1 ;;; widget.el --- a library of user interface components.
2
3 ;; Copyright (C) 1996, 1997 Free Software Foundation, Inc.
4
5 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
6 ;; Maintainer: Hrvoje Niksic <hniksic@xemacs.org>
7 ;; Keywords: help, extensions, faces, hypermedia, dumped
8 ;; Version: 1.9960-x
9 ;; X-URL: http://www.dina.kvl.dk/~abraham/custom/
10
11 ;; This file is part of SXEmacs.
12
13 ;; SXEmacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
17
18 ;; SXEmacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 ;; GNU General Public License for more details.
22
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with this program.  If not, see <http://www.gnu.org/licenses/>.
25
26 ;;; Commentary:
27
28 ;; This file is dumped with SXEmacs.
29
30 ;; If you want to use this code, please visit the URL above.
31
32 ;; This file only contain the code needed to define new widget types.
33 ;; Everything else is autoloaded from `wid-edit.el'.
34
35 ;;; Code:
36
37 ;; Neither XEmacs, nor latest GNU Emacs need this -- provided for
38 ;; compatibility.
39 ;; (defalias 'define-widget-keywords 'ignore)
40
41 (defmacro define-widget-keywords (&rest keys)
42   "This doesn't do anything in Emacs 20 or XEmacs."
43   `(eval-and-compile
44      (let ((keywords (quote ,keys)))
45        (while keywords
46          (or (boundp (car keywords))
47              (set (car keywords) (car keywords)))
48          (setq keywords (cdr keywords))))))
49
50 (defun define-widget (name class doc &rest args)
51   "Define a new widget type named NAME from CLASS.
52
53 NAME and CLASS should both be symbols, CLASS should be one of the
54 existing widget types, or nil to create the widget from scratch.
55
56 After the new widget has been defined, the following two calls will
57 create identical widgets:
58
59 * (widget-create NAME)
60
61 * (apply 'widget-create CLASS ARGS)
62
63 The third argument DOC is a documentation string for the widget."
64   (check-argument-type 'symbolp name)
65   (check-argument-type 'symbolp class)
66   (put name 'widget-type (cons class args))
67   (put name 'widget-documentation doc)
68   name)
69
70 ;;; The End.
71
72 (provide 'widget)
73
74 ;;; widget.el ends here