cgit.sxemacs.org Git - gnus/blob - 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.59
   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 `wid-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 :sibling-args :delete-button-args
  31   :insert-button-args :append-button-args :button-args
  32   :tag-glyph :off-glyph :on-glyph :valid-regexp
  33   :secret :sample-face :sample-face-get :case-fold :widget-doc
  34   :create :convert-widget :format :value-create :offset :extra-offset
  35   :tag :doc :from :to :args :value :value-from :value-to :action
  36   :value-set :value-delete :match :parent :delete :menu-tag-get
  37   :value-get :choice :void :menu-tag :on :off :on-type :off-type
  38   :notify :entry-format :button :children :buttons :insert-before
  39   :delete-at :format-handler :widget :value-pos :value-to-internal
  40   :indent :size :value-to-external :validate :error :directory
  41   :must-match :type-error :value-inline :inline :match-inline :greedy
  42   :button-face-get :button-face :value-face :keymap :entry-from
  43   :entry-to :help-echo :documentation-property :hide-front-space
  44   :hide-rear-space)
  45
  46 ;; These autoloads should be deleted when the file is added to Emacs.
  47 (unless (fboundp 'load-gc)
  48   (autoload 'widget-create "wid-edit")
  49   (autoload 'widget-insert "wid-edit")
  50   (autoload 'widget-browse "wid-browse" nil t)
  51   (autoload 'widget-browse-at "wid-browse" nil t))
  52
  53 (defun define-widget (name class doc &rest args)
  54   "Define a new widget type named NAME from CLASS.
  55
  56 NAME and CLASS should both be symbols, CLASS should be one of the
  57 existing widget types, or nil to create the widget from scratch.
  58
  59 After the new widget has been defined, the following two calls will
  60 create identical widgets:
  61
  62 * (widget-create NAME)
  63
  64 * (apply 'widget-create CLASS ARGS)
  65
  66 The third argument DOC is a documentation string for the widget."
  67   (put name 'widget-type (cons class args))
  68   (put name 'widget-documentation doc))
  69
  70 ;;; The End.
  71
  72 (provide 'widget)
  73
  74 ;; widget.el ends here