From 1eb4f0ffc1a2f1580f4515fcc6b3f17b32a793dc Mon Sep 17 00:00:00 2001 From: Robby Findler Date: Mon, 26 May 2008 23:27:30 +0000 Subject: [PATCH] rewrote lots of latexisms svn: r9967 --- collects/scribblings/framework/canvas.scrbl | 2 +- collects/scribblings/framework/color.scrbl | 80 ++- .../scribblings/framework/comment-box.scrbl | 14 +- collects/scribblings/framework/editor.scrbl | 67 +- collects/scribblings/framework/frame.scrbl | 641 +++++++++--------- collects/scribblings/framework/group.scrbl | 6 +- collects/scribblings/framework/keymap.scrbl | 4 +- collects/scribblings/framework/menu.scrbl | 4 +- collects/scribblings/framework/panel.scrbl | 20 +- collects/scribblings/framework/scheme.scrbl | 76 +-- collects/scribblings/framework/test.scrbl | 2 +- collects/scribblings/framework/text.scrbl | 117 ++-- 12 files changed, 507 insertions(+), 526 deletions(-) diff --git a/collects/scribblings/framework/canvas.scrbl b/collects/scribblings/framework/canvas.scrbl index 20ba0b885f..0b262ad4d8 100644 --- a/collects/scribblings/framework/canvas.scrbl +++ b/collects/scribblings/framework/canvas.scrbl @@ -14,7 +14,7 @@ Mixins that implement this interface initialize the background color of the canvas to the value of the \index{'framework:basic-canvas-background} - \scheme|'framework:basic-canvas-background| preference. + @scheme['framework:basic-canvas-background] preference. Adds a callback so that when that preference is modified, the background color changes. diff --git a/collects/scribblings/framework/color.scrbl b/collects/scribblings/framework/color.scrbl index 98a4ec6bc0..c9417bff69 100644 --- a/collects/scribblings/framework/color.scrbl +++ b/collects/scribblings/framework/color.scrbl @@ -16,60 +16,58 @@ and should return the style-name that the token should be colored. get-token takes an input port and returns the next token as 5 values: - \begin{enumerate} - \item + @itemize{ + @item{ An unused value. This value is intended to represent the textual - component of the token and may be used as such in the future. - \item + component of the token and may be used as such in the future.} + @item{ A symbol describing the type of the token. This symbol is transformed into a style-name via the token-sym->style argument. The symbols 'white-space and 'comment have special meaning and should always be returned for white space and comment tokens respectively. The symbol - 'no-color can be used to indicate that although the token is not white + @scheme['no-color] can be used to indicate that although the token is not white space, it should not be colored. The symbol 'eof must be used to - indicate when all the tokens have been consumed. - \item + indicate when all the tokens have been consumed.} + @item{ A symbol indicating how the token should be treated by the paren - matcher or \#f. This symbol should be in the pairs argument. - \item - The starting position of the token. - \item - The ending position of the token. - \end{enumerate} + matcher or @scheme[#f]. This symbol should be in the pairs argument.} + @item{ + The starting position of the token.} + @item{ + The ending position of the token.}} - get-token will usually be implemented with a lexer using the (lib - "lex.ss" "parser-tools") library.\\ + get-token will usually be implemented with a lexer using the + @scheme[parser-tools/lex] library. get-token must obey the following invariants: - \begin{itemize} - \item + @itemize{ + @item{ Every position in the buffer must be accounted for in exactly one - token. - \item + token.} + @item{ The token returned by get-token must rely only on the contents of the input port argument. This means that the tokenization of some part of - the input cannot depend on earlier parts of the input. - \item + the input cannot depend on earlier parts of the input.} + @item{ No edit to the buffer can change the tokenization of the buffer prior to the token immediately preceding the edit. In the following - example this invariant does not hold. If the buffer contains:\\ - " 1 2 3\\ + example this invariant does not hold. If the buffer contains: + @verbatim["\" 1 2 3"] and the tokenizer treats the unmatched " as its own token (a string error token), and separately tokenizes the 1 2 and 3, an edit to make - the buffer look like:\\ - " 1 2 3"\\ + the buffer look like: + @verbatim["\" 1 2 3\""] would result in a single string token modifying previous tokens. To handle these situations, get-token must treat the first line as a - single token. - \end{itemize} + single token.}} - pairs is a list of different kinds of matching parens. The second + @scheme[pairs] is a list of different kinds of matching parens. The second value returned by get-token is compared to this list to see how the paren matcher should treat the token. An example: Suppose pairs is - \scheme+'((|(| |)|) (|[| |]|) (begin end))+. This means that there + @scheme['((|(| |)|) (|[| |]|) (begin end))]. This means that there are three kinds of parens. Any token which has 'begin as its second return value will act as an open for matching tokens with 'end. - Similarly any token with \scheme+'|]|+ will act as a closing match for - tokens with \scheme+'|[|+. When trying to correct a mismatched + Similarly any token with @scheme['|]|] will act as a closing match for + tokens with @scheme['|[|]. When trying to correct a mismatched closing parenthesis, each closing symbol in pairs will be converted to a string and tried as a closing parenthesis. } @@ -112,11 +110,11 @@ Start coloring a frozen buffer again. - If recolor? is \scheme|#t|, the text is re-colored. If it is - \scheme|#f| the text is not recolored. When recolor? is \scheme|#t|, - retokenize? controls how the text is recolored. \scheme|#f| causes + If recolor? is @scheme[#t], the text is re-colored. If it is + @scheme[#f] the text is not recolored. When recolor? is @scheme[#t], + retokenize? controls how the text is recolored. @scheme[#f] causes the text to be entirely re-colored before thaw-colorer returns using - the existing tokenization. \scheme|#t| causes the entire text to be + the existing tokenization. @scheme[#t] causes the entire text to be retokenized and recolored from scratch. This will happen in the background after the call to thaw-colorer returns. @@ -127,7 +125,7 @@ } @defmethod*[(((reset-regions (regions (listof (list number (union (quote end) number))))) void))]{ - Sets the currently active regions to be \var{regions}. + Sets the currently active regions to be @scheme[regions]. } @defmethod*[(((get-regions) (listof (list number (union (quote end) number)))))]{ This returns the list of regions that are currently being colored in the editor. @@ -150,8 +148,8 @@ Skip all consecutive whitespaces and comments (using skip-whitespace) immediately preceding the position. If the token at this position is - a close, return the position of the matching open, or \scheme|#f| if - there is none. If the token was an open, return \scheme|#f|. For any + a close, return the position of the matching open, or @scheme[#f] if + there is none. If the token was an open, return @scheme[#f]. For any other token, return the start of that token. Must only be called while the tokenizer is started. @@ -159,7 +157,7 @@ @defmethod*[(((backward-containing-sexp (position natural-number?) (cutoff natural-number?)) (union natural-number? false?)))]{ Return the starting position of the interior of the (non-atomic) - s-expression containing position, or \scheme|#f| is there is none. + s-expression containing position, or @scheme[#f] is there is none. Must only be called while the tokenizer is started. } @@ -169,7 +167,7 @@ Skip all consecutive whitespaces and comments (using skip-whitespace) immediately following position. If the token at this position is an - open, return the position of the matching close, or \scheme|#f| if + open, return the position of the matching close, or @scheme[#f] if there is none. For any other token, return the end of that token. Must only be called while the tokenizer is started. @@ -188,7 +186,7 @@ Return a symbol for the lexer-determined token type for the token that - contains the item after \scheme|position|. + contains the item after @scheme[position]. Must only be called while the tokenizer is started. } diff --git a/collects/scribblings/framework/comment-box.scrbl b/collects/scribblings/framework/comment-box.scrbl index 0798850f39..a90a115ab2 100644 --- a/collects/scribblings/framework/comment-box.scrbl +++ b/collects/scribblings/framework/comment-box.scrbl @@ -11,9 +11,9 @@ @defmethod*[#:mode override (((make-editor) (is-a?/c text%)))]{ Makes an instance of - \begin{schemedisplay} - (scheme:text-mixin text:keymap%) - \end{schemedisplay} + @schemeblock[ + (scheme:text-mixin text:keymap%)] + } @defmethod*[#:mode override (((make-snip) (is-a?/c comment-snip%)))]{ @@ -24,13 +24,13 @@ @defmethod*[#:mode override (((get-corner-bitmap) (is-a?/c bitmap%)))]{ Returns the semicolon bitmap from the file - \begin{schemedisplay} - (build-path (collection-path "icons") "semicolon.gif") - \end{schemedisplay} + @schemeblock[ + (build-path (collection-path "icons") "semicolon.gif")] + } @defmethod*[#:mode override (((get-position) (symbols (quote left-top) (quote top-right))))]{ - Returns \scheme|'left-top| + Returns @scheme['left-top] } @defmethod*[#:mode override (((get-text) string))]{ diff --git a/collects/scribblings/framework/editor.scrbl b/collects/scribblings/framework/editor.scrbl index d3fbf0cd97..ea0bd0f214 100644 --- a/collects/scribblings/framework/editor.scrbl +++ b/collects/scribblings/framework/editor.scrbl @@ -9,7 +9,7 @@ @scheme[editor<%>] functionality required by the framework. @defmethod*[(((has-focus?) boolean))]{ - This function returns \rawscm{\#t} when the editor has the keyboard + This function returns @scheme[#t] when the editor has the keyboard focus. It is implemented using: @method[editor<%> on-focus] @@ -30,11 +30,11 @@ edit-sequence completes. - The procedure \var{thunk} will be called immediately if the edit is + The procedure @scheme[thunk] will be called immediately if the edit is not in an edit-sequence. If the edit is in an edit-sequence, it will be called when the edit-sequence completes. - If \var{tag} is a symbol, the \var{thunk} is keyed on that symbol, and + If @scheme[tag] is a symbol, the @scheme[thunk] is keyed on that symbol, and only one thunk per symbol will be called after the edit-sequence. Specifically, the last call to @method[editor:basic<%> run-after-edit-sequence]'s argument will be called. @@ -50,7 +50,7 @@ } @defmethod*[(((save-file-out-of-date?) boolean))]{ - Returns \rawscm{\#t} if the file on disk has been modified, by some other program. + Returns @scheme[#t] if the file on disk has been modified, by some other program. } @defmethod*[(((save-file/gui-error (filename (union path |#f|) |#f|) (format (union (quote guess) (quote standard) (quote text) (quote text-force-cr) same copy) (quote same)) (show-errors? boolean |#t|)) boolean))]{ @@ -59,8 +59,8 @@ opens a dialog with an error message showing the error. The result indicates if an error happened (the error has - already been shown to the user). It returns \rawscm{\#t} if - no error occurred and \rawscm{\#f} if an error occurred. + already been shown to the user). It returns @scheme[#t] if + no error occurred and @scheme[#f] if an error occurred. } @defmethod*[(((load-file/gui-error (filename (union string |#f|) |#f|) (format (union (quote guess) (quote standard) (quote text) (quote text-force-cr) (quote same) (quote copy)) (quote guess)) (show-errors? boolean |#t|)) boolean))]{ @@ -69,8 +69,8 @@ opens a dialog with an error message showing the error. The result indicates if an error happened (the error has - already been shown to the user). It returns \rawscm{\#t} if - no error occurred and \rawscm{\#f} if an error occurred. + already been shown to the user). It returns @scheme[#t] if + no error occurred and @scheme[#f] if an error occurred. } @defmethod*[(((on-close) void))]{ @@ -94,15 +94,15 @@ @method[editor:basic<%> close]. - Returns \scheme|#t|. + Returns @scheme[#t]. } @defmethod*[(((close) boolean))]{ This method is merely - \begin{schemedisplay} + @schemeblock[ (if (can-close?) (begin (on-close) #t) - #f) - \end{schemedisplay} + #f)] + It is intended as a shorthand, helper method for closing an editor. See also @method[editor:basic<%> can-close?] @@ -125,11 +125,11 @@ mixin's argument. Each instance of a class created with this mixin contains a private - \iscmclass{keymap} that is chained to the global keymap via: - \rawscm{(send \var{keymap} chain-to-keymap (keymap:get-global) \#f)}. + @scheme[keymap%] that is chained to the global keymap via: + @scheme[(send keymap chain-to-keymap (keymap:get-global) #f)]. - This installs the global keymap \iscmprocedure{keymap:get-global} to - handle keyboard and mouse mappings not handled by \var{keymap}. The + This installs the global keymap @scheme[keymap:get-global] to + handle keyboard and mouse mappings not handled by @scheme[keymap]. The global keymap is created when the framework is invoked. @defmethod*[#:mode augment (((can-save-file? (filename string) (format symbol?)) boolean))]{ @@ -165,7 +165,7 @@ } @defmethod*[#:mode augment (((on-edit-sequence) boolean))]{ - Always returns \rawscm{\#t}. Updates a flag for + Always returns @scheme[#t]. Updates a flag for @method[editor:basic<%> local-edit-sequence?] } @defmethod*[#:mode augment (((after-edit-sequence) void))]{ @@ -218,7 +218,7 @@ In addition, it calls @method[editor<%> set-load-overwrites-styles] - with \scheme|#f|. + with @scheme[#f]. This ensures that saved files with different settings for the style list do not clobber the shared style list. @@ -236,15 +236,15 @@ @scheme[add-pasteboard-keymap-functions]. @defmethod*[(((get-keymaps) (list-of (instance keymap%))))]{ The keymaps returned from this method are chained to this - \iscmintf{editor}'s keymap. + @scheme[editor<%>]'s keymap. The result of this method should not change -- that is, it should return the same list of keymaps each time it is called. - Defaultly returns \rawscm{(list - @scheme[keymap:get-global])} + Defaultly returns @scheme[(list + @scheme[keymap:get-global])] } } @defmixin[editor:keymap-mixin (editor:basic<%>) (editor:keymap<%>)]{ @@ -256,16 +256,15 @@ Classes implementing this interface keep the @method[editor<%> auto-wrap] state set based on the - \rawscm{'framework:auto-set-wrap?} preference - (see - \hyperref{the preferences section}{section~}{ for more info about preferences}{fw:preferences}). + @scheme['framework:auto-set-wrap?] preference + (see @scheme[preferences:get] for more information about preferences). They install a preferences callback with @scheme[preferences:add-callback] that sets the state when the preference changes and initialize the value of @method[editor<%> auto-wrap] - to the current value of \rawscm{'framework:auto-set-wrap?} + to the current value of @scheme['framework:auto-set-wrap?] via @scheme[preferences:get]. } @@ -280,7 +279,7 @@ dialog that asks about closing. - Defaultly returns \scheme|#f|. + Defaultly returns @scheme[#f]. } @defmethod*[(((update-frame-filename) void))]{ Attempts to find a frame that displays this editor. If it @@ -294,7 +293,7 @@ @method[editor:file-mixin can-close?]. - Defaultly returns \scheme|#f|. + Defaultly returns @scheme[#f]. } } @defmixin[editor:file-mixin (editor:keymap<%>) (editor:file<%>)]{ @@ -313,13 +312,13 @@ If the @method[editor:file<%> allow-close-with-no-filename?] - method returns \scheme|#f|, this method checks to see if the file + method returns @scheme[#f], this method checks to see if the file has been saved at all yet. If not, it asks the user about saving (and saves if they ask). If the @method[editor:file<%> allow-close-with-no-filename?] - method returns \scheme|#t|, this method does as before, + method returns @scheme[#t], this method does as before, except only asks if the editor's @method[editor<%> get-filename]method returns a path. @@ -343,8 +342,8 @@ Returns the value of the @scheme[preferences:get] applied to - \rawscm{'framework:backup-files?}. - \index{'framework:backup-files?} + @scheme['framework:backup-files?]. + @index{'framework:backup-files?} } @defmethod*[(((autosave?) boolean))]{ @@ -353,7 +352,7 @@ should be autosaved. - Returns \rawscm{\#t}. + Returns @scheme[#t]. } @defmethod*[(((do-autosave) (union |#f| string)))]{ This method is called to perform the autosaving. @@ -368,7 +367,7 @@ @scheme[editor<%>]. Returns the filename where the autosave took place, or - \rawscm{\#f} if none did. + @scheme[#f] if none did. } @defmethod*[(((remove-autosave) void))]{ This method removes the autosave file associated with this @@ -400,7 +399,7 @@ } @defmethod*[#:mode augment (((on-change) void))]{ - Sets a flag indicating that this \iscmintf{editor} needs to be autosaved. + Sets a flag indicating that this @scheme[editor<%>] needs to be autosaved. } @defmethod*[#:mode override (((set-modified (modified? any/c)) void))]{ diff --git a/collects/scribblings/framework/frame.scrbl b/collects/scribblings/framework/frame.scrbl index b9ff227303..ba58130ce2 100644 --- a/collects/scribblings/framework/frame.scrbl +++ b/collects/scribblings/framework/frame.scrbl @@ -33,7 +33,7 @@ the clients of this frame and the frame itself. For example, to insert a status line panel override this method with something like this: - \begin{schemedisplay} + @schemeblock[ (class ... ... (rename [super-make-root-area-container make-root-area-container]) @@ -47,16 +47,14 @@ ; ... add other children to status-panel ... root)) - ... - \end{schemedisplay} + ...)] In this example, status-panel will contain a root panel for the other classes, and whatever panels are needed to display status information. The searching frame is implemented using this method. - - Calls \rawscm{make-object} with \var{class} and \var{parent}. + Calls @scheme[make-object] with @scheme[class] and @scheme[parent]. } @defmethod*[(((close) void))]{ This method closes the frame by calling the @@ -66,15 +64,14 @@ methods. It's implementation is: - \begin{schemedisplay} + @schemeblock[ (inherit can-close? on-close) (public [show (lambda () (when (can-close?) (on-close) - (show #f)))]) - \end{schemedisplay} + (show #f)))])] } @defmethod*[(((editing-this-file? (filename path)) boolean))]{ @@ -82,20 +79,20 @@ that file). - Returns \scheme|#f|. + Returns @scheme[#f]. } @defmethod*[(((get-filename (temp (union |#f| (box boolean)) |#f|)) (union |#f| path)))]{ This returns the filename that the frame is currently being saved as, - or \rawscm{\#f} if there is no appropriate filename. + or @scheme[#f] if there is no appropriate filename. - Defaultly returns \rawscm{\#f}. + Defaultly returns @scheme[#f]. - If \var{temp} is a box, it is filled with \rawscm{\#t} or \rawscm{\#f}, + If @scheme[temp] is a box, it is filled with @scheme[#t] or @scheme[#f], depending if the filename is a temporary filename. } @defmethod*[(((make-visible (filename string)) void))]{ - Makes the file named by \var{filename} visible (intended for + Makes the file named by @scheme[filename] visible (intended for use with tabbed editing). } @@ -107,15 +104,15 @@ object returned by @scheme[group:get-the-frame-group]. - Do not give \iscmclass{panel}s or \iscmintf{control}s this frame as + Do not give @scheme[panel%]s or @scheme[control<%>]s this frame as parent. Instead, use the result of the @method[frame:basic<%> get-area-container] method. - \index{Windows menu} + @index{Windows menu} This mixin also creates a menu bar for the frame, as the frame is initialized. It uses the class returned by - @method[frame:basic<%> get-menu-bar\%]. It only passes the frame as an initialization argument. + @method[frame:basic<%> get-menu-bar%]. It only passes the frame as an initialization argument. In addition, it creates the windows menu in the menu bar. See also @@ -124,8 +121,8 @@ Calls the super method. - When \var{on?} is \scheme|#t|, inserts the frame into the - frame group and when it is \scheme|#f|, removes the frame + When @scheme[on?] is @scheme[#t], inserts the frame into the + frame group and when it is @scheme[#f], removes the frame from the group. } @defmethod*[#:mode override (((can-exit?) boolean))]{ @@ -137,14 +134,14 @@ First, it calls @scheme[exit:set-exiting] - with \rawscm{\#t}. + with @scheme[#t]. Then, it calls - @scheme[exit:can-exit?]. If it returns \rawscm{\#t}, + @scheme[exit:can-exit?]. If it returns @scheme[#t], so does this method. If - it returns \rawscm{\#f}, + it returns @scheme[#f], this method calls @scheme[exit:set-exiting] - with \rawscm{\#f}. + with @scheme[#f]. } @defmethod*[#:mode override (((on-exit) void))]{ @@ -156,12 +153,12 @@ Calls @scheme[exit:on-exit] and then queues a callback - to call MzScheme's \rawscm{exit} + to call MzScheme's @scheme[exit] function. If that returns, it calls @scheme[exit:set-exiting] to reset that flag to - \rawscm{\#f}. + @scheme[#f]. } @defmethod*[#:mode override (((on-superwindow-show (shown? any/c)) void))]{ @@ -175,7 +172,7 @@ Calls @scheme[handler:edit-file] - with \var{pathname} as an argument. + with @scheme[pathname] as an argument. } @defmethod*[#:mode override (((after-new-child) void))]{ @@ -190,13 +187,13 @@ @defmixin[frame:size-pref-mixin (frame:basic<%>) (frame:size-pref<%>)]{ @defconstructor[((size-preferences-key symbol?) (label label-string?) (parent (or/c (is-a?/c frame%) false/c) #f) (x (or/c (integer-in -10000 10000) false/c) #f) (y (or/c (integer-in -10000 10000) false/c) #f) (style (listof (one-of/c (quote no-resize-border) (quote no-caption) (quote no-system-menu) (quote hide-menu-bar) (quote mdi-parent) (quote mdi-child) (quote toolbar-button) (quote float) (quote metal))) null) (enabled any/c #t) (border (integer-in 0 1000) 0) (spacing (integer-in 0 1000) 0) (alignment (list/c (one-of/c (quote left) (quote center) (quote right)) (one-of/c (quote top) (quote center) (quote bottom))) (quote (center top))) (min-width (integer-in 0 10000) graphical-minimum-width) (min-height (integer-in 0 10000) graphical-minimum-height) (stretchable-width any/c #t) (stretchable-height any/c #t))]{ - The size \var{size-preferences-key} symbol is used with + The size @scheme[size-preferences-key] symbol is used with @scheme[preferences:get] and @scheme[preferences:set] to track the current size. - Passes the \var{width} and \var{height} initialization + Passes the @scheme[width] and @scheme[height] initialization arguments to the superclass based on the current value of the preference. @@ -219,27 +216,26 @@ } @defmixin[frame:register-group-mixin (frame:basic<%>) (frame:register-group<%>)]{ During initialization, calls - @method[group:% insert-frame]with \scheme|this|. + @method[group:% insert-frame]with @scheme[this]. @defmethod*[#:mode augment (((can-close?) bool))]{ - Calls the inner method, with a default of \scheme|#t|. - If that returns \scheme|#t|, + Calls the inner method, with a default of @scheme[#t]. + If that returns @scheme[#t], it checks for one of the these three conditions: - \begin{itemize} - \item + @itemize{ + @item{ @scheme[exit:exiting?] - returns \rawscm{\#t} - \item there is more than one + returns @scheme[#t]} + @item{there is more than one frame in the group returned by - @scheme[group:get-the-frame-group], or - \item the procedure + @scheme[group:get-the-frame-group], or} + @item{the procedure @scheme[exit:user-oks-exit] - returns \rawscm{\#t}. - \end{itemize} + returns @scheme[#t].}} If any of those conditions hold, the - method returns \rawscm{\#t}. + method returns @scheme[#t]. } @defmethod*[#:mode augment (((on-close) void))]{ @@ -248,10 +244,10 @@ @method[group:% remove-frame] method of the result of @scheme[group:get-the-frame-group] - with \rawscm{this} as an argument. + with @scheme[this] as an argument. Finally, unless @scheme[exit:exiting?] - returns \rawscm{\#t}, + returns @scheme[#t], and if there are no more frames open, it calls @scheme[exit:exit]. @@ -260,8 +256,8 @@ Calls @method[group:% set-active-frame] - with \rawscm{this} when - \var{on?} is true. + with @scheme[this] when + @scheme[on?] is true. } } @@ -284,7 +280,7 @@ is called with a string. Additionally, the screen space for one status line is re-used when by another status line when the first - passes \scheme|#f| to + passes @scheme[#f] to @method[frame:status-line<%> update-status-line]. In this manner, the status line frame avoids opening too many status lines and avoids flashing the status lines open and closed too @@ -298,12 +294,12 @@ } @defmethod*[(((close-status-line (id symbol?)) void))]{ - Closes the status line \var{id}. + Closes the status line @scheme[id]. } @defmethod*[(((update-status-line (id symbol?) (status (union |#f| string))) void))]{ - Updates the status line named by \var{id} with - \var{status}. If \var{status} is \scheme{#f}, the status + Updates the status line named by @scheme[id] with + @scheme[status]. If @scheme[status] is @scheme[#f], the status line is becomes blank (and may be used by other ids). } @@ -320,11 +316,11 @@ @definterface[frame:info<%> (frame:basic<%>)]{ Frames matching this interface support a status line. - The preference \scheme|'framework:show-status-line| controls - the visibility of the status line. If it is \scheme|#t|, the - status line is visible and if it is \scheme|#f|, the + The preference @scheme['framework:show-status-line] controls + the visibility of the status line. If it is @scheme[#t], the + status line is visible and if it is @scheme[#f], the status line is not visible (see - \hyperref{the preferences section}{section~}{ for more info about preferences}{fw:preferences}). + @scheme[preferences:get] for more info about preferences) @defmethod*[(((determine-width (str string) (canvas (instance editor-canvas%)) (text (instance text%))) integer))]{ This method is used to calculate the size of an @scheme[editor-canvas%] @@ -390,12 +386,10 @@ Result indicates if the show info panel has been explicitly hidden with @method[frame:info<%> hide-info]. - If this method returns \scheme|#t| and - \scheme|(preferences:get 'framework:show-status-line)| is - \scheme|#f|, then the info panel will not be visible. + If this method returns @scheme[#t] and + @scheme[(preferences:get 'framework:show-status-line)] is + @scheme[#f], then the info panel will not be visible. Otherwise, it is visible. - - } } @defmixin[frame:info-mixin (frame:basic<%>) (frame:info<%>)]{ @@ -454,8 +448,8 @@ @defmethod*[#:mode augment (((on-close) void))]{ - removes a preferences callback for \rawscm{'framework:line-offsets}. - See section~\ref{fw:preferences} for more information + removes a preferences callback for @scheme['framework:line-offsets]. + See @scheme[preferences:add-callback] for more information. } @defmethod*[#:mode override (((update-info) void))]{ @@ -472,120 +466,120 @@ } @definterface[frame:standard-menus<%> (frame:basic<%>)]{ - \begin{itemize} - \item + @itemize{ + @item{ @method[frame:standard-menus<%> file-menu:new-callback], @method[frame:standard-menus<%> file-menu:create-new?], @method[frame:standard-menus<%> file-menu:new-string], @method[frame:standard-menus<%> file-menu:new-help-string], @method[frame:standard-menus<%> file-menu:new-on-demand], - @method[frame:standard-menus<%> file-menu:get-new-item] + @method[frame:standard-menus<%> file-menu:get-new-item]} - \item - @method[frame:standard-menus<%> file-menu:between-new-and-open] + @item{ + @method[frame:standard-menus<%> file-menu:between-new-and-open]} - \item + @item{ @method[frame:standard-menus<%> file-menu:open-callback], @method[frame:standard-menus<%> file-menu:create-open?], @method[frame:standard-menus<%> file-menu:open-string], @method[frame:standard-menus<%> file-menu:open-help-string], @method[frame:standard-menus<%> file-menu:open-on-demand], - @method[frame:standard-menus<%> file-menu:get-open-item] + @method[frame:standard-menus<%> file-menu:get-open-item]} - \item + @item{ @method[frame:standard-menus<%> file-menu:open-recent-callback], @method[frame:standard-menus<%> file-menu:create-open-recent?], @method[frame:standard-menus<%> file-menu:open-recent-string], @method[frame:standard-menus<%> file-menu:open-recent-help-string], @method[frame:standard-menus<%> file-menu:open-recent-on-demand], - @method[frame:standard-menus<%> file-menu:get-open-recent-item] + @method[frame:standard-menus<%> file-menu:get-open-recent-item]} - \item - @method[frame:standard-menus<%> file-menu:between-open-and-revert] + @item{ + @method[frame:standard-menus<%> file-menu:between-open-and-revert]} - \item + @item{ @method[frame:standard-menus<%> file-menu:revert-callback], @method[frame:standard-menus<%> file-menu:create-revert?], @method[frame:standard-menus<%> file-menu:revert-string], @method[frame:standard-menus<%> file-menu:revert-help-string], @method[frame:standard-menus<%> file-menu:revert-on-demand], - @method[frame:standard-menus<%> file-menu:get-revert-item] + @method[frame:standard-menus<%> file-menu:get-revert-item]} - \item - @method[frame:standard-menus<%> file-menu:between-revert-and-save] + @item{ + @method[frame:standard-menus<%> file-menu:between-revert-and-save]} - \item + @item{ @method[frame:standard-menus<%> file-menu:save-callback], @method[frame:standard-menus<%> file-menu:create-save?], @method[frame:standard-menus<%> file-menu:save-string], @method[frame:standard-menus<%> file-menu:save-help-string], @method[frame:standard-menus<%> file-menu:save-on-demand], - @method[frame:standard-menus<%> file-menu:get-save-item] + @method[frame:standard-menus<%> file-menu:get-save-item]} - \item + @item{ @method[frame:standard-menus<%> file-menu:save-as-callback], @method[frame:standard-menus<%> file-menu:create-save-as?], @method[frame:standard-menus<%> file-menu:save-as-string], @method[frame:standard-menus<%> file-menu:save-as-help-string], @method[frame:standard-menus<%> file-menu:save-as-on-demand], - @method[frame:standard-menus<%> file-menu:get-save-as-item] + @method[frame:standard-menus<%> file-menu:get-save-as-item]} - \item - @method[frame:standard-menus<%> file-menu:between-save-as-and-print] + @item{ + @method[frame:standard-menus<%> file-menu:between-save-as-and-print]} - \item + @item{ @method[frame:standard-menus<%> file-menu:print-callback], @method[frame:standard-menus<%> file-menu:create-print?], @method[frame:standard-menus<%> file-menu:print-string], @method[frame:standard-menus<%> file-menu:print-help-string], @method[frame:standard-menus<%> file-menu:print-on-demand], - @method[frame:standard-menus<%> file-menu:get-print-item] + @method[frame:standard-menus<%> file-menu:get-print-item]} - \item - @method[frame:standard-menus<%> file-menu:between-print-and-close] + @item{ + @method[frame:standard-menus<%> file-menu:between-print-and-close]} - \item + @item{ @method[frame:standard-menus<%> file-menu:close-callback], @method[frame:standard-menus<%> file-menu:create-close?], @method[frame:standard-menus<%> file-menu:close-string], @method[frame:standard-menus<%> file-menu:close-help-string], @method[frame:standard-menus<%> file-menu:close-on-demand], - @method[frame:standard-menus<%> file-menu:get-close-item] + @method[frame:standard-menus<%> file-menu:get-close-item]} - \item - @method[frame:standard-menus<%> file-menu:between-close-and-quit] + @item{ + @method[frame:standard-menus<%> file-menu:between-close-and-quit]} - \item + @item{ @method[frame:standard-menus<%> file-menu:quit-callback], @method[frame:standard-menus<%> file-menu:create-quit?], @method[frame:standard-menus<%> file-menu:quit-string], @method[frame:standard-menus<%> file-menu:quit-help-string], @method[frame:standard-menus<%> file-menu:quit-on-demand], - @method[frame:standard-menus<%> file-menu:get-quit-item] + @method[frame:standard-menus<%> file-menu:get-quit-item]} - \item - @method[frame:standard-menus<%> file-menu:after-quit] + @item{ + @method[frame:standard-menus<%> file-menu:after-quit]} - \item + @item{ @method[frame:standard-menus<%> edit-menu:undo-callback], @method[frame:standard-menus<%> edit-menu:create-undo?], @method[frame:standard-menus<%> edit-menu:undo-string], @method[frame:standard-menus<%> edit-menu:undo-help-string], @method[frame:standard-menus<%> edit-menu:undo-on-demand], - @method[frame:standard-menus<%> edit-menu:get-undo-item] + @method[frame:standard-menus<%> edit-menu:get-undo-item]} - \item + @item{ @method[frame:standard-menus<%> edit-menu:redo-callback], @method[frame:standard-menus<%> edit-menu:create-redo?], @method[frame:standard-menus<%> edit-menu:redo-string], @method[frame:standard-menus<%> edit-menu:redo-help-string], @method[frame:standard-menus<%> edit-menu:redo-on-demand], - @method[frame:standard-menus<%> edit-menu:get-redo-item] + @method[frame:standard-menus<%> edit-menu:get-redo-item]} - \item - @method[frame:standard-menus<%> edit-menu:between-redo-and-cut] + @item{ + @method[frame:standard-menus<%> edit-menu:between-redo-and-cut]} - \item + @item{ @method[frame:standard-menus<%> edit-menu:cut-callback], @method[frame:standard-menus<%> edit-menu:create-cut?], @method[frame:standard-menus<%> edit-menu:cut-string], @@ -593,10 +587,10 @@ @method[frame:standard-menus<%> edit-menu:cut-on-demand], @method[frame:standard-menus<%> edit-menu:get-cut-item] - \item + }@item{ @method[frame:standard-menus<%> edit-menu:between-cut-and-copy] - \item + }@item{ @method[frame:standard-menus<%> edit-menu:copy-callback], @method[frame:standard-menus<%> edit-menu:create-copy?], @method[frame:standard-menus<%> edit-menu:copy-string], @@ -604,10 +598,10 @@ @method[frame:standard-menus<%> edit-menu:copy-on-demand], @method[frame:standard-menus<%> edit-menu:get-copy-item] - \item + }@item{ @method[frame:standard-menus<%> edit-menu:between-copy-and-paste] - \item + }@item{ @method[frame:standard-menus<%> edit-menu:paste-callback], @method[frame:standard-menus<%> edit-menu:create-paste?], @method[frame:standard-menus<%> edit-menu:paste-string], @@ -615,10 +609,10 @@ @method[frame:standard-menus<%> edit-menu:paste-on-demand], @method[frame:standard-menus<%> edit-menu:get-paste-item] - \item + }@item{ @method[frame:standard-menus<%> edit-menu:between-paste-and-clear] - \item + }@item{ @method[frame:standard-menus<%> edit-menu:clear-callback], @method[frame:standard-menus<%> edit-menu:create-clear?], @method[frame:standard-menus<%> edit-menu:clear-string], @@ -626,10 +620,10 @@ @method[frame:standard-menus<%> edit-menu:clear-on-demand], @method[frame:standard-menus<%> edit-menu:get-clear-item] - \item + }@item{ @method[frame:standard-menus<%> edit-menu:between-clear-and-select-all] - \item + }@item{ @method[frame:standard-menus<%> edit-menu:select-all-callback], @method[frame:standard-menus<%> edit-menu:create-select-all?], @method[frame:standard-menus<%> edit-menu:select-all-string], @@ -637,10 +631,10 @@ @method[frame:standard-menus<%> edit-menu:select-all-on-demand], @method[frame:standard-menus<%> edit-menu:get-select-all-item] - \item + }@item{ @method[frame:standard-menus<%> edit-menu:between-select-all-and-find] - \item + }@item{ @method[frame:standard-menus<%> edit-menu:find-callback], @method[frame:standard-menus<%> edit-menu:create-find?], @method[frame:standard-menus<%> edit-menu:find-string], @@ -648,7 +642,7 @@ @method[frame:standard-menus<%> edit-menu:find-on-demand], @method[frame:standard-menus<%> edit-menu:get-find-item] - \item + }@item{ @method[frame:standard-menus<%> edit-menu:find-again-callback], @method[frame:standard-menus<%> edit-menu:create-find-again?], @method[frame:standard-menus<%> edit-menu:find-again-string], @@ -656,7 +650,7 @@ @method[frame:standard-menus<%> edit-menu:find-again-on-demand], @method[frame:standard-menus<%> edit-menu:get-find-again-item] - \item + }@item{ @method[frame:standard-menus<%> edit-menu:replace-and-find-again-callback], @method[frame:standard-menus<%> edit-menu:create-replace-and-find-again?], @method[frame:standard-menus<%> edit-menu:replace-and-find-again-string], @@ -664,10 +658,10 @@ @method[frame:standard-menus<%> edit-menu:replace-and-find-again-on-demand], @method[frame:standard-menus<%> edit-menu:get-replace-and-find-again-item] - \item + }@item{ @method[frame:standard-menus<%> edit-menu:between-find-and-preferences] - \item + }@item{ @method[frame:standard-menus<%> edit-menu:preferences-callback], @method[frame:standard-menus<%> edit-menu:create-preferences?], @method[frame:standard-menus<%> edit-menu:preferences-string], @@ -675,13 +669,13 @@ @method[frame:standard-menus<%> edit-menu:preferences-on-demand], @method[frame:standard-menus<%> edit-menu:get-preferences-item] - \item + }@item{ @method[frame:standard-menus<%> edit-menu:after-preferences] - \item + }@item{ @method[frame:standard-menus<%> help-menu:before-about] - \item + }@item{ @method[frame:standard-menus<%> help-menu:about-callback], @method[frame:standard-menus<%> help-menu:create-about?], @method[frame:standard-menus<%> help-menu:about-string], @@ -689,10 +683,9 @@ @method[frame:standard-menus<%> help-menu:about-on-demand], @method[frame:standard-menus<%> help-menu:get-about-item] - \item - @method[frame:standard-menus<%> help-menu:after-about] + }@item{ + @method[frame:standard-menus<%> help-menu:after-about]}} - \end{itemize} @defmethod*[(((get-menu%) (subclass?/c menu:can-restore-underscore-menu%)))]{ The result of this method is used as the class for creating the result of these methods: @@ -727,19 +720,19 @@ @defmethod*[(((get-file-menu) (instance (subclass?/c menu%))))]{ Returns the file menu See also - @method[frame:standard-menus<%> get-menu\%] + @method[frame:standard-menus<%> get-menu%] } @defmethod*[(((get-edit-menu) (instance (subclass?/c menu%))))]{ Returns the edit menu See also - @method[frame:standard-menus<%> get-menu\%] + @method[frame:standard-menus<%> get-menu%] } @defmethod*[(((get-help-menu) (instance (subclass?/c menu%))))]{ Returns the help menu See also - @method[frame:standard-menus<%> get-menu\%] + @method[frame:standard-menus<%> get-menu%] } @defmethod*[(((file-menu:new-callback (item (instance (subclass?/c menu-item%))) (evt (instance control-event%))) void))]{ @@ -747,12 +740,11 @@ Defaultly bound to: - \begin{schemedisplay} - (λ (item control) (handler:edit-file #f) #t) - \end{schemedisplay} + @schemeblock[ + (λ (item control) (handler:edit-file #f) #t)] } @defmethod*[(((file-menu:get-new-item) (instance menu-item%)))]{ - This method returns the \iscmclass{menu-item} that corresponds + This method returns the @scheme[menu-item%] that corresponds to this menu item. } @@ -767,14 +759,14 @@ object is created. - Defaultly returns "\scheme{(string-constant new-info)}" + Defaultly returns @scheme[(string-constant new-info)]. } @defmethod*[(((file-menu:new-on-demand (item menu-item%)) void))]{ The menu item's on-demand method calls this method Defaultly is this: - \scheme{(λ (menu-item) (void))} + @scheme[(λ (menu-item) (void))] } @defmethod*[(((file-menu:create-new?) boolean))]{ The result of this method determines if the @@ -782,7 +774,7 @@ to control the creation of the menu-item. - defaultly returns \#t + defaultly returns #t } @defmethod*[(((file-menu:between-new-and-open (menu (instance (subclass?/c menu%)))) void))]{ This method is called between the addition of the new menu-item @@ -797,12 +789,11 @@ Defaultly bound to: - \begin{schemedisplay} - (λ (item control) (handler:open-file) #t) - \end{schemedisplay} + @schemeblock[ + (λ (item control) (handler:open-file) #t)] } @defmethod*[(((file-menu:get-open-item) (instance menu-item%)))]{ - This method returns the \iscmclass{menu-item} that corresponds + This method returns the @scheme[menu-item%] that corresponds to this menu item. } @@ -817,14 +808,14 @@ object is created. - Defaultly returns "\scheme{(string-constant open-info)}" + Defaultly returns @scheme[(string-constant open-info)] } @defmethod*[(((file-menu:open-on-demand (item menu-item%)) void))]{ The menu item's on-demand method calls this method Defaultly is this: - \scheme{(λ (menu-item) (void))} + @scheme[(λ (menu-item) (void))] } @defmethod*[(((file-menu:create-open?) boolean))]{ The result of this method determines if the @@ -832,19 +823,19 @@ to control the creation of the menu-item. - defaultly returns \#t + defaultly returns #t } @defmethod*[(((file-menu:open-recent-callback (item (instance (subclass?/c menu-item%))) (evt (instance control-event%))) void))]{ This method is called when the open-recent menu-item of the file-menu menu is selected. Defaultly bound to: - \begin{schemedisplay} - (λ (x y) (void)) - \end{schemedisplay} + @schemeblock[ + (λ (x y) (void))] + } @defmethod*[(((file-menu:get-open-recent-item) (instance menu-item%)))]{ - This method returns the \iscmclass{menu-item} that corresponds + This method returns the @scheme[menu-item%] that corresponds to this menu item. } @@ -859,14 +850,14 @@ object is created. - Defaultly returns "\scheme{(string-constant open-recent-info)}" + Defaultly returns @scheme[(string-constant open-recent-info)] } @defmethod*[(((file-menu:open-recent-on-demand (item menu-item%)) void))]{ The menu item's on-demand method calls this method Defaultly is this: - \scheme{(λ (menu) (handler:install-recent-items menu))} + @scheme[(λ (menu) (handler:install-recent-items menu))] } @defmethod*[(((file-menu:create-open-recent?) boolean))]{ The result of this method determines if the @@ -874,7 +865,7 @@ to control the creation of the menu-item. - defaultly returns \#t + defaultly returns #t } @defmethod*[(((file-menu:between-open-and-revert (menu (instance (subclass?/c menu%)))) void))]{ This method is called between the addition of the open menu-item @@ -889,12 +880,11 @@ Defaultly bound to: - \begin{schemedisplay} - (λ (item control) (void)) - \end{schemedisplay} + @schemeblock[ + (λ (item control) (void))] } @defmethod*[(((file-menu:get-revert-item) (instance menu-item%)))]{ - This method returns the \iscmclass{menu-item} that corresponds + This method returns the @scheme[menu-item%] that corresponds to this menu item. } @@ -909,14 +899,14 @@ object is created. - Defaultly returns "\scheme{(string-constant revert-info)}" + Defaultly returns @scheme[(string-constant revert-info)] } @defmethod*[(((file-menu:revert-on-demand (item menu-item%)) void))]{ The menu item's on-demand method calls this method Defaultly is this: - \scheme{(λ (menu-item) (void))} + @scheme[(λ (menu-item) (void))] } @defmethod*[(((file-menu:create-revert?) boolean))]{ The result of this method determines if the @@ -924,7 +914,7 @@ to control the creation of the menu-item. - defaultly returns \#f + defaultly returns @scheme[#f] } @defmethod*[(((file-menu:between-revert-and-save (menu (instance (subclass?/c menu%)))) void))]{ This method is called between the addition of the revert menu-item @@ -939,12 +929,11 @@ Defaultly bound to: - \begin{schemedisplay} - (λ (item control) (void)) - \end{schemedisplay} + @schemeblock[ + (λ (item control) (void))] } @defmethod*[(((file-menu:get-save-item) (instance menu-item%)))]{ - This method returns the \iscmclass{menu-item} that corresponds + This method returns the @scheme[menu-item%] that corresponds to this menu item. } @@ -959,14 +948,14 @@ object is created. - Defaultly returns "\scheme{(string-constant save-info)}" + Defaultly returns @scheme[(string-constant save-info)] } @defmethod*[(((file-menu:save-on-demand (item menu-item%)) void))]{ The menu item's on-demand method calls this method Defaultly is this: - \scheme{(λ (menu-item) (void))} + @scheme[(λ (menu-item) (void))] } @defmethod*[(((file-menu:create-save?) boolean))]{ The result of this method determines if the @@ -974,19 +963,19 @@ to control the creation of the menu-item. - defaultly returns \#f + defaultly returns @scheme[#f] } @defmethod*[(((file-menu:save-as-callback (item (instance (subclass?/c menu-item%))) (evt (instance control-event%))) void))]{ This method is called when the save-as menu-item of the file-menu menu is selected. Defaultly bound to: - \begin{schemedisplay} - (λ (item control) (void)) - \end{schemedisplay} + @schemeblock[ + (λ (item control) (void))] + } @defmethod*[(((file-menu:get-save-as-item) (instance menu-item%)))]{ - This method returns the \iscmclass{menu-item} that corresponds + This method returns the @scheme[menu-item%] that corresponds to this menu item. } @@ -1001,14 +990,14 @@ object is created. - Defaultly returns "\scheme{(string-constant save-as-info)}" + Defaultly returns @scheme[(string-constant save-as-info)] } @defmethod*[(((file-menu:save-as-on-demand (item menu-item%)) void))]{ The menu item's on-demand method calls this method Defaultly is this: - \scheme{(λ (menu-item) (void))} + @scheme[(λ (menu-item) (void))] } @defmethod*[(((file-menu:create-save-as?) boolean))]{ The result of this method determines if the @@ -1016,7 +1005,7 @@ to control the creation of the menu-item. - defaultly returns \#f + defaultly returns @scheme[#f] } @defmethod*[(((file-menu:between-save-as-and-print (menu (instance (subclass?/c menu%)))) void))]{ This method is called between the addition of the save-as menu-item @@ -1031,12 +1020,12 @@ Defaultly bound to: - \begin{schemedisplay} - (λ (item control) (void)) - \end{schemedisplay} + @schemeblock[ + (λ (item control) (void))] + } @defmethod*[(((file-menu:get-print-item) (instance menu-item%)))]{ - This method returns the \iscmclass{menu-item} that corresponds + This method returns the @scheme[menu-item%] that corresponds to this menu item. } @@ -1051,14 +1040,14 @@ object is created. - Defaultly returns "\scheme{(string-constant print-info)}" + Defaultly returns @scheme[(string-constant print-info)] } @defmethod*[(((file-menu:print-on-demand (item menu-item%)) void))]{ The menu item's on-demand method calls this method Defaultly is this: - \scheme{(λ (menu-item) (void))} + @scheme[(λ (menu-item) (void))] } @defmethod*[(((file-menu:create-print?) boolean))]{ The result of this method determines if the @@ -1066,7 +1055,7 @@ to control the creation of the menu-item. - defaultly returns \#f + defaultly returns @scheme[#f] } @defmethod*[(((file-menu:between-print-and-close (menu (instance (subclass?/c menu%)))) void))]{ This method is called between the addition of the print menu-item @@ -1081,12 +1070,12 @@ Defaultly bound to: - \begin{schemedisplay} - (λ (item control) (when (can-close?) (on-close) (show #f)) #t) - \end{schemedisplay} + @schemeblock[ + (λ (item control) (when (can-close?) (on-close) (show #f)) #t)] + } @defmethod*[(((file-menu:get-close-item) (instance menu-item%)))]{ - This method returns the \iscmclass{menu-item} that corresponds + This method returns the @scheme[menu-item%] that corresponds to this menu item. } @@ -1101,14 +1090,14 @@ object is created. - Defaultly returns "\scheme{(string-constant close-info)}" + Defaultly returns @scheme[(string-constant close-info)] } @defmethod*[(((file-menu:close-on-demand (item menu-item%)) void))]{ The menu item's on-demand method calls this method Defaultly is this: - \scheme{(λ (menu-item) (void))} + @scheme[(λ (menu-item) (void))] } @defmethod*[(((file-menu:create-close?) boolean))]{ The result of this method determines if the @@ -1116,7 +1105,7 @@ to control the creation of the menu-item. - defaultly returns \#t + defaultly returns #t } @defmethod*[(((file-menu:between-close-and-quit (menu (instance (subclass?/c menu%)))) void))]{ This method is called between the addition of the close menu-item @@ -1131,12 +1120,12 @@ Defaultly bound to: - \begin{schemedisplay} - (λ (item control) (when (exit:user-oks-exit) (exit:exit))) - \end{schemedisplay} + @schemeblock[ + (λ (item control) (when (exit:user-oks-exit) (exit:exit)))] + } @defmethod*[(((file-menu:get-quit-item) (instance menu-item%)))]{ - This method returns the \iscmclass{menu-item} that corresponds + This method returns the @scheme[menu-item%] that corresponds to this menu item. } @@ -1151,14 +1140,14 @@ object is created. - Defaultly returns "\scheme{(string-constant quit-info)}" + Defaultly returns @scheme[(string-constant quit-info)] } @defmethod*[(((file-menu:quit-on-demand (item menu-item%)) void))]{ The menu item's on-demand method calls this method Defaultly is this: - \scheme{(λ (menu-item) (void))} + @scheme[(λ (menu-item) (void))] } @defmethod*[(((file-menu:create-quit?) boolean))]{ The result of this method determines if the @@ -1181,16 +1170,16 @@ Defaultly bound to: - \begin{schemedisplay} + @schemeblock[ (λ (menu evt) (let ((edit (get-edit-target-object))) (when (and edit (is-a? edit editor<%>)) (send edit do-edit-operation 'undo))) - #t) - \end{schemedisplay} + #t)] + } @defmethod*[(((edit-menu:get-undo-item) (instance menu-item%)))]{ - This method returns the \iscmclass{menu-item} that corresponds + This method returns the @scheme[menu-item%] that corresponds to this menu item. } @@ -1205,14 +1194,14 @@ object is created. - Defaultly returns "\scheme{(string-constant undo-info)}" + Defaultly returns @scheme[(string-constant undo-info)] } @defmethod*[(((edit-menu:undo-on-demand (item menu-item%)) void))]{ The menu item's on-demand method calls this method Defaultly is this: - \scheme{(λ (item) (let* ((editor (get-edit-target-object)) (enable? (and editor (is-a? editor editor<\%>) (send editor can-do-edit-operation? (quote undo))))) (send item enable enable?)))} + @scheme[(λ (item) (let* ((editor (get-edit-target-object)) (enable? (and editor (is-a? editor editor<%>) (send editor can-do-edit-operation? (quote undo))))) (send item enable enable?)))] } @defmethod*[(((edit-menu:create-undo?) boolean))]{ The result of this method determines if the @@ -1220,23 +1209,23 @@ to control the creation of the menu-item. - defaultly returns \#t + defaultly returns #t } @defmethod*[(((edit-menu:redo-callback (item (instance (subclass?/c menu-item%))) (evt (instance control-event%))) void))]{ This method is called when the redo menu-item of the edit-menu menu is selected. Defaultly bound to: - \begin{schemedisplay} + @schemeblock[ (λ (menu evt) (let ((edit (get-edit-target-object))) (when (and edit (is-a? edit editor<%>)) (send edit do-edit-operation 'redo))) - #t) - \end{schemedisplay} + #t)] + } @defmethod*[(((edit-menu:get-redo-item) (instance menu-item%)))]{ - This method returns the \iscmclass{menu-item} that corresponds + This method returns the @scheme[menu-item%] that corresponds to this menu item. } @@ -1251,14 +1240,14 @@ object is created. - Defaultly returns "\scheme{(string-constant redo-info)}" + Defaultly returns @scheme[(string-constant redo-info)] } @defmethod*[(((edit-menu:redo-on-demand (item menu-item%)) void))]{ The menu item's on-demand method calls this method Defaultly is this: - \scheme{(λ (item) (let* ((editor (get-edit-target-object)) (enable? (and editor (is-a? editor editor<\%>) (send editor can-do-edit-operation? (quote redo))))) (send item enable enable?)))} + @scheme[(λ (item) (let* ((editor (get-edit-target-object)) (enable? (and editor (is-a? editor editor<%>) (send editor can-do-edit-operation? (quote redo))))) (send item enable enable?)))] } @defmethod*[(((edit-menu:create-redo?) boolean))]{ The result of this method determines if the @@ -1266,7 +1255,7 @@ to control the creation of the menu-item. - defaultly returns \#t + defaultly returns #t } @defmethod*[(((edit-menu:between-redo-and-cut (menu (instance (subclass?/c menu%)))) void))]{ This method is called between the addition of the redo menu-item @@ -1281,16 +1270,16 @@ Defaultly bound to: - \begin{schemedisplay} + @schemeblock[ (λ (menu evt) (let ((edit (get-edit-target-object))) (when (and edit (is-a? edit editor<%>)) (send edit do-edit-operation 'cut))) - #t) - \end{schemedisplay} + #t)] + } @defmethod*[(((edit-menu:get-cut-item) (instance menu-item%)))]{ - This method returns the \iscmclass{menu-item} that corresponds + This method returns the @scheme[menu-item%] that corresponds to this menu item. } @@ -1305,14 +1294,14 @@ object is created. - Defaultly returns "\scheme{(string-constant cut-info)}" + Defaultly returns @scheme[(string-constant cut-info)] } @defmethod*[(((edit-menu:cut-on-demand (item menu-item%)) void))]{ The menu item's on-demand method calls this method Defaultly is this: - \scheme{(λ (item) (let* ((editor (get-edit-target-object)) (enable? (and editor (is-a? editor editor<\%>) (send editor can-do-edit-operation? (quote cut))))) (send item enable enable?)))} + @scheme[(λ (item) (let* ((editor (get-edit-target-object)) (enable? (and editor (is-a? editor editor<%>) (send editor can-do-edit-operation? (quote cut))))) (send item enable enable?)))] } @defmethod*[(((edit-menu:create-cut?) boolean))]{ The result of this method determines if the @@ -1320,7 +1309,7 @@ to control the creation of the menu-item. - defaultly returns \#t + defaultly returns #t } @defmethod*[(((edit-menu:between-cut-and-copy (menu (instance (subclass?/c menu%)))) void))]{ This method is called between the addition of the cut menu-item @@ -1335,16 +1324,16 @@ Defaultly bound to: - \begin{schemedisplay} + @schemeblock[ (λ (menu evt) (let ((edit (get-edit-target-object))) (when (and edit (is-a? edit editor<%>)) (send edit do-edit-operation 'copy))) - #t) - \end{schemedisplay} + #t)] + } @defmethod*[(((edit-menu:get-copy-item) (instance menu-item%)))]{ - This method returns the \iscmclass{menu-item} that corresponds + This method returns the @scheme[menu-item%] that corresponds to this menu item. } @@ -1359,14 +1348,14 @@ object is created. - Defaultly returns "\scheme{(string-constant copy-info)}" + Defaultly returns @scheme[(string-constant copy-info)] } @defmethod*[(((edit-menu:copy-on-demand (item menu-item%)) void))]{ The menu item's on-demand method calls this method Defaultly is this: - \scheme{(λ (item) (let* ((editor (get-edit-target-object)) (enable? (and editor (is-a? editor editor<\%>) (send editor can-do-edit-operation? (quote copy))))) (send item enable enable?)))} + @scheme[(λ (item) (let* ((editor (get-edit-target-object)) (enable? (and editor (is-a? editor editor<%>) (send editor can-do-edit-operation? (quote copy))))) (send item enable enable?)))] } @defmethod*[(((edit-menu:create-copy?) boolean))]{ The result of this method determines if the @@ -1374,7 +1363,7 @@ to control the creation of the menu-item. - defaultly returns \#t + defaultly returns #t } @defmethod*[(((edit-menu:between-copy-and-paste (menu (instance (subclass?/c menu%)))) void))]{ This method is called between the addition of the copy menu-item @@ -1389,16 +1378,16 @@ Defaultly bound to: - \begin{schemedisplay} + @schemeblock[ (λ (menu evt) (let ((edit (get-edit-target-object))) (when (and edit (is-a? edit editor<%>)) (send edit do-edit-operation 'paste))) - #t) - \end{schemedisplay} + #t)] + } @defmethod*[(((edit-menu:get-paste-item) (instance menu-item%)))]{ - This method returns the \iscmclass{menu-item} that corresponds + This method returns the @scheme[menu-item%] that corresponds to this menu item. } @@ -1413,14 +1402,14 @@ object is created. - Defaultly returns "\scheme{(string-constant paste-info)}" + Defaultly returns @scheme[(string-constant paste-info)] } @defmethod*[(((edit-menu:paste-on-demand (item menu-item%)) void))]{ The menu item's on-demand method calls this method Defaultly is this: - \scheme{(λ (item) (let* ((editor (get-edit-target-object)) (enable? (and editor (is-a? editor editor<\%>) (send editor can-do-edit-operation? (quote paste))))) (send item enable enable?)))} + @scheme[(λ (item) (let* ((editor (get-edit-target-object)) (enable? (and editor (is-a? editor editor<%>) (send editor can-do-edit-operation? (quote paste))))) (send item enable enable?)))] } @defmethod*[(((edit-menu:create-paste?) boolean))]{ The result of this method determines if the @@ -1428,7 +1417,7 @@ to control the creation of the menu-item. - defaultly returns \#t + defaultly returns #t } @defmethod*[(((edit-menu:between-paste-and-clear (menu (instance (subclass?/c menu%)))) void))]{ This method is called between the addition of the paste menu-item @@ -1443,16 +1432,16 @@ Defaultly bound to: - \begin{schemedisplay} + @schemeblock[ (λ (menu evt) (let ((edit (get-edit-target-object))) (when (and edit (is-a? edit editor<%>)) (send edit do-edit-operation 'clear))) - #t) - \end{schemedisplay} + #t)] + } @defmethod*[(((edit-menu:get-clear-item) (instance menu-item%)))]{ - This method returns the \iscmclass{menu-item} that corresponds + This method returns the @scheme[menu-item%] that corresponds to this menu item. } @@ -1467,14 +1456,14 @@ object is created. - Defaultly returns "\scheme{(string-constant clear-info)}" + Defaultly returns @scheme[(string-constant clear-info)] } @defmethod*[(((edit-menu:clear-on-demand (item menu-item%)) void))]{ The menu item's on-demand method calls this method Defaultly is this: - \scheme{(λ (item) (let* ((editor (get-edit-target-object)) (enable? (and editor (is-a? editor editor<\%>) (send editor can-do-edit-operation? (quote clear))))) (send item enable enable?)))} + @scheme[(λ (item) (let* ((editor (get-edit-target-object)) (enable? (and editor (is-a? editor editor<%>) (send editor can-do-edit-operation? (quote clear))))) (send item enable enable?)))] } @defmethod*[(((edit-menu:create-clear?) boolean))]{ The result of this method determines if the @@ -1482,7 +1471,7 @@ to control the creation of the menu-item. - defaultly returns \#t + defaultly returns #t } @defmethod*[(((edit-menu:between-clear-and-select-all (menu (instance (subclass?/c menu%)))) void))]{ This method is called between the addition of the clear menu-item @@ -1497,16 +1486,16 @@ Defaultly bound to: - \begin{schemedisplay} + @schemeblock[ (λ (menu evt) (let ((edit (get-edit-target-object))) (when (and edit (is-a? edit editor<%>)) (send edit do-edit-operation 'select-all))) - #t) - \end{schemedisplay} + #t)] + } @defmethod*[(((edit-menu:get-select-all-item) (instance menu-item%)))]{ - This method returns the \iscmclass{menu-item} that corresponds + This method returns the @scheme[menu-item%] that corresponds to this menu item. } @@ -1521,14 +1510,14 @@ object is created. - Defaultly returns "\scheme{(string-constant select-all-info)}" + Defaultly returns @scheme[(string-constant select-all-info)] } @defmethod*[(((edit-menu:select-all-on-demand (item menu-item%)) void))]{ The menu item's on-demand method calls this method Defaultly is this: - \scheme{(λ (item) (let* ((editor (get-edit-target-object)) (enable? (and editor (is-a? editor editor<\%>) (send editor can-do-edit-operation? (quote select-all))))) (send item enable enable?)))} + @scheme[(λ (item) (let* ((editor (get-edit-target-object)) (enable? (and editor (is-a? editor editor<%>) (send editor can-do-edit-operation? (quote select-all))))) (send item enable enable?)))] } @defmethod*[(((edit-menu:create-select-all?) boolean))]{ The result of this method determines if the @@ -1536,7 +1525,7 @@ to control the creation of the menu-item. - defaultly returns \#t + defaultly returns #t } @defmethod*[(((edit-menu:between-select-all-and-find (menu (instance (subclass?/c menu%)))) void))]{ This method is called between the addition of the select-all menu-item @@ -1551,12 +1540,12 @@ Defaultly bound to: - \begin{schemedisplay} - (λ (item control) (void)) - \end{schemedisplay} + @schemeblock[ + (λ (item control) (void))] + } @defmethod*[(((edit-menu:get-find-item) (instance menu-item%)))]{ - This method returns the \iscmclass{menu-item} that corresponds + This method returns the @scheme[menu-item%] that corresponds to this menu item. } @@ -1571,14 +1560,14 @@ object is created. - Defaultly returns "\scheme{(string-constant find-info)}" + Defaultly returns @scheme[(string-constant find-info)] } @defmethod*[(((edit-menu:find-on-demand (item menu-item%)) void))]{ The menu item's on-demand method calls this method Defaultly is this: - \scheme{(λ (item) (send item enable (let ((target (get-edit-target-object))) (and target (is-a? target editor<\%>)))))} + @scheme[(λ (item) (send item enable (let ((target (get-edit-target-object))) (and target (is-a? target editor<%>)))))] } @defmethod*[(((edit-menu:create-find?) boolean))]{ The result of this method determines if the @@ -1586,19 +1575,19 @@ to control the creation of the menu-item. - defaultly returns \#f + defaultly returns @scheme[#f] } @defmethod*[(((edit-menu:find-again-callback (item (instance (subclass?/c menu-item%))) (evt (instance control-event%))) void))]{ This method is called when the find-again menu-item of the edit-menu menu is selected. Defaultly bound to: - \begin{schemedisplay} - (λ (item control) (void)) - \end{schemedisplay} + @schemeblock[ + (λ (item control) (void))] + } @defmethod*[(((edit-menu:get-find-again-item) (instance menu-item%)))]{ - This method returns the \iscmclass{menu-item} that corresponds + This method returns the @scheme[menu-item%] that corresponds to this menu item. } @@ -1613,14 +1602,14 @@ object is created. - Defaultly returns "\scheme{(string-constant find-again-info)}" + Defaultly returns @scheme[(string-constant find-again-info)] } @defmethod*[(((edit-menu:find-again-on-demand (item menu-item%)) void))]{ The menu item's on-demand method calls this method Defaultly is this: - \scheme{(λ (item) (send item enable (let ((target (get-edit-target-object))) (and target (is-a? target editor<\%>)))))} + @scheme[(λ (item) (send item enable (let ((target (get-edit-target-object))) (and target (is-a? target editor<%>)))))] } @defmethod*[(((edit-menu:create-find-again?) boolean))]{ The result of this method determines if the @@ -1628,19 +1617,19 @@ to control the creation of the menu-item. - defaultly returns \#f + defaultly returns @scheme[#f] } @defmethod*[(((edit-menu:replace-and-find-again-callback (item (instance (subclass?/c menu-item%))) (evt (instance control-event%))) void))]{ This method is called when the replace-and-find-again menu-item of the edit-menu menu is selected. Defaultly bound to: - \begin{schemedisplay} - (λ (item control) (void)) - \end{schemedisplay} + @schemeblock[ + (λ (item control) (void))] + } @defmethod*[(((edit-menu:get-replace-and-find-again-item) (instance menu-item%)))]{ - This method returns the \iscmclass{menu-item} that corresponds + This method returns the @scheme[menu-item%] that corresponds to this menu item. } @@ -1655,14 +1644,14 @@ object is created. - Defaultly returns "\scheme{(string-constant replace-and-find-again-info)}" + Defaultly returns @scheme[(string-constant replace-and-find-again-info)] } @defmethod*[(((edit-menu:replace-and-find-again-on-demand (item menu-item%)) void))]{ The menu item's on-demand method calls this method Defaultly is this: - \scheme{(λ (item) (send item enable (let ((target (get-edit-target-object))) (and target (is-a? target editor<\%>)))))} + @scheme[(λ (item) (send item enable (let ((target (get-edit-target-object))) (and target (is-a? target editor<%>)))))] } @defmethod*[(((edit-menu:create-replace-and-find-again?) boolean))]{ The result of this method determines if the @@ -1670,7 +1659,7 @@ to control the creation of the menu-item. - defaultly returns \#f + defaultly returns @scheme[#f] } @defmethod*[(((edit-menu:between-find-and-preferences (menu (instance (subclass?/c menu%)))) void))]{ This method is called between the addition of the find menu-item @@ -1678,19 +1667,19 @@ Override it to add additional menus at that point. - Adds a separator except when \rawscm{current-eventspace-has-standard-menus?} returns \rawscm{\#t}. + Adds a separator except when @scheme[current-eventspace-has-standard-menus?] returns @scheme[#t]. } @defmethod*[(((edit-menu:preferences-callback (item (instance (subclass?/c menu-item%))) (evt (instance control-event%))) void))]{ This method is called when the preferences menu-item of the edit-menu menu is selected. Defaultly bound to: - \begin{schemedisplay} - (λ (item control) (preferences:show-dialog) #t) - \end{schemedisplay} + @schemeblock[ + (λ (item control) (preferences:show-dialog) #t)] + } @defmethod*[(((edit-menu:get-preferences-item) (instance menu-item%)))]{ - This method returns the \iscmclass{menu-item} that corresponds + This method returns the @scheme[menu-item%] that corresponds to this menu item. } @@ -1705,14 +1694,14 @@ object is created. - Defaultly returns "\scheme{(string-constant preferences-info)}" + Defaultly returns @scheme[(string-constant preferences-info)] } @defmethod*[(((edit-menu:preferences-on-demand (item menu-item%)) void))]{ The menu item's on-demand method calls this method Defaultly is this: - \scheme{(λ (menu-item) (void))} + @scheme[(λ (menu-item) (void))] } @defmethod*[(((edit-menu:create-preferences?) boolean))]{ The result of this method determines if the @@ -1743,12 +1732,12 @@ Defaultly bound to: - \begin{schemedisplay} - (λ (item control) (void)) - \end{schemedisplay} + @schemeblock[ + (λ (item control) (void))] + } @defmethod*[(((help-menu:get-about-item) (instance menu-item%)))]{ - This method returns the \iscmclass{menu-item} that corresponds + This method returns the @scheme[menu-item%] that corresponds to this menu item. } @@ -1763,14 +1752,14 @@ object is created. - Defaultly returns "\scheme{(string-constant about-info)}" + Defaultly returns @scheme[(string-constant about-info)] } @defmethod*[(((help-menu:about-on-demand (item menu-item%)) void))]{ The menu item's on-demand method calls this method Defaultly is this: - \scheme{(λ (menu-item) (void))} + @scheme[(λ (menu-item) (void))] } @defmethod*[(((help-menu:create-about?) boolean))]{ The result of this method determines if the @@ -1778,7 +1767,7 @@ to control the creation of the menu-item. - defaultly returns \#f + defaultly returns @scheme[#f] } @defmethod*[(((help-menu:after-about (menu (instance (subclass?/c menu%)))) void))]{ This method is called after the addition of the about menu-item @@ -1825,7 +1814,7 @@ } @defmethod*[(((get-canvas<%>) (instance canvas:basic%)))]{ The result of this method is used to guard the result of the - @method[frame:editor<%> get-canvas\%] + @method[frame:editor<%> get-canvas%] method. } @@ -1837,13 +1826,13 @@ Override this method to specify a different editor class. - Returns the value of the init-field \scheme|editor%|. + Returns the value of the init-field @scheme[editor%]. } @defmethod*[(((get-editor<%>) interface))]{ The result of this method is used by @method[frame:editor<%> make-editor] to check that - @method[frame:editor<%> get-editor\%] + @method[frame:editor<%> get-editor%] is returning a reasonable editor. @@ -1853,14 +1842,14 @@ @defmethod*[(((make-editor) (instance (is-a?/c editor<%>))))]{ This method is called to create the editor in this frame. It calls - @method[frame:editor<%> get-editor<\%>] + @method[frame:editor<%> get-editor<%>] and uses that interface to make sure the result of - @method[frame:editor<%> get-editor\%] + @method[frame:editor<%> get-editor%] is reasonable. - Calls \rawscm{(make-object @method[frame:editor<%> get-editor\%])}. + Calls @scheme[(make-object @method[frame:editor<%> get-editor%])]. } @defmethod*[(((revert) void))]{ @@ -1876,17 +1865,17 @@ if the editor has no filename yet. - Returns \rawscm{\#f} if the user cancels this operation + Returns @scheme[#f] if the user cancels this operation (only possible when the file has not been saved before and the user is prompted for a new filename) and returns - \rawscm{\#t} if not. + @scheme[#t] if not. } @defmethod*[(((save-as (format (union (quote guess) (quote standard) (quote text) (quote text-force-cr) (quote same) (quote copy)) (quote same))) boolean))]{ Queries the use for a file name and saves the file with that name. - Returns \rawscm{\#f} if the user cancells the file-choosing - dialog and returns \rawscm{\#t} otherwise. + Returns @scheme[#f] if the user cancells the file-choosing + dialog and returns @scheme[#t] otherwise. } @defmethod*[(((get-canvas) (instance (subclass?/c canvas%))))]{ Returns the canvas used to display the @@ -1897,8 +1886,6 @@ } @defmethod*[(((get-editor) (instance (is-a?/c editor<%>))))]{ Returns the editor in this frame. - - } } @defmixin[frame:editor-mixin (frame:standard-menus<%>) (frame:editor<%>)]{ @@ -1923,7 +1910,7 @@ } @defmethod*[#:mode override (((editing-this-file? (filename path)) boolean))]{ - Returns \scheme|#t| if the filename is the file that this + Returns @scheme[#t] if the filename is the file that this frame is editing. } @defmethod*[#:mode augment (((on-close) void))]{ @@ -1967,7 +1954,7 @@ } @defmethod*[#:mode override (((file-menu:create-revert?) boolean))]{ - returns \#t + returns #t } @defmethod*[#:mode override (((file-menu:save-callback (item (is-a?/c menu-item%)) (evt (is-a?/c control-event%))) void))]{ @@ -1975,7 +1962,7 @@ } @defmethod*[#:mode override (((file-menu:create-save?) boolean))]{ - returns \#t + returns #t } @defmethod*[#:mode override (((file-menu:save-as-callback (item (is-a?/c menu-item%)) (evt (is-a?/c control-event%))) void))]{ @@ -1986,7 +1973,7 @@ } @defmethod*[#:mode override (((file-menu:create-save-as?) boolean))]{ - returns \#t + returns #t } @defmethod*[#:mode override (((file-menu:print-callback (item (is-a?/c menu-item%)) (evt (is-a?/c control-event%))) void))]{ @@ -1995,14 +1982,14 @@ method of @scheme[editor<%>] with the default arguments, except that - the \var{output-mode} argument + the @scheme[output-mode] argument is the result of calling @scheme[preferences:get] - with \rawscm{'framework:print-output-mode}. + with @scheme['framework:print-output-mode]. } @defmethod*[#:mode override (((file-menu:create-print?) boolean))]{ - returns \#t + returns #t } @defmethod*[#:mode override (((file-menu:between-save-as-and-print (file-menu (is-a?/c menu%))) void))]{ @@ -2029,7 +2016,7 @@ } @defmethod*[#:mode override (((help-menu:create-about?) boolean))]{ - returns \#t + returns #t } } @definterface[frame:open-here<%> (frame:editor<%>)]{ @@ -2037,7 +2024,7 @@ displaying. The frame is only re-used when the - \scheme|'framework:open-here?| preference is set + @scheme['framework:open-here?] preference is set (see @scheme[preferences:get] and @@ -2057,7 +2044,7 @@ } @defmethod*[(((open-here (filename string)) void))]{ - Opens \var{filename} in the current frame, possibly + Opens @scheme[filename] in the current frame, possibly prompting the user about saving a file (in which case the frame might not get switched). } @@ -2067,12 +2054,12 @@ @scheme[frame:open-here<%>] @defmethod*[#:mode override (((file-menu:new-on-demand (item (is-a?/c menu-item%))) void))]{ - Sets the label of \var{item} to - "New..." if the preference \scheme|'framework:open-here?| is set. + Sets the label of @scheme[item] to + @scheme["New..."] if the preference @scheme['framework:open-here?] is set. } @defmethod*[#:mode override (((file-menu:new-callback (item (instance (subclass?/c menu-item%))) (evt (instance control-event%))) void))]{ - When the preference \scheme|'framework:open-here?| + When the preference @scheme['framework:open-here?] preference is set, this method prompts the user, asking if they would like to create a new frame, or just clear out this one. If they clear it out and the file hasn't been @@ -2080,23 +2067,23 @@ } @defmethod*[#:mode override (((file-menu:open-on-demand (item (is-a?/c menu-item%))) void))]{ - Sets the label of \var{item} to - "Open Here..." if the preference \scheme|'framework:open-here?| is set. + Sets the label of @scheme[item] to + "Open Here..." if the preference @scheme['framework:open-here?] is set. } @defmethod*[#:mode augment (((on-close) void))]{ Calls @method[group:% set-open-here-frame] - with \scheme|#f| if + with @scheme[#f] if the result of @method[group:% get-open-here-frame] - is \scheme|eq?| to \scheme|this|. + is @scheme[eq?] to @scheme[this]. } @defmethod*[#:mode override (((on-activate (on? boolean)) void))]{ - When \var{on?} is \scheme|#t|, calls + When @scheme[on?] is @scheme[#t], calls @method[group:% set-open-here-frame] - with \scheme|this|. + with @scheme[this]. } } @definterface[frame:text<%> (frame:editor<%>)]{ @@ -2111,11 +2098,11 @@ @defconstructor[((editor% (extends text%)))]{ Calls the super initialization with either the value of the - \scheme|editor%| init or, if none was supplied, it passes \scheme|text%|. + @scheme[editor%] init or, if none was supplied, it passes @scheme[text%]. } @defmethod*[#:mode override (((get-editor<%>) interface))]{ - Returns \rawscm{(class->interface \iscmclass{text})}. + Returns @scheme[(class->interface @scheme[text%])]. } } @definterface[frame:pasteboard<%> (frame:editor<%>)]{ @@ -2128,27 +2115,27 @@ @defconstructor[((editor% (extends pasteboard%)))]{ Calls the super initialization with either the value of the - \scheme|editor%| init or, if none was supplied, it passes \scheme|pasteboard%|. + @scheme[editor%] init or, if none was supplied, it passes @scheme[pasteboard%]. } @defmethod*[#:mode override (((get-editor<%>) interface))]{ - Returns \rawscm{(class->interface \iscmclass{pasteboard})}. + Returns @scheme[(class->interface @scheme[pasteboard%])]. } } @definterface[frame:delegate<%> (frame:status-line<%> frame:text<%>)]{ Frames that implement this interface provide a 20,000 feet - overview of the text in the main editor. The term {\bf - delegate} in these method descriptions refers to the - original editor and the term {\bf delegatee} refers to the + overview of the text in the main editor. The term @bold{delegate} + in these method descriptions refers to the + original editor and the term @bold{delegatee} refers to the editor showing the 20,000 feet overview. @defmethod*[(((get-delegated-text) (instanceof (is-a?/c text:delegate<%>))))]{ Returns the delegate text. } @defmethod*[(((delegated-text-shown?) boolean))]{ - Returns \rawscm{\#t} if the delegate is visible, and - \rawscm{\#f} if it isn't. + Returns @scheme[#t] if the delegate is visible, and + @scheme[#f] if it isn't. } @defmethod*[(((hide-delegated-text) void))]{ @@ -2158,7 +2145,7 @@ updated. This is accomplished by calling the @method[text:delegate<%> set-delegate] method of - @method[frame:editor<%> get-editor]with \rawscm{\#f}. + @method[frame:editor<%> get-editor]with @scheme[#f]. See also @method[frame:delegate<%> show-delegated-text] @@ -2186,16 +2173,16 @@ } @defmixin[frame:delegate-mixin (frame:status-line<%> frame:text<%>) (frame:delegate<%>)]{ Adds support for a 20,000-feet view via - \iscmintf{text:delegate} and \iscmmixin{text:delegate-mixin} + @scheme[text:delegate<%>] and @scheme[text:delegate-mixin] @defmethod*[#:mode override (((make-root-area-container (class (subclass?/c panel%)) (parent (instanceof (subclass?/c panel%)))) (is-a?/c panel%)))]{ adds a panel outside to hold the delegate - \iscmclass{editor-canvas} and \iscmclass{text}. + @scheme[editor-canvas%] and @scheme[text%]. } @defmethod*[#:mode override (((get-editor<%>) interface))]{ - Returns \iscmintf{text:delegate}. + Returns @scheme[text:delegate]. } @defmethod*[#:mode override (((get-editor%) (is-a?/c text:delegate<%>)))]{ @@ -2227,13 +2214,13 @@ Sets the direction that future searches will be performed. - If \var{dir} is \rawscm{1} searches will be performed forwards and if - \var{dir} is \rawscm{-1} searches will be performed backwards. + If @scheme[dir] is @scheme[1] searches will be performed forwards and if + @scheme[dir] is @scheme[-1] searches will be performed backwards. } @defmethod*[(((replace&search) boolean))]{ Calls @method[frame:searchable<%> replace] - and if it returns \rawscm{\#t}, calls + and if it returns @scheme[#t], calls @method[frame:searchable<%> search-again]. } @@ -2247,14 +2234,14 @@ @defmethod*[(((replace) boolean))]{ If the selected text matches the search string, this method replaces the text with the contents of the replace text. If the replace was - successful, \rawscm{\#t} is returned. Otherwise, \rawscm{\#f} is returned. + successful, @scheme[#t] is returned. Otherwise, @scheme[#f] is returned. } @defmethod*[(((can-replace?) boolean))]{ - Returns \rawscm{\#t} if a replace command would succeed. + Returns @scheme[#t] if a replace command would succeed. - Defaultly is \rawscm{\#t} when the selected text in the result of + Defaultly is @scheme[#t] when the selected text in the result of @method[frame:searchable<%> get-text-to-search] is the same as the text in the find text. } @@ -2285,8 +2272,8 @@ @method[frame:searchable<%> get-text-to-search]. - Returns \rawscm{\#t} if the text is found and sets the selection to the - found text. If the text is not found it returns \rawscm{\#f}. + Returns @scheme[#t] if the text is found and sets the selection to the + found text. If the text is not found it returns @scheme[#f]. } } @defmixin[frame:searchable-mixin (frame:standard-menus<%>) (frame:searchable<%>)]{ @@ -2303,20 +2290,20 @@ } @defmethod*[#:mode override (((edit-menu:create-find?) boolean))]{ - returns \#t + returns #t } @defmethod*[#:mode override (((edit-menu:find-again-callback) boolean))]{ - Returns \rawscm{\#t}, and searches for the same text that was last + Returns @scheme[#t], and searches for the same text that was last searched for in the text. } @defmethod*[#:mode override (((edit-menu:create-find-again?) boolean))]{ - returns \#t + returns #t } @defmethod*[#:mode override (((edit-menu:replace-and-find-again-callback) boolean))]{ - Returns \rawscm{\#t}, and if the selected text matches the current text + Returns @scheme[#t], and if the selected text matches the current text in the find box, replaces it with the contents of the replace box and searches for the next occurrence of the text in the find box. @@ -2324,14 +2311,14 @@ } @defmethod*[#:mode override (((edit-menu:replace-and-find-again-on-demand (item menu-item%)) void))]{ - Disables \var{item} when + Disables @scheme[item] when @method[frame:searchable<%> can-replace?] - returns \rawscm{\#f} and enables it when that method returns - \rawscm{\#t}. + returns @scheme[#f] and enables it when that method returns + @scheme[#t]. } @defmethod*[#:mode override (((edit-menu:create-replace-and-find-again?) boolean))]{ - returns \#t + returns @scheme[#t] } @defmethod*[#:mode override (((make-root-area-container) (is-a?/c area-container<%>)))]{ diff --git a/collects/scribblings/framework/group.scrbl b/collects/scribblings/framework/group.scrbl index 42fc53eccc..b0128b248d 100644 --- a/collects/scribblings/framework/group.scrbl +++ b/collects/scribblings/framework/group.scrbl @@ -61,7 +61,7 @@ @method[group:% get-frames]. - Applies \var{f} to each frame in the group + Applies @scheme[f] to each frame in the group } @defmethod*[(((get-active-frame) (is-a?/c frame:basic<%>)))]{ Returns the frame with the keyboard focus or the first frame in the @@ -94,14 +94,14 @@ The function @method[group:% can-close-all?] must have been called just before this function and it must have returned - \rawscm{\#t}. + @scheme[#t]. Calls the @method[top-level-window<%> on-close] method and the @method[top-level-window<%> show] - method (with \rawscm{\#f} as argument) + method (with @scheme[#f] as argument) on each frame in the group. } @defmethod*[(((can-close-all?) void))]{ diff --git a/collects/scribblings/framework/keymap.scrbl b/collects/scribblings/framework/keymap.scrbl index 5e7db0f578..bca27e9b0d 100644 --- a/collects/scribblings/framework/keymap.scrbl +++ b/collects/scribblings/framework/keymap.scrbl @@ -5,7 +5,7 @@ @title{Keymap} @definterface[keymap:aug-keymap<%> (keymap%)]{ - This keymap overrides some of the built in \iscmclass{keymap} methods + This keymap overrides some of the built in @scheme[keymap%] methods to be able to extract the keybindings from the keymap. @defmethod*[(((get-chained-keymaps) (listof (instance keymap%))))]{ @@ -22,7 +22,7 @@ @method[keymap:aug-keymap<%> get-map-function-table] that returns the same result, except it accepts a hash-table that it inserts the bindings into. It does not replace any bindings already in - \var{ht}. + @scheme[ht]. } } @defmixin[keymap:aug-keymap-mixin (keymap%) (keymap:aug-keymap<%>)]{ diff --git a/collects/scribblings/framework/menu.scrbl b/collects/scribblings/framework/menu.scrbl index 4c4bc63e51..b02bbd0735 100644 --- a/collects/scribblings/framework/menu.scrbl +++ b/collects/scribblings/framework/menu.scrbl @@ -21,8 +21,8 @@ via the \& characters in the original labels) in their labels. - If the preference \scm{'framework:menu-bindings} - is \scm{\#f}, calls + If the preference @scheme['framework:menu-bindings] + is @scheme[#f], calls @method[menu:can-restore-underscore<%> erase-underscores] during initialization. @defmethod*[(((erase-underscores) void))]{ diff --git a/collects/scribblings/framework/panel.scrbl b/collects/scribblings/framework/panel.scrbl index 3d2233ed0b..cb97fc4211 100644 --- a/collects/scribblings/framework/panel.scrbl +++ b/collects/scribblings/framework/panel.scrbl @@ -9,7 +9,7 @@ @scheme[panel:single-mixin%]. @defmethod*[(((active-child (child (is-a?/c area<%>))) void) ((active-child) (is-a?/c area<%>)))]{ - Sets the active child to be \var{child} + Sets the active child to be @scheme[child] Returns the current active child. @@ -17,7 +17,7 @@ } @defmixin[panel:single-mixin (area-container<%>) (panel:single<%>)]{ This mixin adds single panel functionality to an implementation of the - \iscmintf{area-container} interface. + @scheme[area-container<%>] interface. Single panels place all of the children in the center of the panel, and allow make one child to be visible at a time. The @@ -29,7 +29,7 @@ method is used to hide and show the children of a single panel. @defmethod*[#:mode override (((after-new-child (child subarea<%>)) void))]{ - Hides this child by calling \scmline{(send child show \#f)}, unless + Hides this child by calling @scheme[(send child show #f)], unless this is the first child in which case it does nothing. } @defmethod*[#:mode override (((container-size) (values exact-integer exact-integer)))]{ @@ -77,7 +77,7 @@ takes up of the panel. - The argument, \var{new-percentages} must be a list of + The argument, @scheme[new-percentages] must be a list of numbers that sums to 1. It's length must be equal to the number of children of the panel (see @method[area-container<%> get-children]) and each percentage must correspond to a number of pixels @@ -93,8 +93,8 @@ This method controls the behavior of the other overridden methods in mixins that implement this interface. - If it returns \scheme|#t|, the panel will be vertically - aligned and if it returns \scheme|#f|, they will be + If it returns @scheme[#t], the panel will be vertically + aligned and if it returns @scheme[#f], they will be horizontally aligned. } @@ -148,10 +148,10 @@ @method[panel:dragable<%> get-vertical?] method of the @scheme[panel:dragable-mixin] - to return \scheme|#t|. + to return @scheme[#t]. @defmethod*[#:mode override (((get-vertical?) boolean))]{ - Returns \scheme|#t|. + Returns @scheme[#t]. } } @defmixin[panel:horizontal-dragable-mixin (panel:dragable<%>) (panel:vertical-dragable<%>)]{ @@ -159,10 +159,10 @@ @method[panel:dragable<%> get-vertical?] method of the @scheme[panel:dragable-mixin] - to return \scheme|#f|. + to return @scheme[#f]. @defmethod*[#:mode override (((get-vertical?) boolean))]{ - Returns \scheme|#f|. + Returns @scheme[#f]. } } @defclass[panel:vertical-dragable% (panel:vertical-dragable-mixin (panel:dragable-mixin vertical-panel%)) ()]{} diff --git a/collects/scribblings/framework/scheme.scrbl b/collects/scribblings/framework/scheme.scrbl index 941585ddf0..5f33177ef7 100644 --- a/collects/scribblings/framework/scheme.scrbl +++ b/collects/scribblings/framework/scheme.scrbl @@ -39,17 +39,17 @@ @defmethod*[(((get-limit (start exact-integer)) int))]{ Returns a limit for backward-matching parenthesis starting at position - \var{start}. + @scheme[start]. } @defmethod*[(((balance-parens (key-event (instance key-event%))) void))]{ This function is called when the user types a close parenthesis in the @scheme[text%]. If the close parenthesis that the user inserted does not match the - corresponding open parenthesis and the \rawscm{'framework:fixup-parens} preference is - \rawscm{\#t} (see + corresponding open parenthesis and the @scheme['framework:fixup-parens] preference is + @scheme[#t] (see @scheme[preferences:get]) the correct closing parenthesis is inserted. - If the \rawscm{'framework:paren-match} preference is - \rawscm{\#t} (see + If the @scheme['framework:paren-match] preference is + @scheme[#t] (see @scheme[preferences:get]) the matching open parenthesis is flashed. } @@ -61,15 +61,15 @@ } - @defmethod*[(((tabify (start-pos exact-integer (send this iscmclassmethod (text) (get-start-position)))) void))]{ + @defmethod*[(((tabify (start-pos exact-integer (send this text get-start-position))) void))]{ - Tabs the line containing by \var{start-pos} + Tabs the line containing by @scheme[start-pos] } @defmethod*[(((tabify-selection (start exact-integer) (end exact-integer)) void))]{ - Sets the tabbing for the lines containing positions \var{start} - through \var{end}. + Sets the tabbing for the lines containing positions @scheme[start] + through @scheme[end]. } @defmethod*[(((tabify-all) void))]{ @@ -79,49 +79,49 @@ Inserts a newline into the buffer. If @method[scheme:text<%> tabify-on-return?] - returns \rawscm{\#t}, this will tabify the new line. + returns @scheme[#t], this will tabify the new line. } - @defmethod*[(((box-comment-out-selection (start-pos (union (quote start) exact-integer) rawscm) (end-pos (union (quote end) exact-integer) rawscm)) void))]{ + @defmethod*[(((box-comment-out-selection (start-pos (or/c (symbols 'start) exact-integer?)) (end-pos (or/c (symbols 'end) exact-integer?))) void))]{ This method comments out a selection in the text by putting it into a comment box. - Removes the region from \var{start-pos} to \var{end-pos} + Removes the region from @scheme[start-pos] to @scheme[end-pos] from the editor and inserts a comment box with that region of text inserted into the box. - If \var{start-pos} is \rawscm{'start}, the starting point of - the selection is used. If \var{end-pos} is \rawscm{'end}, + If @scheme[start-pos] is @scheme['start], the starting point of + the selection is used. If @scheme[end-pos] is @scheme['end], the ending point of the selection is used. } @defmethod*[(((comment-out-selection (start exact-integer) (end exact-integer)) void))]{ - Comments the lines containing positions \var{start} through \var{end} + Comments the lines containing positions @scheme[start] through @scheme[end] by inserting a semi-colon at the front of each line. } @defmethod*[(((uncomment-selection (start int) (end int)) void))]{ - Uncomments the lines containing positions \var{start} through \var{end}. + Uncomments the lines containing positions @scheme[start] through @scheme[end]. } @defmethod*[(((get-forward-sexp (start exact-integer)) (union |#f| exact-integer)))]{ Returns the position of the end of next S-expression after position - \var{start}, or \rawscm{\#f} if there is no appropriate answer. + @scheme[start], or @scheme[#f] if there is no appropriate answer. } @defmethod*[(((remove-sexp (start exact-integer)) void))]{ - Forward-deletes the S-expression starting after the position \var{start}. + Forward-deletes the S-expression starting after the position @scheme[start]. } @defmethod*[(((forward-sexp (start |#t|)) exact-integer))]{ - Moves forward over the S-expression starting at position \var{start}. + Moves forward over the S-expression starting at position @scheme[start]. } @defmethod*[(((flash-forward-sexp (start-pos exact-integer)) void))]{ Flashes the parenthesis that closes the sexpression at - \var{start-pos}. + @scheme[start-pos]. } @@ -129,13 +129,13 @@ Returns the position of the start of the S-expression before or - containing \var{start}, or \rawscm{\#f} if there is no appropriate + containing @scheme[start], or @scheme[#f] if there is no appropriate answer. } @defmethod*[(((flash-backward-sexp (start-pos exact-integer)) void))]{ Flashes the parenthesis that opens the sexpression at - \var{start-pos}. + @scheme[start-pos]. } @defmethod*[(((backward-sexp (start-pos exact-integer)) void))]{ @@ -143,62 +143,62 @@ Moves the caret to the beginning of the sexpression that ends at - \var{start-pos}. + @scheme[start-pos]. } @defmethod*[(((find-up-sexp (start-pos exact-integer)) (union |#f| exact-integer)))]{ Returns the position of the beginning of the next sexpression outside - the sexpression that contains \var{start-pos}. If there is no such - sexpression, it returns \rawscm{\#f}. + the sexpression that contains @scheme[start-pos]. If there is no such + sexpression, it returns @scheme[#f]. } @defmethod*[(((up-sexp (start exact-integer)) void))]{ - Moves backward out of the S-expression containing the position \var{start}. + Moves backward out of the S-expression containing the position @scheme[start]. } @defmethod*[(((find-down-sexp (start-pos exact-integer)) (union |#f| exact-integer)))]{ Returns the position of the beginning of the next sexpression inside - the sexpression that contains \var{start-pos}. If there is no such - sexpression, it returns \rawscm{\#f}. + the sexpression that contains @scheme[start-pos]. If there is no such + sexpression, it returns @scheme[#f]. } @defmethod*[(((down-sexp (start exact-integer)) void))]{ - Moves forward into the next S-expression after the position \var{start}. + Moves forward into the next S-expression after the position @scheme[start]. } @defmethod*[(((remove-parens-forward (start exact-integer)) void))]{ Removes the parentheses from the S-expression starting after the - position \var{start}. + position @scheme[start]. } @defmethod*[(((select-forward-sexp (start exact-integer)) |#t|))]{ - Selects the next S-expression, starting at position \var{start}. + Selects the next S-expression, starting at position @scheme[start]. } @defmethod*[(((select-backward-sexp (start exact-integer)) |#t|))]{ - Selects the previous S-expression, starting at position \var{start}. + Selects the previous S-expression, starting at position @scheme[start]. } @defmethod*[(((select-up-sexp (start exact-integer)) |#t|))]{ - Selects the region to the enclosing S-expression, starting at position \var{start}. + Selects the region to the enclosing S-expression, starting at position @scheme[start]. } @defmethod*[(((select-down-sexp (start exact-integer)) |#t|))]{ - Selects the region to the next contained S-expression, starting at position \var{start}. + Selects the region to the next contained S-expression, starting at position @scheme[start]. } @defmethod*[(((transpose-sexp (start exact-integer)) void))]{ - Swaps the S-expression beginning before the position \var{start} with - the next S-expression following \var{start}. + Swaps the S-expression beginning before the position @scheme[start] with + the next S-expression following @scheme[start]. } @defmethod*[(((mark-matching-parenthesis (pos exact-positive-integer)) void))]{ - If the paren after \var{pos} is matched, this method + If the paren after @scheme[pos] is matched, this method highlights it and it's matching counterpart in dark green. } @@ -230,7 +230,7 @@ The result of this mixin uses the same initialization arguments as the mixin's argument. @defmethod*[#:mode override (((get-word-at (pos positive-exact-integer)) string))]{ - Returns the word just before \var{pos}, which is then used + Returns the word just before @scheme[pos], which is then used as the prefix for auto-completion. } diff --git a/collects/scribblings/framework/test.scrbl b/collects/scribblings/framework/test.scrbl index aaf4d89d64..e6ce261d24 100644 --- a/collects/scribblings/framework/test.scrbl +++ b/collects/scribblings/framework/test.scrbl @@ -97,7 +97,7 @@ The code started by the primitive actions must run in the handler thread of the eventspace where the event takes place. As a result, the test suite that invokes the primitive actions must @italic{not} run in that handler thread (or else some actions will deadlock). See -\Mrhyperref{the eventspace section}{see section~}{}{eventspaceinfo} +@scheme[make-eventspace] for more info. @subsection{Window Manager (Unix only)} diff --git a/collects/scribblings/framework/text.scrbl b/collects/scribblings/framework/text.scrbl index 995db85197..1d78ada317 100644 --- a/collects/scribblings/framework/text.scrbl +++ b/collects/scribblings/framework/text.scrbl @@ -11,23 +11,23 @@ This function highlights a region of text in the buffer. - The range between \var{start} and \var{end} will be highlighted with the - color in color, and \var{bitmap} will be painted over the range of text in - black and white. If \var{bitmap} is \rawscm{\#f}, the range will be inverted, + The range between @scheme[start] and @scheme[end] will be highlighted with the + color in color, and @scheme[bitmap] will be painted over the range of text in + black and white. If @scheme[bitmap] is @scheme[#f], the range will be inverted, using the platform specific xor. This method is not recommended, because the selection is also displayed using xor. - If \var{caret-space?} is not \rawscm{\#f}, the left edge of the range + If @scheme[caret-space?] is not @scheme[#f], the left edge of the range will be one pixel short, to leave space for the caret. The caret does not interfere with the right hand side of the range. Note that under X windows the caret is drawn with XOR, which means almost anything can happen. So if the caret is in the middle of the range it may be hard - to see, or if it is on the left of the range and \var{caret-space?} is - \rawscm{\#f} it may also be hard to see. + to see, or if it is on the left of the range and @scheme[caret-space?] is + @scheme[#f] it may also be hard to see. - The \var{priority} argument indicates the relative priority for + The @scheme[priority] argument indicates the relative priority for drawing overlapping regions. If two regions overlap and have different - priorities, the region with \rawscm{'high} priority will be drawn second + priorities, the region with @scheme['high] priority will be drawn second and only it will be visible in the overlapping region. This method returns a thunk, which, when invoked, will turn off @@ -52,12 +52,12 @@ ranges in the editor. } @defmethod*[(((get-styles-fixed) boolean))]{ - If the result of this function is \rawscm{\#t}, the styles in this + If the result of this function is @scheme[#t], the styles in this @scheme[text:basic<%>] will be fixed. This means that any text inserted to this editor has its style set to this editor's - @scheme[style-list%]'s \rawscm{"Standard"} style. + @scheme[style-list%]'s @scheme["Standard"] style. See also @method[text:basic<%> set-styles-fixed]. @@ -80,12 +80,12 @@ This moves or copies text and snips to another edit. - Moves or copies from the edit starting at \var{start} and ending at - \var{end}. It puts the copied text and snips in \var{dest-text} - starting at location \var{dest-pos}. + Moves or copies from the edit starting at @scheme[start] and ending at + @scheme[end]. It puts the copied text and snips in @scheme[dest-text] + starting at location @scheme[dest-pos]. If a snip refused to be moved, it will be copied, otherwise it will be - moved. A snip may refuse to be moved by returning \rawscm{\#f} from + moved. A snip may refuse to be moved by returning @scheme[#f] from @method[snip% release-from-owner]. } @defmethod*[(((initial-autowrap-bitmap) (union |#f| (instance bitmap%))))]{ @@ -108,9 +108,9 @@ } @defmethod*[(((port-name-matches? (id (or/c path? symbol?))) boolean))]{ - Indicates if \var{id} matches the port name of this file. If + Indicates if @scheme[id] matches the port name of this file. If the file is saved, the port name matches when the save file - is the path as \var{id}. If the file has not been saved, the + is the path as @scheme[id]. If the file has not been saved, the port name matches if the symbol is the same as the result of @method[text:basic<%> port-name-matches?]. @@ -144,7 +144,7 @@ @method[editor<%> put-file] but uses @scheme[finder:put-file] - instead of \scheme|put-file|. + instead of @scheme[put-file]. } } @@ -184,8 +184,7 @@ } @definterface[text:nbsp->space<%> (text%)]{ Classes that implement this interface silently change - non-breaking spaces, ie the character \scheme|(integer->char - 160)|, to regular spaces when inserted into the editor. + non-breaking spaces, ie the character @scheme[(integer->char 160)], to regular spaces when inserted into the editor. } @defmixin[text:nbsp->space-mixin (text%) (text:nbsp->space<%>)]{ @@ -197,10 +196,8 @@ @defmethod*[#:mode augment (((after-insert (start nonnegative-exact-integer?) (len nonnegative-exact-integer?)) void))]{ Replaces all non-breaking space characters - \begin{schemedisplay} - (integer->char 160) - \end{schemedisplay} - by \scheme|#\space| characters. + @scheme[(integer->char 160)] + by @scheme[#\space] characters. Ends the edit sequence (by calling @method[editor<%> end-edit-sequence]) started in @@ -236,7 +233,7 @@ } @defmethod*[#:mode override (((on-local-char (event (is-a?/c key-event%))) void))]{ - If \var{key} is either return or newline, only invoke the \var{return} + If @scheme[key] is either return or newline, only invoke the @scheme[return] thunk (initialization argument) and do nothing else. } } @@ -277,9 +274,9 @@ editor are kept in sync, as modifications to this object happen. @defmethod*[(((get-delegate) (union |#f| (instanceof text%))))]{ - The result of this method is the \iscmclass{text} object + The result of this method is the @scheme[text%] object that the contents of this editor are being delegated to, or - \rawscm{\#f}, if there is none. + @scheme[#f], if there is none. } @defmethod*[(((set-delegate (delegate (union |#f| (instanceof text%)))) void))]{ @@ -287,9 +284,9 @@ When it is set, all of the snips are copied from this object - to \var{delegate}. Additionally, if this object implements + to @scheme[delegate]. Additionally, if this object implements @scheme[scheme:text<%>] - the tab settings of \var{delegate} are updated to match this + the tab settings of @scheme[delegate] are updated to match this objects. } } @@ -365,7 +362,7 @@ Sets the descent, space, lspace, and rspace to zero. Sets the height to 1. Sets the width to the width of tabs as - returned in the \scm{tab-width} parameter of the + returned in the @scheme[tab-width] parameter of the @method[text% get-tabs] method. @@ -502,7 +499,7 @@ When files are saved from this @scheme[text%], a check is made to see if there are any non-@scheme[string-snip%] objects in the - @scheme[text%]. If so, it is saved using the file format \rawscm{'std}. (see + @scheme[text%]. If so, it is saved using the file format @scheme['std]. (see @method[text% set-file-format] for more information. If not, the file format passed to @method[editor<%> save-file] @@ -511,18 +508,18 @@ If the method @method[text% get-file-format] - returns \rawscm{'standard} and the text has only - @scheme[string-snip%]s, the file format is set to \rawscm{'text}. + returns @scheme['standard] and the text has only + @scheme[string-snip%]s, the file format is set to @scheme['text]. If the method @method[text% get-file-format] - returns \rawscm{'text} and the text has some non - @scheme[string-snip%]s, the file format is set to \rawscm{'standard}. + returns @scheme['text] and the text has some non + @scheme[string-snip%]s, the file format is set to @scheme['standard]. Depending on the user's preferences, the user may also be queried. Also, the changes to the file format only happen if the argument - \var{file-format} is \rawscm{'copy} or \rawscm{'same}. + @scheme[file-format] is @scheme['copy] or @scheme['same]. } } @definterface[text:file<%> (editor:file<%> text:basic<%>)]{ @@ -535,7 +532,7 @@ @defmethod*[(((while-unlocked (thunk (-> any/c))) any/c))]{ Unlocks the editor, calls the thunk, and then relocks the - editor, all using a \scheme{dynamic-wind}. + editor, all using a @scheme[dynamic-wind]. } } @defmixin[text:file-mixin (editor:file<%> text:basic<%>) (text:file<%>)]{ @@ -544,14 +541,14 @@ Returns false if the result of @method[text:file<%> get-read-write?] is true, otherwise returns the - result of calling \scheme|inner|. + result of calling @scheme[inner]. } @defmethod*[#:mode augment (((can-delete? (start number) (len number)) boolean))]{ Returns false if the result of @method[text:file<%> get-read-write?] is true, otherwise returns the - result of calling \scheme|inner|. + result of calling @scheme[inner]. } @defmethod*[#:mode augment (((after-save-file) void))]{ @@ -606,11 +603,11 @@ output ports (one for each input port and one for all of the output ports). @defmethod*[(((delete/io (start exact-integer) (end exact-integer)) void))]{ - Deletes the text between \var{start} and \var{end} without + Deletes the text between @scheme[start] and @scheme[end] without changing the behavior of the ports (otherwise, deleting the text would break internal invariants of the port). - Both \var{start} and \var{end} must be less than + Both @scheme[start] and @scheme[end] must be less than @method[text:ports<%> get-insertion-point] (or else it is safe to delete them so you don't need this method). @@ -681,7 +678,7 @@ be submitted to the input port. - Return \scheme|#t| or the result of calling \scheme|inner|. + Return @scheme[#t] or the result of calling @scheme[inner]. } @defmethod*[(((on-submit) void))]{ This method is called when text is sent into the input port. @@ -723,13 +720,13 @@ @method[text:ports<%> get-out-port]. If the result is a string that is not mapped in the editor's - style list, the style named \scheme|"Standard"| is used and - if that isn't mapped, the style named \scheme|"Basic"| is used. + style list, the style named @scheme["Standard"] is used and + if that isn't mapped, the style named @scheme["Basic"] is used. This method is called during the initialization of the class. - Defaultly returns \scheme|"text:ports out"| which is mapped + Defaultly returns @scheme["text:ports out"] which is mapped to a blue style in the style list returned by @scheme[editor:get-standard-style-list]. } @@ -739,13 +736,13 @@ @method[text:ports<%> get-err-port]. If the result is a string that is not mapped in the editor's - style list, the style named \scheme|"Standard"| is used and - if that isn't mapped, the style named \scheme|"Basic"| is used. + style list, the style named @scheme["Standard"] is used and + if that isn't mapped, the style named @scheme["Basic"] is used. This method is called during the initialization of the class. - Defaultly returns \scheme|"text:ports err"| which is mapped + Defaultly returns @scheme["text:ports err"] which is mapped to a red italic style in the style list returned by @scheme[editor:get-standard-style-list]. } @@ -755,14 +752,14 @@ @method[text:ports<%> get-value-port]. If the result is a string that is not mapped in the editor's - style list, the style named \scheme|"Standard"| is used and - if that isn't mapped, the style named \scheme|"Basic"| is used. + style list, the style named @scheme["Standard"] is used and + if that isn't mapped, the style named @scheme["Basic"] is used. This method is called during the initialization of the class. - Defaultly returns \scheme|"text:ports value"| which is mapped + Defaultly returns @scheme["text:ports value"] which is mapped to a blue style in the style list returned by @scheme[editor:get-standard-style-list]. @@ -811,9 +808,9 @@ snips that is inserted by the box port in this editor. } - @defmethod*[(((get-box-input-text%) (implements iscmmixin (text:input-box))))]{ + @defmethod*[(((get-box-input-text%) (is-a?/c text:input-box)))]{ The result of this method is instantiated and placed inside the result of - @method[text:ports<%> get-box-input-editor-snip\%]. + @method[text:ports<%> get-box-input-editor-snip%]. } } @@ -821,15 +818,15 @@ @defmethod*[#:mode augment (((can-insert? (start exact-integer) (len exact-integer)) boolean))]{ - Returns the results of the \scheme|inner| call, unless + Returns the results of the @scheme[inner] call, unless @method[text:ports<%> get-allow-edits] - returns \scheme|#f|. + returns @scheme[#f]. } @defmethod*[#:mode augment (((can-delete? (start exact-integer) (len exact-integer)) boolean))]{ - Returns the results of the \scheme|inner| call, unless + Returns the results of the @scheme[inner] call, unless @method[text:ports<%> get-allow-edits] - returns \scheme|#f|. + returns @scheme[#f]. } @defmethod*[#:mode override (((on-local-char (event (is-a?/c key-event%))) void))]{ @@ -837,7 +834,7 @@ @method[text:ports<%> get-unread-start-point] to the input port, unless @method[text:ports<%> submit-to-port?] - returns \scheme|#f|. + returns @scheme[#f]. Also calls @method[text:ports<%> on-submit]. @@ -877,17 +874,17 @@ } @defmethod*[(((get-autocomplete-border-color) (or/c string? (is-a?/c color%))))]{ The border color for the autocomplete menu. Defaults to - \scheme|"black"|. + @scheme["black"]. } @defmethod*[(((get-autocomplete-background-color) (or/c string? (is-a?/c color%))))]{ The background color for the non-selected menu - items. Defaults to \scheme|"lavender"|. + items. Defaults to @scheme["lavender"]. } @defmethod*[(((get-autocomplete-selected-color) (or/c string? (is-a?/c color%))))]{ The background color for the selected menu item. Defaults to - \scheme|(make-object color% 204 153 255)|. + @scheme[(make-object color% 204 153 255)]. } @defmethod*[(((completion-mode-key-event? (key-event key-event%)) boolean))]{