From 26a92b1cfe108133a194d74279305e71ef185488 Mon Sep 17 00:00:00 2001 From: Matthew Flatt Date: Sun, 2 May 2010 11:29:45 -0600 Subject: [PATCH] rackety racket/gui doc --- collects/scribblings/gui/dc-intf.scrbl | 2 +- collects/scribblings/gui/draw-overview.scrbl | 10 ++-- collects/scribblings/gui/dynamic.scrbl | 6 +-- collects/scribblings/gui/editor-funcs.scrbl | 2 +- .../scribblings/gui/editor-overview.scrbl | 2 +- collects/scribblings/gui/font-config.scrbl | 48 +++++++++---------- collects/scribblings/gui/gui.scrbl | 10 ++-- collects/scribblings/gui/miscwin-funcs.scrbl | 2 +- collects/scribblings/gui/prefs.scrbl | 10 ++-- collects/scribblings/gui/win-overview.scrbl | 2 +- 10 files changed, 47 insertions(+), 47 deletions(-) diff --git a/collects/scribblings/gui/dc-intf.scrbl b/collects/scribblings/gui/dc-intf.scrbl index b5b8e56663..18da704a55 100644 --- a/collects/scribblings/gui/dc-intf.scrbl +++ b/collects/scribblings/gui/dc-intf.scrbl @@ -832,7 +832,7 @@ Enables or disables anti-aliased smoothing of lines, curves, Smoothing is supported under Windows only when Microsoft's @filepath{gdiplus.dll} is installed (which is always the case for Windows XP). Smoothing is supported under Mac OS X always. Smoothing is - supported under X only when Cairo is installed when MrEd is compiled. + supported under X only when Cairo is installed when GRacket is compiled. Smoothing is never supported for black-and-white contexts. Smoothing is always supported (and cannot be disabled) for PostScript output. diff --git a/collects/scribblings/gui/draw-overview.scrbl b/collects/scribblings/gui/draw-overview.scrbl index 8889f43af7..61dd80e3ae 100644 --- a/collects/scribblings/gui/draw-overview.scrbl +++ b/collects/scribblings/gui/draw-overview.scrbl @@ -5,7 +5,7 @@ @title[#:tag "drawing-overview"]{Drawing} -Drawing in PLT Scheme requires a @deftech{device context} +Drawing in Racket requires a @deftech{device context} (@deftech{DC}), which is an instance of the @scheme[dc<%>] interface. For example, the @method[canvas<%> get-dc] method of a canvas returns a @scheme[dc<%>] instance for drawing into the canvas @@ -153,12 +153,12 @@ For all types of DCs, the drawing origin is the top-left corner of the initially correspond to points (1/72 of an inch). More complex shapes are typically best implemented with - @deftech{paths}. The following example uses paths to draw the PLT - Scheme logo. It also enables smoothing, so that the logo's curves are + @deftech{paths}. The following example uses paths to draw the + Racket logo. It also enables smoothing, so that the logo's curves are anti-aliased when smoothing is available. (Smoothing is always available under Mac OS X, smoothing is available under Windows XP or when @filepath{gdiplus.dll} is installed, and smoothing is available - under X when Cairo is installed before MrEd is compiled.) + under X when Cairo is installed before GRacket is compiled.) @(begin #readerscribble/comment-reader @@ -249,7 +249,7 @@ More complex shapes are typically best implemented with (send dc #,(:: dc<%> draw-path) right-logo-path)) ;; Create a frame to display the logo on a light-purple background: -(define f (new frame% [label "PLT Logo"])) +(define f (new frame% [label "Racket Logo"])) (define c (new canvas% [parent f] diff --git a/collects/scribblings/gui/dynamic.scrbl b/collects/scribblings/gui/dynamic.scrbl index 3f4eab8421..b0f35c3f6b 100644 --- a/collects/scribblings/gui/dynamic.scrbl +++ b/collects/scribblings/gui/dynamic.scrbl @@ -5,7 +5,7 @@ @title{Dynamic Loading} @defmodule[racket/gui/dynamic]{The @racketmodname[racket/gui/dynamic] -library provides functions for dynamically accessing the PLT Racket +library provides functions for dynamically accessing the Racket GUI toolbox, instead of directly requiring @racket[racket/gui] or @racket[racket/gui/base].} @@ -13,8 +13,8 @@ GUI toolbox, instead of directly requiring @racket[racket/gui] or Returns @racket[#t] if dynamic access to the GUI bindings are available---that is, that the program is being run as a -@exec{mred}-based application, as opposed to a pure -@exec{mzracket}-based application, and that GUI modules are attached +GRacket-based application, as opposed to a pure +Racket-based application, and that GUI modules are attached to the namespace in which @racket[racket/gui/dynamic] was instantiated. diff --git a/collects/scribblings/gui/editor-funcs.scrbl b/collects/scribblings/gui/editor-funcs.scrbl index a735ade7a3..cb815dd9fc 100644 --- a/collects/scribblings/gui/editor-funcs.scrbl +++ b/collects/scribblings/gui/editor-funcs.scrbl @@ -351,7 +351,7 @@ This procedure is a load handler for use with @scheme[current-load]. The handler recognizes PLT Scheme editor-format files (see @secref["editorfileformat"]) and decodes them for loading. It is - normally installed as MrEd starts (see @secref[#:doc reference-doc + normally installed as GRacket starts (see @secref[#:doc reference-doc "running-sa"]). The handler recognizes editor files by the first twelve characters of diff --git a/collects/scribblings/gui/editor-overview.scrbl b/collects/scribblings/gui/editor-overview.scrbl index b6b6e253ad..7bfd5d6056 100644 --- a/collects/scribblings/gui/editor-overview.scrbl +++ b/collects/scribblings/gui/editor-overview.scrbl @@ -360,7 +360,7 @@ Editor data is read and written using @scheme[editor-stream-in%] and @scheme[write-editor-global-footer]. Similarly, reading editors from a stream is initialized with @scheme[read-editor-global-header] and finalized with @scheme[read-editor-global-footer]. Optionally, to - support streams that span versions of PLT Scheme, use + support streams that span versions of Racket, use @scheme[write-editor-version] and @scheme[read-editor-version] before the header operations. diff --git a/collects/scribblings/gui/font-config.scrbl b/collects/scribblings/gui/font-config.scrbl index f387b8f51f..02bcf9de8e 100644 --- a/collects/scribblings/gui/font-config.scrbl +++ b/collects/scribblings/gui/font-config.scrbl @@ -10,17 +10,17 @@ This chapter describes how to set up face mappings for screen and especially complex X font mappings before fontconfig/Xft solved the problem. -An implementor for a MrEd-based program may find it easier to use the +An implementor for a GRacket-based program may find it easier to use the @method[font-name-directory<%> set-screen-name] and @method[font-name-directory<%> set-post-script-name] methods provided by @scheme[the-font-name-directory]. As a user of a - MrEd-based program, preferences provide a mechanism for setting + GRacket-based program, preferences provide a mechanism for setting default mappings. Whether a programmer or a user, see @scheme[font-name-directory<%>] for an overview of the font mapping system. -To find a font name for a family, MrEd looks for a preference name by +To find a font name for a family, GRacket looks for a preference name by concatenating @litchar{MrEd:}, a @nonterm{dest}, a @nonterm{type}, a @nonterm{weight}, and a @nonterm{style}, where @@ -55,7 +55,7 @@ The value of the preference is parsed as described in Building items names by concatenating @nonterm{dest}, @nonterm{type}, @nonterm{weight}, and @nonterm{style} can create a large number of preference entries, and the @nonterm{weight} and @nonterm{style} parts are useful only - for X screen fonts. To avoid an explosion of preferences, MrEd finds + for X screen fonts. To avoid an explosion of preferences, GRacket finds preferences via a wildcarding search. The @nonterm{type}, @nonterm{weight}, and @nonterm{style} parts of a preference name @@ -72,7 +72,7 @@ Wildcarded preference entries are used only when un-wildcarded values then the one with the ``earliest'' (i.e., closest to the beginning of the preference name) non-wildcarded part will prevail. -The default MrEd preferences for Windows uses wildcarding to specify +The default GRacket preferences for Windows uses wildcarding to specify the basic font mapping, as if written as: @schemeblock[ @@ -99,7 +99,7 @@ Suppose we define the mapping for variants of @scheme["Default"], and (|MrEd:ScreenRoman__| "+-*-*-medium-r-normal-*-*-%d-*-*-*-*-*-*") ] -but the MrEd font-reading system provides a better syntax for +but the GRacket font-reading system provides a better syntax for referencing another preference entry. When a preference value contains @litchar{${x}}, then the @litchar{${x}} fragment is replaced by the preference value of @litchar{x}. Thus, the above can be re-written: @@ -180,19 +180,19 @@ Wildcarding can be specified in a reference by separating each ] Since @litchar{$[weight]} is between commas, it can be wildcarded if - no name exactly matching @litchar{SchemeDefault$[weight]_} is - found. In this case @litchar{SchemeDefault} and @litchar{_} can + no name exactly matching @litchar{ScreenDefault$[weight]_} is + found. In this case @litchar{ScreenDefault} and @litchar{_} can also be wildcarded, but this will have no effect. The wildcarding used in references need not reflect the wildcarding - MrEd initial uses for finding fonts. In other words, a number of + GRacket initial uses for finding fonts. In other words, a number of comma-separated selects can appear between the curly braces. @; ------------------------------------------------------------------------ @section{Internal Preferences} -The initial font setup is built into MrEd through a built-in preference +The initial font setup is built into GRacket through a built-in preference table. The table is shown at the end of this section. When font information is computed, it is @italic{almost} as if this table were installed into your preferences file; the difference is that preference @@ -201,8 +201,8 @@ The initial font setup is built into MrEd through a built-in preference match. When no information is available for mapping a face name to a font, - MrEd falls back to the system described in - @scheme[font-name-directory<%>]. (Since a mapping is built into MrEd + GRacket falls back to the system described in + @scheme[font-name-directory<%>]. (Since a mapping is built into GRacket for every family, information is always available for the default font of a family.) @@ -327,12 +327,12 @@ Internal preferences for Mac OS X only: @section-index["CID"] @section-index["CMap"] -To generate PostScript output, MrEd must be able to find an @|AFM| +To generate PostScript output, GRacket must be able to find an @|AFM| (AFM) file corresponding to the PostScript font. An AFM file typically uses the suffix @indexed-file{.afm}, and several AFM files - are distributed with MrEd in the @filepath{afm} collection. + are distributed with GRacket in the @filepath{afm} collection. -MrEd finds an AFM file by adding a @filepath{.afm} suffix to the +GRacket finds an AFM file by adding a @filepath{.afm} suffix to the PostScript name of the font, and checking all directories specified by the @scheme[current-ps-afm-file-paths] parameter. The initial value of this parameter is determined by the @@ -343,43 +343,43 @@ MrEd finds an AFM file by adding a @filepath{.afm} suffix to the Depending on whether the font is CID-based (typically for the Chinese, Japanese, Korean, and Vietnamese language families, and as indicated - in the AFM file), MrEd must find additional files: + in the AFM file), GRacket must find additional files: @itemize[ @item{@italic{Non-CID:} In addition to an AFM file - @filepath{@nonterm{x}.afm}, MrEd looks for a + @filepath{@nonterm{x}.afm}, GRacket looks for a @filepath{@nonterm{x}-glyphlist.txt} file (in the same directory as the AFM file) to map glyph names in the AFM file to Unicode character - values. In addition to this font-specific file, MrEd looks for a + values. In addition to this font-specific file, GRacket looks for a @indexed-file{glyphlist.txt} file to supply a mapping for Adobe's standard glyph names, and this mapping is used when a font-specific mapping is not supplied, or when the mapping does not cover a name - found in the AFM file. MrEd looks for @filepath{glyphlist.txt} in the + found in the AFM file. GRacket looks for @filepath{glyphlist.txt} in the same place as AFM files. Since @filepath{glyphlist.txt} is large, if a @indexed-file{glyphshortlist.txt} file is available, it is read first, and then @filepath{glyphlist.txt} is read only if a character name must be resolved that is not in @filepath{glyphshortlist.txt}.} - @item{@italic{CID:} In addition to an AFM file, MrEd must find and + @item{@italic{CID:} In addition to an AFM file, GRacket must find and read CMap files to convert glyph IDs for the font to Unicode characters. The character set name is used as the name of the CMap - file to load, and MrEd checks all directories specified by the + file to load, and GRacket checks all directories specified by the @scheme[current-ps-cmap-file-paths] parameter. The initial value of this parameter is determined by the @indexed-envvar{PLTCMAPPATHS} environment variable; the environment variable's setting is parsed with @scheme[path-list-string->path-list] using @scheme[(list (collection-path "afm" "CMap"))] as the default list. In addition to - a CMap file for the font's character set, MrEd must find a + a CMap file for the font's character set, GRacket must find a @indexed-file{UniCNS-UTF32-H} CMap file to complete the mapping to - Unicode. MrEd automatically adds the font's character set to the font + Unicode. GRacket automatically adds the font's character set to the font name when producing PostScript with a CID-based font.} ] When drawing or measuring text using a particular PostScript font, if the font does not contain a glyph for a character (or if a relevant - AFM file cannot be found for the font), then MrEd attempts to + AFM file cannot be found for the font), then GRacket attempts to substitute another PostScript font. A substitute font is selected by checking all @filepath{.afm} files in the directories specified by @scheme[current-ps-afm-file-paths] (in order), and choosing the diff --git a/collects/scribblings/gui/gui.scrbl b/collects/scribblings/gui/gui.scrbl index 30d2b000c0..707b101721 100644 --- a/collects/scribblings/gui/gui.scrbl +++ b/collects/scribblings/gui/gui.scrbl @@ -1,20 +1,20 @@ #lang scribble/doc @(require "common.ss") -@title{@bold{GUI}: PLT Graphics Toolkit} +@title{@bold{GUI}: Racket Graphics Toolkit} @author["Matthew Flatt" "Robert Bruce Findler" "John Clements"] @declare-exporting[racket/gui/base racket/gui #:use-sources (mred)] -This reference manual describes the GUI toolbox that is part of PLT - Racket and whose core is implemented by the MrEd executable. +This reference manual describes the GUI toolbox that is part of Racket + and whose core is implemented by the GRacket executable. @defmodule*/no-declare[(racket/gui/base)]{The @racketmodname[racket/gui/base] library provides all of the class, interface, and procedure bindings defined in this manual. At run time, -this library needs primitive graphics support that the MrEd executable -provides; this library cannot run in MzRacket.} +this library needs primitive graphics support that the GRacket executable +provides; this library cannot run inside the Racket executable.} @defmodulelang*/no-declare[(racket/gui)]{The @racketmodname[racket/gui] language combines all bindings of the diff --git a/collects/scribblings/gui/miscwin-funcs.scrbl b/collects/scribblings/gui/miscwin-funcs.scrbl index 897a3600fa..480a8a146b 100644 --- a/collects/scribblings/gui/miscwin-funcs.scrbl +++ b/collects/scribblings/gui/miscwin-funcs.scrbl @@ -100,7 +100,7 @@ The result depends on @scheme[what], and a @scheme[#f] result is only @item{@scheme['x-display] returns a ``path'' whose string identifies the X display if specified by either the @Flag{display} flag or the - @envvar{DISPLAY} environment variable when MrEd starts under X. For + @envvar{DISPLAY} environment variable when GRacket starts under X. For other platforms, or when neither @Flag{display} nor @envvar{DISPLAY} was specified, the result is @scheme[#f].} diff --git a/collects/scribblings/gui/prefs.scrbl b/collects/scribblings/gui/prefs.scrbl index a469d098dd..0bc678659a 100644 --- a/collects/scribblings/gui/prefs.scrbl +++ b/collects/scribblings/gui/prefs.scrbl @@ -4,15 +4,15 @@ @title[#:tag "mredprefs"]{Preferences} -MrEd supports a number of preferences for global configuration. The - MrEd preferences are stored in the common file reported by +GRacket supports a number of preferences for global configuration. The + GRacket 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]. However, MrEd + @scheme[get-preference] and @scheme[put-preferences]. However, GRacket reads most preferences once at startup (all except the @Resource{playcmd}). -The following are the (case-sensitive) preference names used by MrEd: +The following are the (case-sensitive) preference names used by GRacket: @itemize[ @@ -62,7 +62,7 @@ The following are the (case-sensitive) preference names used by MrEd: command; see @scheme[play-sound] for details.} @item{@ResourceFirst{forceFocus} --- a true value enables extra - effort in MrEd to move the focus to a top-level window that is shown + effort in GRacket to move the focus to a top-level window that is shown or raised.} @item{@ResourceFirst{doubleClickTime} --- overrides the diff --git a/collects/scribblings/gui/win-overview.scrbl b/collects/scribblings/gui/win-overview.scrbl index 674db7241d..1b632b55a4 100644 --- a/collects/scribblings/gui/win-overview.scrbl +++ b/collects/scribblings/gui/win-overview.scrbl @@ -5,7 +5,7 @@ @title[#:tag "windowing-overview"]{Windowing} -The PLT Scheme windowing toolbox provides the basic building blocks of GUI +The Racket windowing toolbox provides the basic building blocks of GUI programs, including frames (top-level windows), modal dialogs, menus, buttons, check boxes, text fields, and radio buttons. The toolbox provides these building blocks via built-in classes, such as the