Commit 16f2e9fc authored by Chong Yidong's avatar Chong Yidong
Browse files

* simple.el (region-active-p, use-region-p): Doc fix (Bug#3873).

parent a6c2c80c
2009-07-18 Chong Yidong <cyd@stupidchicken.com>
* simple.el (region-active-p, use-region-p): Doc fix (Bug#3873).
2009-07-18 Eli Zaretskii <eliz@gnu.org> 2009-07-18 Eli Zaretskii <eliz@gnu.org>
* desktop.el (desktop-buffers-not-to-save): Default value is nil. * desktop.el (desktop-buffers-not-to-save): Default value is nil.
......
...@@ -3559,23 +3559,25 @@ point otherwise." ...@@ -3559,23 +3559,25 @@ point otherwise."
(defun use-region-p () (defun use-region-p ()
"Return t if the region is active and it is appropriate to act on it. "Return t if the region is active and it is appropriate to act on it.
This is used by commands that act specially on the region under This is used by commands that act specially on the region under
Transient Mark mode. It returns t if and only if Transient Mark Transient Mark mode.
mode is enabled, the mark is active, and the region is non-empty.
If `use-empty-active-region' is non-nil, it returns t even if the
region is empty.
For some commands, it may be appropriate to disregard the value The return value is t provided Transient Mark mode is enabled and
of `use-empty-active-region'; in that case, use `region-active-p'." the mark is active; and, when `use-empty-active-region' is
non-nil, provided the region is empty. Otherwise, the return
value is nil.
For some commands, it may be appropriate to ignore the value of
`use-empty-active-region'; in that case, use `region-active-p'."
(and (region-active-p) (and (region-active-p)
(or use-empty-active-region (> (region-end) (region-beginning))))) (or use-empty-active-region (> (region-end) (region-beginning)))))
(defun region-active-p () (defun region-active-p ()
"Return t if Transient Mark mode is enabled and the mark is active. "Return t if Transient Mark mode is enabled and the mark is active.
Most commands that act on the region if it is active and Some commands act specially on the region when Transient Mark
Transient Mark mode is enabled, and on the text near point mode is enabled. Usually, such commands should use
otherwise, should use `use-region-p' instead. That function `use-region-p' instead of this function, because `use-region-p'
checks the value of `use-empty-active-region' as well." also checks the value of `use-empty-active-region'."
(and transient-mark-mode mark-active)) (and transient-mark-mode mark-active))
(defvar mark-ring nil (defvar mark-ring nil
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment