rackety framework and tools docs
original commit: 6563ef6812bfc2ea8921165d12cb78e74dca4626
This commit is contained in:
Matthew Flatt
parent
36405c90a5
commit
edff96857f
|
|
@ -247,7 +247,7 @@
|
|||
(-> void?)
|
||||
()
|
||||
@{Adds a preferences panel for configuring options related to
|
||||
Scheme.})
|
||||
Racket.})
|
||||
|
||||
(proc-doc/names
|
||||
preferences:add-to-warnings-checkbox-panel
|
||||
|
|
@ -261,7 +261,7 @@
|
|||
(((is-a?/c vertical-panel%) . -> . void?) . -> . void?)
|
||||
(proc)
|
||||
@{Saves @scheme[proc] until the preferences panel is created, when it
|
||||
is called with the Scheme preferences panel to add new children to
|
||||
is called with the Racket preferences panel to add new children to
|
||||
the panel.})
|
||||
|
||||
(proc-doc/names
|
||||
|
|
@ -1343,14 +1343,14 @@
|
|||
scheme:get-keymap
|
||||
(-> (is-a?/c keymap%))
|
||||
()
|
||||
@{Returns a keymap with binding suitable for Scheme.})
|
||||
@{Returns a keymap with binding suitable for Racket.})
|
||||
|
||||
(proc-doc/names
|
||||
scheme:add-coloring-preferences-panel
|
||||
(-> any)
|
||||
()
|
||||
@{
|
||||
Installs the ``Scheme'' preferences panel in the ``Syntax Coloring''
|
||||
Installs the ``Racket'' preferences panel in the ``Syntax Coloring''
|
||||
section.})
|
||||
|
||||
(proc-doc/names
|
||||
|
|
@ -1359,7 +1359,7 @@
|
|||
()
|
||||
@{Returns
|
||||
a table mapping from symbols
|
||||
(naming the categories that the online colorer uses for Scheme mode coloring) to their colors.
|
||||
(naming the categories that the online colorer uses for Racket mode coloring) to their colors.
|
||||
|
||||
These symbols are suitable for input to
|
||||
@scheme[scheme:short-sym->pref-name] and
|
||||
|
|
@ -1373,7 +1373,7 @@
|
|||
()
|
||||
@{Returns
|
||||
a table mapping from symbols
|
||||
(naming the categories that the online colorer uses for Scheme mode coloring) to their colors when
|
||||
(naming the categories that the online colorer uses for Racket mode coloring) to their colors when
|
||||
the user chooses the white-on-black mode in the preferences dialog.
|
||||
|
||||
See also @scheme[scheme:get-color-prefs-table].})
|
||||
|
|
@ -1399,7 +1399,7 @@
|
|||
(-> (is-a?/c editor-wordbreak-map%))
|
||||
()
|
||||
@{This method returns a @scheme[editor-wordbreak-map%] that is suitable
|
||||
for Scheme.})
|
||||
for Racket.})
|
||||
|
||||
(proc-doc/names
|
||||
scheme:init-wordbreak-map
|
||||
|
|
@ -1411,7 +1411,7 @@
|
|||
scheme:setup-keymap
|
||||
((is-a?/c keymap%) . -> . void?)
|
||||
(keymap)
|
||||
@{Initializes @scheme[keymap] with Scheme-mode keybindings.})
|
||||
@{Initializes @scheme[keymap] with Racket-mode keybindings.})
|
||||
|
||||
(proc-doc/names
|
||||
editor:set-default-font-color
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
|
||||
@defclass[comment-box:snip% editor-snip:decorated% (readable-snip<%>)]{
|
||||
This snip implements the comment boxes that you see in
|
||||
DrScheme.
|
||||
DrRacket.
|
||||
|
||||
@defmethod*[#:mode override (((make-editor) (is-a?/c text%)))]{
|
||||
|
||||
|
|
|
|||
|
|
@ -79,7 +79,7 @@
|
|||
Typically, this method is called when the frame
|
||||
containing the editor is closed, but in some cases an
|
||||
editor is considered ``closed'' before the frame it is
|
||||
in is closed (eg, when a tab in DrScheme is closed), and
|
||||
in is closed (e.g., when a tab in DrRacket is closed), and
|
||||
thus @method[editor:basic<%> on-close] will be called at that point.
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -161,7 +161,7 @@
|
|||
Calls
|
||||
@scheme[exit:on-exit]
|
||||
and then queues a callback
|
||||
to call MzScheme's @scheme[exit]
|
||||
to call Racket's @scheme[exit]
|
||||
function. If that returns, it
|
||||
calls
|
||||
@scheme[exit:set-exiting]
|
||||
|
|
|
|||
|
|
@ -1,85 +1,85 @@
|
|||
#lang scribble/doc
|
||||
|
||||
@(require (for-label framework scheme/gui))
|
||||
@(require (for-label framework racket/gui))
|
||||
@(require scribble/manual)
|
||||
|
||||
@title{@bold{Framework}: PLT GUI Application Framework}
|
||||
@title{@bold{Framework}: Racket GUI Application Framework}
|
||||
@(defmodule framework)
|
||||
|
||||
@author["Robert Bruce Findler" "Matthew Flatt"]
|
||||
|
||||
The framework provides a number of mixins, classes and
|
||||
functions designed to help you build a complete application
|
||||
program on top of the @scheme[scheme/gui] library.
|
||||
program on top of the @racket[racket/gui] library.
|
||||
|
||||
@itemize[
|
||||
@item{@bold{Entire Framework}
|
||||
|
||||
@itemize[
|
||||
|
||||
@item{@scheme[(require @#,schememodname[framework])]
|
||||
@item{@racket[(require @#,racketmodname[framework])]
|
||||
|
||||
This library provides all of the definitions and syntax
|
||||
described in this manual.
|
||||
}
|
||||
@item{@scheme[(require framework/framework-sig)]
|
||||
@item{@racket[(require framework/framework-sig)]
|
||||
|
||||
This library provides the signature definitions:
|
||||
@scheme[framework^], and
|
||||
@scheme[framework-class^].
|
||||
The @scheme[framework^] signature contains all of the
|
||||
@racket[framework^], and
|
||||
@racket[framework-class^].
|
||||
The @racket[framework^] signature contains all of the
|
||||
names of the procedures described in this manual, except
|
||||
those that begin with @scheme[test:] and
|
||||
@scheme[gui-utils:]. The @scheme[framework-class^]
|
||||
those that begin with @racket[test:] and
|
||||
@racket[gui-utils:]. The @racket[framework-class^]
|
||||
signature contains all of the classes defined in this
|
||||
manual.
|
||||
}
|
||||
@item{@scheme[(require framework/framework-unit)]
|
||||
@item{@racket[(require framework/framework-unit)]
|
||||
|
||||
This library provides one
|
||||
@scheme[unit/sig]: @scheme[framework@]. It exports the signature
|
||||
@scheme[framework^]. It imports the @scheme[mred^] signature.
|
||||
@racket[unit/sig]: @racket[framework@]. It exports the signature
|
||||
@racket[framework^]. It imports the @racket[mred^] signature.
|
||||
|
||||
}
|
||||
]}
|
||||
@item{
|
||||
@bold{Test Suite Engine}
|
||||
|
||||
@scheme[(require @#,schememodname[framework/test])]
|
||||
@racket[(require @#,racketmodname[framework/test])]
|
||||
|
||||
This library provides all of the definitions beginning with
|
||||
@scheme[test:] described in this manual.
|
||||
@racket[test:] described in this manual.
|
||||
}
|
||||
@item{ @bold{GUI Utilities}
|
||||
@scheme[(require @#,schememodname[framework/gui-utils])]
|
||||
@racket[(require @#,racketmodname[framework/gui-utils])]
|
||||
|
||||
This libraries provides all of the definitions beginning
|
||||
with @scheme[gui-utils:] described in this manual.
|
||||
with @racket[gui-utils:] described in this manual.
|
||||
}
|
||||
@item{ @bold{Preferences}
|
||||
@scheme[(require @#,schememodname[framework/preferences])]
|
||||
@racket[(require @#,racketmodname[framework/preferences])]
|
||||
|
||||
This library provides a subset of the names of the
|
||||
@tt{framework.ss} library, namely those for
|
||||
manipulating preference settings and is designed to be
|
||||
used from mzscheme.
|
||||
used from @exec{racket}.
|
||||
|
||||
The precise set of exported names is:
|
||||
@scheme[preferences:snapshot?],
|
||||
@scheme[preferences:restore-prefs-snapshot],
|
||||
@scheme[preferences:get-prefs-snapshot],
|
||||
@scheme[exn:make-unknown-preference],
|
||||
@scheme[exn:unknown-preference?],
|
||||
@scheme[preferences:low-level-put-preferences],
|
||||
@scheme[preferences:get],
|
||||
@scheme[preferences:set],
|
||||
@scheme[preferences:add-callback],
|
||||
@scheme[preferences:set-default],
|
||||
@scheme[preferences:set-un/marshall], and
|
||||
@scheme[preferences:restore-defaults].
|
||||
@racket[preferences:snapshot?],
|
||||
@racket[preferences:restore-prefs-snapshot],
|
||||
@racket[preferences:get-prefs-snapshot],
|
||||
@racket[exn:make-unknown-preference],
|
||||
@racket[exn:unknown-preference?],
|
||||
@racket[preferences:low-level-put-preferences],
|
||||
@racket[preferences:get],
|
||||
@racket[preferences:set],
|
||||
@racket[preferences:add-callback],
|
||||
@racket[preferences:set-default],
|
||||
@racket[preferences:set-un/marshall], and
|
||||
@racket[preferences:restore-defaults].
|
||||
}
|
||||
@item{@bold{Decorated Editor Snip}
|
||||
@scheme[(require framework/decorated-editor-snip)]
|
||||
@racket[(require framework/decorated-editor-snip)]
|
||||
|
||||
This library is here for backwards compatibility. The
|
||||
functionality in it has moved into the framework proper, in
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
@(require scribble/manual scribble/extract)
|
||||
@(require (for-label framework))
|
||||
@(require (for-label scheme/gui))
|
||||
@title{Scheme}
|
||||
@title{Racket}
|
||||
|
||||
@definterface[scheme:sexp-snip<%> ()]{
|
||||
@defmethod*[(((get-saved-snips) (listof snip%)))]{
|
||||
|
|
@ -35,7 +35,7 @@
|
|||
}
|
||||
}
|
||||
@definterface[scheme:text<%> (text:basic<%> mode:host-text<%> color:text<%>)]{
|
||||
Texts matching this interface support Scheme mode operations.
|
||||
Texts matching this interface support Racket mode operations.
|
||||
@defmethod*[(((get-limit (start exact-integer)) int))]{
|
||||
|
||||
Returns a limit for backward-matching parenthesis starting at position
|
||||
|
|
@ -225,7 +225,7 @@
|
|||
}
|
||||
}
|
||||
@defmixin[scheme:text-mixin (text:basic<%> mode:host-text<%> color:text<%> text:autocomplete<%>) (scheme:text<%>)]{
|
||||
This mixin adds functionality for editing Scheme files.
|
||||
This mixin adds functionality for editing Racket files.
|
||||
|
||||
The result of this mixin uses the same initialization arguments as the
|
||||
mixin's argument.
|
||||
|
|
@ -241,7 +241,7 @@
|
|||
implements this interface.
|
||||
}
|
||||
@defmixin[scheme:text-mode-mixin (color:text-mode<%> mode:surrogate-text<%>) (scheme:text-mode<%>)]{
|
||||
This mixin adds Scheme mode functionality
|
||||
This mixin adds Racket mode functionality
|
||||
to the mode that it is mixed into. The resulting
|
||||
mode assumes that it is only set to an editor
|
||||
that is the result of
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@
|
|||
|
||||
The framework provides several new primitive functions that simulate
|
||||
user actions, which may be used to test applications. You use these
|
||||
primitives and combine them just as regular MzScheme functions. For
|
||||
primitives and combine them just as regular Racket functions. For
|
||||
example,
|
||||
@schemeblock[
|
||||
(test:keystroke #\A)
|
||||
|
|
|
|||
|
|
@ -121,7 +121,7 @@
|
|||
|
||||
The result of this method is a symbol that identifies this
|
||||
editor and that is used as the port-name of a port that is
|
||||
read from this editor if this editor is used in DrScheme.
|
||||
read from this editor if this editor is used in DrRacket.
|
||||
See also
|
||||
@method[text:basic<%> port-name-matches?].
|
||||
}
|
||||
|
|
@ -345,7 +345,7 @@
|
|||
hits are coalesced into a single search results when
|
||||
bubbles are drawn. This means, for example, that searching
|
||||
for a space in a file with 80,000 spaces (as one file in
|
||||
the PLT Scheme code base has) is still tractable, since
|
||||
the Racket code base has) is still tractable, since
|
||||
many of those spaces will be next to each other and thus
|
||||
there will be far fewer bubbles (the file in question has
|
||||
only 20,000 such bubbles).
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user