Function: define-widget

define-widget is a byte-compiled function defined in widget.el.gz.

Signature

(define-widget NAME CLASS DOC &rest ARGS)

Documentation

Define a new widget type named NAME from CLASS.

NAME and CLASS should both be symbols, CLASS should be one of the existing widget types, or nil to create the widget from scratch.

After the new widget has been defined, the following two calls will create identical widgets:

* (widget-create NAME)

* (apply #'widget-create CLASS ARGS)

The third argument DOC is a documentation string for the widget.

Source Code

;; Defined in /usr/src/emacs/lisp/widget.el.gz
;;(define-widget-keywords :documentation-indent
;;  :complete-function :complete :button-overlay
;;  :field-overlay
;;  :documentation-shown :button-prefix
;;  :button-suffix :mouse-down-action :glyph-up :glyph-down :glyph-inactive
;;  :prompt-internal :prompt-history :prompt-match
;;  :prompt-value  :deactivate :active
;;  :inactive :activate :sibling-args :delete-button-args
;;  :insert-button-args :append-button-args :button-args
;;  :tag-glyph :off-glyph :on-glyph :valid-regexp
;;  :secret :sample-face :sample-face-get :case-fold
;;  :create :convert-widget :format :value-create :offset :extra-offset
;;  :tag :doc :from :to :args :value :action
;;  :value-set :value-delete :match :parent :delete :menu-tag-get
;;  :value-get :choice :void :menu-tag :on :off :on-type :off-type
;;  :notify :entry-format :button :children :buttons :insert-before
;;  :delete-at :format-handler :widget :value-pos :value-to-internal
;;  :indent :size :value-to-external :validate :error :directory
;;  :must-match :type-error :value-inline :inline :match-inline :greedy
;;  :button-face-get :button-face :value-face :keymap :entry-from
;;  :entry-to :help-echo :documentation-property :tab-order)

(defun define-widget (name class doc &rest args)
  "Define a new widget type named NAME from CLASS.

NAME and CLASS should both be symbols, CLASS should be one of the
existing widget types, or nil to create the widget from scratch.

After the new widget has been defined, the following two calls will
create identical widgets:

* (widget-create NAME)

* (apply #\\='widget-create CLASS ARGS)

The third argument DOC is a documentation string for the widget."
  (declare (doc-string 3))
  ;;
  (unless (or (null doc) (stringp doc))
    (error "Widget documentation must be nil or a string"))
  (put name 'widget-type (cons class args))
  (put name 'widget-documentation (purecopy doc))
  name)