lisp/widget.el

   1 ;;; widget.el --- a library of user interface components
   2 ;;
   3 ;; Copyright (C) 1996, 1997, 2001, 2002, 2003, 2004,
   4 ;;   2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
   5 ;;
   6 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
   7 ;; Keywords: help, extensions, faces, hypermedia
   8 ;; Version: 1.9920
   9 ;; X-URL: http://www.dina.kvl.dk/~abraham/custom/
  10 ;; Package: emacs
  11
  12 ;; This file is part of GNU Emacs.
  13
  14 ;; GNU Emacs is free software: you can redistribute it and/or modify
  15 ;; it under the terms of the GNU General Public License as published by
  16 ;; the Free Software Foundation, either version 3 of the License, or
  17 ;; (at your option) any later version.
  18
  19 ;; GNU Emacs is distributed in the hope that it will be useful,
  20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22 ;; GNU General Public License for more details.
  23
  24 ;; You should have received a copy of the GNU General Public License
  25 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  26
  27 ;;; Commentary:
  28 ;;
  29 ;; The widget library is partially documented in the `widget' Info
  30 ;; file.
  31 ;;
  32 ;; This file only contains the code needed to define new widget types.
  33 ;; Everything else is autoloaded from `wid-edit.el'.
  34
  35 ;;; Code:
  36
  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.
  40 (defmacro define-widget-keywords (&rest keys)
  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)
  72
  73 (put 'define-widget 'doc-string-elt 3)  ;`declare' doesn't work in functions.
  74 (defun define-widget (name class doc &rest args)
  75   "Define a new widget type named NAME from CLASS.
  76
  77 NAME and CLASS should both be symbols, CLASS should be one of the
  78 existing widget types, or nil to create the widget from scratch.
  79
  80 After the new widget has been defined, the following two calls will
  81 create identical widgets:
  82
  83 * (widget-create NAME)
  84
  85 * (apply 'widget-create CLASS ARGS)
  86
  87 The third argument DOC is a documentation string for the widget."
  88   (put name 'widget-type (cons class args))
  89   (put name 'widget-documentation (purecopy doc))
  90   name)
  91
  92 ;; This is used by external widget code (in W3, at least).
  93 (defalias 'widget-plist-member 'plist-member)
  94
  95 ;;; The End.
  96
  97 (provide 'widget)
  98
  99 ;; arch-tag: 932c71a3-9aeb-4827-a293-8b88b26d5c58
 100 ;;; widget.el ends here