changeset 69903:5b6c4153d145

(Buffer Contents): Add NOPROPS arg to filter-buffer-substring.
author Kim F. Storm <storm@cua.dk>
date Sun, 09 Apr 2006 23:05:07 +0000
parents eea8aee5048b
children 9b1e68fb87f9
files lispref/text.texi
diffstat 1 files changed, 7 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/lispref/text.texi	Sun Apr 09 23:04:33 2006 +0000
+++ b/lispref/text.texi	Sun Apr 09 23:05:07 2006 +0000
@@ -205,7 +205,7 @@
 properties, just the characters themselves.  @xref{Text Properties}.
 @end defun
 
-@defun filter-buffer-substring start end &optional delete
+@defun filter-buffer-substring start end &optional delete noprops
 This function passes the buffer text between @var{start} and @var{end}
 through the filter functions specified by the variable
 @code{buffer-substring-filters}, and returns the value from the last
@@ -217,7 +217,12 @@
 between @var{start} and @var{end} after copying it, like
 @code{delete-and-extract-region}.
 
-Lisp code should use this function instead of @code{buffer-substring}
+If @var{noprops} is non-@code{nil}, the final string returned does not
+include text properties, while the string passed through the filters
+still includes text properties from the buffer text.
+
+Lisp code should use this function instead of @code{buffer-substring},
+@code{buffer-substring-no-properties},
 or @code{delete-and-extract-region} when copying into user-accessible
 data structures such as the kill-ring, X clipboard, and registers.
 Major and minor modes can add functions to