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 ;; Keywords: help, extensions, faces, hypermedia
   7 ;; Version: 1.9920
   8 ;; X-URL: http://www.dina.kvl.dk/~abraham/custom/
   9
  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
  27 ;;; Commentary:
  28 ;;
  29 ;; If you want to use this code, please visit the URL above.
  30 ;;
  31 ;; This file only contain the code needed to define new widget types.
  32 ;; Everything else is autoloaded from `wid-edit.el'.
  33
  34 ;;; Code:
  35
  36 (eval-when-compile (require 'cl))
  37
  38 (defmacro define-widget-keywords (&rest keys)
  39   ;; Don't use backquote, since that makes trouble trying to
  40   ;; re-bootstrap from just the .el files.
  41   (list 'eval-and-compile
  42     (list 'let (list (list 'keywords (list 'quote keys)))
  43       (list 'while 'keywords
  44        (list 'or (list 'boundp (list 'car 'keywords))
  45            (list 'set (list 'car 'keywords) (list 'car 'keywords)))
  46        (list 'setq 'keywords (list 'cdr 'keywords))))))
  47
  48 (define-widget-keywords :documentation-indent
  49   :complete-function :complete :button-overlay
  50   :field-overlay
  51   :documentation-shown :button-prefix
  52   :button-suffix :mouse-down-action :glyph-up :glyph-down :glyph-inactive
  53   :prompt-internal :prompt-history :prompt-match
  54   :prompt-value  :deactivate :active
  55   :inactive :activate :sibling-args :delete-button-args
  56   :insert-button-args :append-button-args :button-args
  57   :tag-glyph :off-glyph :on-glyph :valid-regexp
  58   :secret :sample-face :sample-face-get :case-fold
  59   :create :convert-widget :format :value-create :offset :extra-offset
  60   :tag :doc :from :to :args :value :action
  61   :value-set :value-delete :match :parent :delete :menu-tag-get
  62   :value-get :choice :void :menu-tag :on :off :on-type :off-type
  63   :notify :entry-format :button :children :buttons :insert-before
  64   :delete-at :format-handler :widget :value-pos :value-to-internal
  65   :indent :size :value-to-external :validate :error :directory
  66   :must-match :type-error :value-inline :inline :match-inline :greedy
  67   :button-face-get :button-face :value-face :keymap :entry-from
  68   :entry-to :help-echo :documentation-property :tab-order)
  69
  70 (defun define-widget (name class doc &rest args)
  71   "Define a new widget type named NAME from CLASS.
  72
  73 NAME and CLASS should both be symbols, CLASS should be one of the
  74 existing widget types, or nil to create the widget from scratch.
  75
  76 After the new widget has been defined, the following two calls will
  77 create identical widgets:
  78
  79 * (widget-create NAME)
  80
  81 * (apply 'widget-create CLASS ARGS)
  82
  83 The third argument DOC is a documentation string for the widget."
  84   (put name 'widget-type (cons class args))
  85   (put name 'widget-documentation doc)
  86   name)
  87
  88 ;;; The End.
  89
  90 (provide 'widget)
  91
  92 ;; widget.el ends here