diff options
| author | Miles Bader | 2001-10-14 15:16:57 +0000 |
|---|---|---|
| committer | Miles Bader | 2001-10-14 15:16:57 +0000 |
| commit | ecdbe16a1f6d0f6002cb0dc2a5659ef98c0e970b (patch) | |
| tree | 1cc9ae4bc6c3927833f7cbac1ea57709b734234f /lisp/button.el | |
| parent | 530893b26e86568f496415bead915d089469d3aa (diff) | |
| download | emacs-ecdbe16a1f6d0f6002cb0dc2a5659ef98c0e970b.tar.gz emacs-ecdbe16a1f6d0f6002cb0dc2a5659ef98c0e970b.zip | |
Doc fixes.
Diffstat (limited to 'lisp/button.el')
| -rw-r--r-- | lisp/button.el | 39 |
1 files changed, 22 insertions, 17 deletions
diff --git a/lisp/button.el b/lisp/button.el index c9f2cc4ad17..998d6390651 100644 --- a/lisp/button.el +++ b/lisp/button.el | |||
| @@ -113,12 +113,12 @@ Buttons inherit them by setting their `category' property to that symbol." | |||
| 113 | The remaining arguments form a sequence of PROPERTY VALUE pairs, | 113 | The remaining arguments form a sequence of PROPERTY VALUE pairs, |
| 114 | specifying properties to use as defaults for buttons with this type | 114 | specifying properties to use as defaults for buttons with this type |
| 115 | \(a button's type may be set by giving it a `type' property when | 115 | \(a button's type may be set by giving it a `type' property when |
| 116 | creating the button). | 116 | creating the button, using the :type keyword argument). |
| 117 | 117 | ||
| 118 | The property `supertype' may be used to specify a button-type from which | 118 | In addition, the keyword argument :supertype may be used to specify a |
| 119 | NAME inherits its default property values \(however, the inheritance | 119 | button-type from which NAME inherits its default property values |
| 120 | happens only when NAME is defined; subsequent changes to a supertype are | 120 | \(however, the inheritance happens only when NAME is defined; subsequent |
| 121 | not reflected in its subtypes)." | 121 | changes to a supertype are not reflected in its subtypes)." |
| 122 | (let* ((catsym (make-symbol (concat (symbol-name name) "-button"))) | 122 | (let* ((catsym (make-symbol (concat (symbol-name name) "-button"))) |
| 123 | (supertype | 123 | (supertype |
| 124 | (or (plist-get properties 'supertype) | 124 | (or (plist-get properties 'supertype) |
| @@ -220,6 +220,7 @@ the normal action is used instead." | |||
| 220 | (buffer-substring-no-properties (button-start button) (button-end button))) | 220 | (buffer-substring-no-properties (button-start button) (button-end button))) |
| 221 | 221 | ||
| 222 | (defsubst button-type (button) | 222 | (defsubst button-type (button) |
| 223 | "Return BUTTON's button-type." | ||
| 223 | (button-get button 'type)) | 224 | (button-get button 'type)) |
| 224 | 225 | ||
| 225 | (defun button-has-type-p (button type) | 226 | (defun button-has-type-p (button type) |
| @@ -233,9 +234,10 @@ the normal action is used instead." | |||
| 233 | (defun make-button (beg end &rest properties) | 234 | (defun make-button (beg end &rest properties) |
| 234 | "Make a button from BEG to END in the current buffer. | 235 | "Make a button from BEG to END in the current buffer. |
| 235 | The remaining arguments form a sequence of PROPERTY VALUE pairs, | 236 | The remaining arguments form a sequence of PROPERTY VALUE pairs, |
| 236 | specifying properties to add to the button. In particular, the `type' | 237 | specifying properties to add to the button. |
| 237 | property may be used to specify a button-type from which to inherit | 238 | In addition, the keyword argument :type may be used to specify a |
| 238 | other properties; see `define-button-type'. | 239 | button-type from which to inherit other properties; see |
| 240 | `define-button-type'. | ||
| 239 | 241 | ||
| 240 | Also see `make-text-button', `insert-button'." | 242 | Also see `make-text-button', `insert-button'." |
| 241 | (let ((overlay (make-overlay beg end nil t nil))) | 243 | (let ((overlay (make-overlay beg end nil t nil))) |
| @@ -254,9 +256,10 @@ Also see `make-text-button', `insert-button'." | |||
| 254 | (defun insert-button (label &rest properties) | 256 | (defun insert-button (label &rest properties) |
| 255 | "Insert a button with the label LABEL. | 257 | "Insert a button with the label LABEL. |
| 256 | The remaining arguments form a sequence of PROPERTY VALUE pairs, | 258 | The remaining arguments form a sequence of PROPERTY VALUE pairs, |
| 257 | specifying properties to add to the button. In particular, the `type' | 259 | specifying properties to add to the button. |
| 258 | property may be used to specify a button-type from which to inherit | 260 | In addition, the keyword argument :type may be used to specify a |
| 259 | other properties; see `define-button-type'. | 261 | button-type from which to inherit other properties; see |
| 262 | `define-button-type'. | ||
| 260 | 263 | ||
| 261 | Also see `insert-text-button', `make-button'." | 264 | Also see `insert-text-button', `make-button'." |
| 262 | (apply #'make-button | 265 | (apply #'make-button |
| @@ -271,9 +274,10 @@ Also see `insert-text-button', `make-button'." | |||
| 271 | (defun make-text-button (beg end &rest properties) | 274 | (defun make-text-button (beg end &rest properties) |
| 272 | "Make a button from BEG to END in the current buffer. | 275 | "Make a button from BEG to END in the current buffer. |
| 273 | The remaining arguments form a sequence of PROPERTY VALUE pairs, | 276 | The remaining arguments form a sequence of PROPERTY VALUE pairs, |
| 274 | specifying properties to add to the button. In particular, the `type' | 277 | specifying properties to add to the button. |
| 275 | property may be used to specify a button-type from which to inherit | 278 | In addition, the keyword argument :type may be used to specify a |
| 276 | other properties; see `define-button-type'. | 279 | button-type from which to inherit other properties; see |
| 280 | `define-button-type'. | ||
| 277 | 281 | ||
| 278 | This function is like `make-button', except that the button is actually | 282 | This function is like `make-button', except that the button is actually |
| 279 | part of the text instead of being a property of the buffer. Creating | 283 | part of the text instead of being a property of the buffer. Creating |
| @@ -306,9 +310,10 @@ Also see `insert-text-button'." | |||
| 306 | (defun insert-text-button (label &rest properties) | 310 | (defun insert-text-button (label &rest properties) |
| 307 | "Insert a button with the label LABEL. | 311 | "Insert a button with the label LABEL. |
| 308 | The remaining arguments form a sequence of PROPERTY VALUE pairs, | 312 | The remaining arguments form a sequence of PROPERTY VALUE pairs, |
| 309 | specifying properties to add to the button. In particular, the `type' | 313 | specifying properties to add to the button. |
| 310 | property may be used to specify a button-type from which to inherit | 314 | In addition, the keyword argument :type may be used to specify a |
| 311 | other properties; see `define-button-type'. | 315 | button-type from which to inherit other properties; see |
| 316 | `define-button-type'. | ||
| 312 | 317 | ||
| 313 | This function is like `insert-button', except that the button is | 318 | This function is like `insert-button', except that the button is |
| 314 | actually part of the text instead of being a property of the buffer. | 319 | actually part of the text instead of being a property of the buffer. |