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.90
   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   (`
  40    (eval-and-compile
  41      (let ((keywords (quote (, keys))))
  42        (while keywords
  43          (or (boundp (car keywords))
  44              (set (car keywords) (car keywords)))
  45          (setq keywords (cdr keywords)))))))
  46
  47 (define-widget-keywords :prompt-value :text-format :deactivate :active
  48   :inactive :activate :sibling-args :delete-button-args
  49   :insert-button-args :append-button-args :button-args
  50   :tag-glyph :off-glyph :on-glyph :valid-regexp
  51   :secret :sample-face :sample-face-get :case-fold :widget-doc
  52   :create :convert-widget :format :value-create :offset :extra-offset
  53   :tag :doc :from :to :args :value :value-from :value-to :action
  54   :value-set :value-delete :match :parent :delete :menu-tag-get
  55   :value-get :choice :void :menu-tag :on :off :on-type :off-type
  56   :notify :entry-format :button :children :buttons :insert-before
  57   :delete-at :format-handler :widget :value-pos :value-to-internal
  58   :indent :size :value-to-external :validate :error :directory
  59   :must-match :type-error :value-inline :inline :match-inline :greedy
  60   :button-face-get :button-face :value-face :keymap :entry-from
  61   :entry-to :help-echo :documentation-property :hide-front-space
  62   :hide-rear-space :tab-order)
  63
  64 ;; These autoloads should be deleted when the file is added to Emacs.
  65 (unless (fboundp 'load-gc)
  66   (autoload 'widget-apply "wid-edit")
  67   (autoload 'widget-create "wid-edit")
  68   (autoload 'widget-insert "wid-edit")
  69   (autoload 'widget-prompt-value "wid-edit")
  70   (autoload 'widget-browse "wid-browse" nil t)
  71   (autoload 'widget-browse-other-window "wid-browse" nil t)
  72   (autoload 'widget-browse-at "wid-browse" nil t)
  73   (autoload 'widget-minor-mode "wid-browse" nil t))
  74
  75 (defun define-widget (name class doc &rest args)
  76   "Define a new widget type named NAME from CLASS.
  77
  78 NAME and CLASS should both be symbols, CLASS should be one of the
  79 existing widget types, or nil to create the widget from scratch.
  80
  81 After the new widget has been defined, the following two calls will
  82 create identical widgets:
  83
  84 * (widget-create NAME)
  85
  86 * (apply 'widget-create CLASS ARGS)
  87
  88 The third argument DOC is a documentation string for the widget."
  89   (put name 'widget-type (cons class args))
  90   (put name 'widget-documentation doc)
  91   name)
  92
  93 ;;; The End.
  94
  95 (provide 'widget)
  96
  97 ;; widget.el ends here