racket/collects/scribblings/gui/prefs.scrbl
Matthew Flatt 98822cf1f9 adjust `racket/gui' and dependencies to survive a locked preference file
- adds a `#:timeout-lock-there' argument to `get-preference'
 - fixes preference looup in `racket/gui'
 - make preference names consistently use `GRacket' and consistently
   fall back on `MrEd' names
 - fix Emacs-style undo mode while we're at it
2011-01-18 17:37:33 -07:00

58 lines
2.2 KiB
Racket

#lang scribble/doc
@(require "common.ss"
(for-label scheme/file))
@title[#:tag "mredprefs"]{Preferences}
The @racketmodname[racket/gui/base] library supports a number of preferences for global configuration. The
preferences are stored in the common file reported by
@scheme[find-system-path] for @indexed-scheme['pref-file], and
preference values can be retrieved and changed through
@scheme[get-preference] and @scheme[put-preferences]. Except for the except the
@Resource{playcmd} preference, the @racketmodname[racket/gui/base] library
reads each of the preferences below once at startup.
@emph{Beware:} The preferences file is read in case-insensitive mode (for
historical reasons), so the symbols listed below must be surrounded with
@litchar{|}.
The following are the preference names used by GRacket:
@itemize[
@item{@ResourceFirst{default-font-size} --- sets the default font size
the basic style in a style list, and thus the default font size for
an editor.}
@item{@ResourceFirst{defaultMenuPrefix} --- sets the prefix used by
default for menu item shortcuts under X, one of @scheme['ctl],
@scheme['meta], or @scheme['alt]. The default is
@scheme['ctl]. When this preference is set to @scheme['meta] or
@scheme['alt], underlined mnemonics (introduced by @litchar{&} in menu
labels) are suppressed.}
@item{@ResourceFirst{emacs-undo} --- a true value makes undo in
editors work as in Emacs (i.e., undo operations are themselves kept
in the undo stack).}
@item{@ResourceFirst{wheelStep} --- sets the default mouse-wheel step
size of @scheme[editor-canvas%] objects.}
@item{@ResourceFirst{outline-inactive-selection} --- a true value
causes selections in text editors to be shown with an outline of the
selected region when the editor does no have the keyboard focus.}
@item{@ResourceFirst{playcmd} --- used to format a sound-playing
command; see @scheme[play-sound] for details.}
@item{@ResourceFirst{doubleClickTime} --- overrides the
platform-specific default interval (in milliseconds) for double-click
events.}
]
In each of the above cases, if no preference value is found using the
@schemeidfont{GRacket}-prefixed name, a @schemeidfont{MrEd}-prefixed
name is tried for backward compatibility.