clarify the use-file-text-mode method.

original commit: b52086ecae15a1e159f01969b2e651e3234f514d
This commit is contained in:
Robby Findler 2011-09-30 17:07:11 -05:00
parent eb943f394e
commit 089022da68

View File

@ -2395,13 +2395,19 @@ See also @method[editor<%> add-undo] .
@defmethod*[([(use-file-text-mode) boolean?]
[(use-file-text-mode [on? any/c]) void?])]{
Gets or sets whether the current platform's text mode is used for
writing files in @racket['text] or @racket['text-force-cr] mode, which
affects the way that newlines are written. The setting is consulted by
@method[editor<%> save-file] after @method[editor<%> on-save-file] is
called. See also @method[editor<%> load-file] for information on file
modes.
Gets or sets a boolean that controls if files are saved in
@racket['text] or @racket['binary] mode (as in @racket[open-input-file]'s
@racket[#:mode] argument). This flag is consulted only when the
format is @racket['text] or @racket['text-force-cr].
See @method[editor<%> load-file] for information on
formats.
The setting is consulted by
@method[editor<%> save-file] after @method[editor<%> on-save-file] is
called.
Overriding this method is a reliable way to detect changes to the internal
boolean.
}