cgit.sxemacs.org Git - gnus/blob - lisp/widget.el

   1 ;;; widget.el --- a library of user interface components.
   2 ;;
   3 ;; Copyright (C) 1996 Free Software Foundation, Inc.
   4 ;;
   5 ;; Author: Per Abrahamsen <abraham@dina.kvl.dk>
   6 ;; Keywords: help, extensions, faces, hypermedia
   7 ;; Version: 1.12
   8 ;; X-URL: http://www.dina.kvl.dk/~abraham/custom/
   9
  10 ;;; Commentary:
  11 ;;
  12 ;; If you want to use this code, please visit the URL above.
  13 ;;
  14 ;; This file only contain the code needed to define new widget types.
  15 ;; Everything else is autoloaded from `widget-edit.el'.
  16
  17 ;;; Code:
  18
  19 (eval-when-compile (require 'cl))
  20
  21 (defmacro define-widget-keywords (&rest keys)
  22   (`
  23    (eval-and-compile
  24      (let ((keywords (quote (, keys))))
  25        (while keywords
  26          (or (boundp (car keywords))
  27              (set (car keywords) (car keywords)))
  28          (setq keywords (cdr keywords)))))))
  29
  30 (define-widget-keywords :case-fold :widget-doc
  31   :create :convert-widget :format :value-create :offset :extra-offset
  32   :tag :doc :from :to :args :value :value-from :value-to :action
  33   :value-set :value-delete :match :parent :delete :menu-tag-get
  34   :value-get :choice :void :menu-tag :on :off :on-type :off-type
  35   :notify :entry-format :button :children :buttons :insert-before
  36   :delete-at :format-handler :widget :value-pos :value-to-internal
  37   :indent :size :value-to-external :validate :error :directory
  38   :must-match :type-error :value-inline :inline :match-inline :greedy
  39   :button-face-get :button-face :value-face :keymap :entry-from
  40   :entry-to :help-echo :documentation-property :hide-front-space
  41   :hide-rear-space)
  42
  43 ;; These autoloads should be deleted when the file is added to Emacs.
  44 (autoload 'widget-create "widget-edit")
  45 (autoload 'widget-insert "widget-edit")
  46
  47 ;;;###autoload
  48 (defun define-widget (name class doc &rest args)
  49   "Define a new widget type named NAME from CLASS.
  50
  51 NAME and CLASS should both be symbols, CLASS should be one of the
  52 existing widget types, or nil to create the widget from scratch.
  53
  54 After the new widget has been defined, the following two calls will
  55 create identical widgets:
  56
  57 * (widget-create NAME)
  58
  59 * (apply 'widget-create CLASS ARGS)
  60
  61 The third argument DOC is a documentation string for the widget."
  62   (put name 'widget-type (cons class args))
  63   (put name 'widget-documentation doc))
  64
  65 ;;; The End.
  66
  67 (provide 'widget)
  68
  69 ;; widget.el ends here