lisp/widget.el

   1 ;;; widget.el --- a library of user interface components
   2 ;;
   3 ;; Copyright (C) 1996-1997, 2001-2012 Free Software Foundation, Inc.
   4 ;;
   5 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
   6 ;; Keywords: help, extensions, faces, hypermedia
   7 ;; Version: 1.9920
   8 ;; X-URL: http://www.dina.kvl.dk/~abraham/custom/
   9 ;; Package: emacs
  10
  11 ;; This file is part of GNU Emacs.
  12
  13 ;; GNU Emacs 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 ;; GNU Emacs 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 GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  25
  26 ;;; Commentary:
  27 ;;
  28 ;; The widget library is partially documented in the `widget' Info
  29 ;; file.
  30 ;;
  31 ;; This file only contains the code needed to define new widget types.
  32 ;; Everything else is autoloaded from `wid-edit.el'.
  33
  34 ;;; Code:
  35
  36 ;; Doing this is unnecessary in Emacs 20.  Kept as dummy in case
  37 ;; external libraries call it.  We save a kb or two of purespace by
  38 ;; dummying-out such definitions generally.
  39 (defmacro define-widget-keywords (&rest _keys)
  40   ;; ;; Don't use backquote, since that makes trouble trying to
  41   ;; ;; re-bootstrap from just the .el files.
  42   ;; (list 'eval-and-compile
  43   ;;   (list 'let (list (list 'keywords (list 'quote keys)))
  44   ;;     (list 'while 'keywords
  45   ;;    (list 'or (list 'boundp (list 'car 'keywords))
  46   ;;      (list 'set (list 'car 'keywords) (list 'car 'keywords)))
  47   ;;    (list 'setq 'keywords (list 'cdr 'keywords)))))
  48   )
  49
  50 ;;(define-widget-keywords :documentation-indent
  51 ;;  :complete-function :complete :button-overlay
  52 ;;  :field-overlay
  53 ;;  :documentation-shown :button-prefix
  54 ;;  :button-suffix :mouse-down-action :glyph-up :glyph-down :glyph-inactive
  55 ;;  :prompt-internal :prompt-history :prompt-match
  56 ;;  :prompt-value  :deactivate :active
  57 ;;  :inactive :activate :sibling-args :delete-button-args
  58 ;;  :insert-button-args :append-button-args :button-args
  59 ;;  :tag-glyph :off-glyph :on-glyph :valid-regexp
  60 ;;  :secret :sample-face :sample-face-get :case-fold
  61 ;;  :create :convert-widget :format :value-create :offset :extra-offset
  62 ;;  :tag :doc :from :to :args :value :action
  63 ;;  :value-set :value-delete :match :parent :delete :menu-tag-get
  64 ;;  :value-get :choice :void :menu-tag :on :off :on-type :off-type
  65 ;;  :notify :entry-format :button :children :buttons :insert-before
  66 ;;  :delete-at :format-handler :widget :value-pos :value-to-internal
  67 ;;  :indent :size :value-to-external :validate :error :directory
  68 ;;  :must-match :type-error :value-inline :inline :match-inline :greedy
  69 ;;  :button-face-get :button-face :value-face :keymap :entry-from
  70 ;;  :entry-to :help-echo :documentation-property :tab-order)
  71
  72 (put 'define-widget 'doc-string-elt 3)  ;`declare' doesn't work in functions.
  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))
  88   (put name 'widget-documentation (purecopy doc))
  89   name)
  90
  91 ;; This is used by external widget code (in W3, at least).
  92 (defalias 'widget-plist-member 'plist-member)
  93
  94 ;;; The End.
  95
  96 (provide 'widget)
  97
  98 ;;; widget.el ends here