turn on GUI doc generation in scribblings setup

svn: r7118

original commit: 190b8f6e21d10486c9bac51a5e09937ab92dd7a3
This commit is contained in:
Matthew Flatt 2007-08-18 22:37:36 +00:00
parent 77167bb3c0
commit ccf8eccf1a
61 changed files with 295 additions and 221 deletions

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["area-intf.scrbl"]
@definterface[area-container<%> (area<%>)]{ @definterface[area-container<%> (area<%>)]{

View File

@ -1,5 +1,7 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["area-container-intf.scrbl"]
@require["window-intf.scrbl"]
@definterface[area-container-window<%> (area-container<%> window<%>)]{ @definterface[area-container-window<%> (area-container<%> window<%>)]{

View File

@ -1,6 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["control-intf.scrbl"]
@defclass[button% object% (control<%>)]{ @defclass[button% object% (control<%>)]{
@ -56,11 +56,14 @@ on-traverse-char]). @DeletedStyleNote{button}
@FontKWs[] @WindowKWs[] @SubareaKWs[] @AreaKWs[]} @FontKWs[] @WindowKWs[] @SubareaKWs[] @AreaKWs[]}
@defmethod[#:mode 'add @defmethod[#:mode override
(set-label [label (is-a?/c bitmap%)]) (set-label [label (or/c label-string? (is-a?/c bitmap%))])
void?]{ void?]{
Sets the bitmap label for a bitmap button. @bitmaplabeluseisbm[label] The same as @xmethod[window<%> set-label] when @scheme[label] is a
string.
Otherwise, sets the bitmap label for a bitmap button. @bitmaplabeluseisbm[label]
@|bitmapiforiglabel| @|bitmapiforiglabel|
}} }}

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["canvas-intf.scrbl"]
@defclass[canvas% object% (canvas<%>)]{ @defclass[canvas% object% (canvas<%>)]{
@ -269,7 +270,7 @@ See also
} }
@defmethod[#:mode 'override @defmethod[#:mode override
(on-paint) (on-paint)
void?]{ void?]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["subwindow-intf.scrbl"]
@definterface[canvas<%> (subwindow<%>)]{ @definterface[canvas<%> (subwindow<%>)]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["control-intf.scrbl"]
@defclass[check-box% object% (control<%>)]{ @defclass[check-box% object% (control<%>)]{
@ -53,16 +54,16 @@ Gets the state of the check box: @scheme[#t] if it is checked, @scheme[#f]
} }
@defmethod[#:mode 'add @defmethod[#:mode override
(set-label [label (is-a?/c bitmap%)]) (set-label [label (or/c label-string? (is-a?/c bitmap%))])
void?]{ void?]{
Sets the bitmap label for a bitmap check box. The same as @xmethod[window<%> set-label] when @scheme[label] is a
string.
Otherwise, sets the bitmap label for a bitmap check box.
@bitmaplabeluseisbm[label] @|bitmapiforiglabel| @bitmaplabeluseisbm[label] @|bitmapiforiglabel|
} }
@defmethod[(set-value [state any/c]) @defmethod[(set-value [state any/c])

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["selectable-menu-item-intf.scrbl"]
@defclass[checkable-menu-item% object% (selectable-menu-item<%>)]{ @defclass[checkable-menu-item% object% (selectable-menu-item<%>)]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["list-control-intf.scrbl"]
@defclass[choice% object% (list-control<%>)]{ @defclass[choice% object% (list-control<%>)]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["text-field-class.scrbl"]
@defclass[combo-field% text-field% ()]{ @defclass[combo-field% text-field% ()]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["event-class.scrbl"]
@defclass[control-event% event% ()]{ @defclass[control-event% event% ()]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["subwindow-intf.scrbl"]
@definterface[control<%> (subwindow<%>)]{ @definterface[control<%> (subwindow<%>)]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["top-level-window-intf.scrbl"]
@defclass[dialog% object% (top-level-window<%>)]{ @defclass[dialog% object% (top-level-window<%>)]{
@ -78,7 +79,7 @@ Even if the dialog is not shown, a few notification events may be
@WindowKWs[] @AreaContKWs[] @AreaKWs[] @WindowKWs[] @AreaContKWs[] @AreaKWs[]
} }
@defmethod[#:mode 'override @defmethod[#:mode override
(on-subwindow-char [receiver (is-a?/c window<%>)] (on-subwindow-char [receiver (is-a?/c window<%>)]
[event (is-a?/c key-event%)]) [event (is-a?/c key-event%)])
boolean?]{ boolean?]{
@ -92,7 +93,7 @@ Returns the result of
} }
@defmethod[#:mode 'auto-super @defmethod[#:mode override
(show [show? any/c]) (show [show? any/c])
void?]{ void?]{
@ -108,7 +109,5 @@ If @scheme[show?] is true, the method does not immediately return. Instead,
@scheme[yield] to avoid a busy-wait, and to ensure that the @scheme[show] @scheme[yield] to avoid a busy-wait, and to ensure that the @scheme[show]
method returns as soon as possible after the dialog is hidden. method returns as soon as possible after the dialog is hidden.
} }
} }

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["canvas-intf.scrbl"]
@defclass[editor-canvas% object% (canvas<%>)]{ @defclass[editor-canvas% object% (canvas<%>)]{
@ -198,7 +199,7 @@ Enables or disables lazy-refresh mode, or gets the current enable
} }
@defmethod[#:mode 'override @defmethod[#:mode override
(on-char [event (is-a?/c key-event%)]) (on-char [event (is-a?/c key-event%)])
void?]{ void?]{
@ -211,7 +212,7 @@ See also @method[editor-canvas% get-editor].
} }
@defmethod[#:mode 'override @defmethod[#:mode override
(on-event [event (is-a?/c mouse-event%)]) (on-event [event (is-a?/c mouse-event%)])
void?]{ void?]{
@ -222,7 +223,7 @@ See also @method[editor-canvas% get-editor].
} }
@defmethod[#:mode 'override @defmethod[#:mode override
(on-focus [on? any/c]) (on-focus [on? any/c])
void?]{ void?]{
@ -231,7 +232,7 @@ Enables or disables the caret in the @techlink{display}'s editor, if
} }
@defmethod[#:mode 'override @defmethod[#:mode override
(on-paint) (on-paint)
void?]{ void?]{
@ -239,7 +240,7 @@ Repaints the editor.
} }
@defmethod[#:mode 'override @defmethod[#:mode override
(on-size [width (integer-in 0 10000)] (on-size [width (integer-in 0 10000)]
[height (integer-in 0 10000)]) [height (integer-in 0 10000)])
void?]{ void?]{

View File

@ -1,6 +1,7 @@
#reader(lib "docreader.ss" "scribble") #reader(lib "docreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["diagrams.ss"] @require["diagrams.ss"]
@require["mred-classes.ss"]
@title[#:style '(toc quiet)]{Editor Classes} @title[#:style '(toc quiet)]{Editor Classes}
@ -28,38 +29,6 @@ Alphabetical:
@local-table-of-contents[] @local-table-of-contents[]
@require["add-color-intf.scrbl"]
@require["editor-intf.scrbl"]
@require["editor-admin-class.scrbl"]
@require["editor-canvas-class.scrbl"]
@require["editor-data-class.scrbl"]
@require["editor-data-class-class.scrbl"]
@require["editor-data-class-list-intf.scrbl"]
@require["editor-snip-editor-admin-intf.scrbl"]
@require["editor-snip-class.scrbl"]
@require["editor-stream-in-class.scrbl"]
@require["editor-stream-in-base-class.scrbl"]
@require["editor-stream-in-bytes-base-class.scrbl"]
@require["editor-stream-out-class.scrbl"]
@require["editor-stream-out-base-class.scrbl"]
@require["editor-stream-out-bytes-base-class.scrbl"]
@require["editor-wordbreak-map-class.scrbl"]
@require["image-snip-class.scrbl"]
@require["keymap-class.scrbl"]
@require["mult-color-intf.scrbl"]
@require["pasteboard-class.scrbl"]
@require["readable-snip-intf.scrbl"]
@require["snip-class.scrbl"]
@require["snip-admin-class.scrbl"]
@require["snip-class-class.scrbl"]
@require["snip-class-list-intf.scrbl"]
@require["string-snip-class.scrbl"]
@require["style-intf.scrbl"]
@require["style-delta-class.scrbl"]
@require["style-list-class.scrbl"]
@require["tab-snip-class.scrbl"]
@require["text-class.scrbl"]
@include-class[add-color<%>] @include-class[add-color<%>]
@include-class[editor<%>] @include-class[editor<%>]
@include-class[editor-admin%] @include-class[editor-admin%]

View File

@ -93,7 +93,7 @@ pasteboard editor, the default cursor is an arrow.
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(after-edit-sequence) (after-edit-sequence)
void?]{ void?]{
@ -115,7 +115,7 @@ Does nothing.
} }
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(after-load-file [success? any/c]) (after-load-file [success? any/c])
void?]{ void?]{
@ -140,7 +140,7 @@ Does nothing.
} }
} }
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(after-save-file [success? any/c]) (after-save-file [success? any/c])
void?]{ void?]{
@ -280,7 +280,7 @@ locked, etc.
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(can-load-file? [filename path?] (can-load-file? [filename path?]
[format (one-of/c 'guess 'standard 'text 'text-force-cr 'same 'copy)]) [format (one-of/c 'guess 'standard 'text 'text-force-cr 'same 'copy)])
boolean?]{ boolean?]{
@ -305,7 +305,7 @@ Returns @scheme[#t].
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(can-save-file? [filename path?] (can-save-file? [filename path?]
[format (one-of/c 'guess 'standard 'text 'text-force-cr 'same 'copy)]) [format (one-of/c 'guess 'standard 'text 'text-force-cr 'same 'copy)])
boolean?]{ boolean?]{
@ -336,7 +336,7 @@ Returns @scheme[#t].
void?])]{ void?])]{
Changes the style for @techlink{items} in the editor, either by Changes the style for @techlink{items} in the editor, either by
applying a style delta or using a specific style. applying a style delta or using a specific style.
To change a large collection of snips from one style to another style, To change a large collection of snips from one style to another style,
consider providing a @scheme[style<%>] instance rather than a consider providing a @scheme[style<%>] instance rather than a
@ -1215,7 +1215,7 @@ For @scheme[text%] objects: @|FCA| @|EVD|
} }
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(on-change) (on-change)
void?]{ void?]{
@ -1289,7 +1289,7 @@ Does nothing. See also @xmethod[text% on-default-event] and
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(on-display-size) (on-display-size)
void?]{ void?]{
@ -1328,7 +1328,7 @@ Calls @method[editor<%> on-display-size] unless the editor is
} }
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(on-edit-sequence) (on-edit-sequence)
void?]{ void?]{
@ -1407,7 +1407,7 @@ Either passes this event on to a caret-owning snip, selects a new
} }
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(on-load-file [filename path?] (on-load-file [filename path?]
[format (one-of/c 'guess 'standard 'text 'text-force-cr 'same 'copy)]) [format (one-of/c 'guess 'standard 'text 'text-force-cr 'same 'copy)])
void?]{ void?]{
@ -1566,7 +1566,7 @@ Does nothing.
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(on-save-file [filename path?] (on-save-file [filename path?]
[format (one-of/c 'guess 'standard 'text 'text-force-cr 'same 'copy)]) [format (one-of/c 'guess 'standard 'text 'text-force-cr 'same 'copy)])
void?]{ void?]{
@ -1592,7 +1592,7 @@ Does nothing.
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(on-snip-modified [snip (is-a?/c snip%)] (on-snip-modified [snip (is-a?/c snip%)]
[modified? any/c]) [modified? any/c])
void?]{ void?]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["snip-class.scrbl"]
@defclass[editor-snip% snip% ()]{ @defclass[editor-snip% snip% ()]{
@ -39,7 +40,7 @@ get-margin] for information about the inset and margin arguments.
} }
@defmethod[#:mode 'override @defmethod[#:mode override
(adjust-cursor [dc (is-a?/c dc<%>)] (adjust-cursor [dc (is-a?/c dc<%>)]
[x real?] [x real?]
[y real?] [y real?]
@ -84,7 +85,7 @@ Returns the editor contained by the snip, or @scheme[#f] is there is
} }
@defmethod[#:mode 'override @defmethod[#:mode override
(get-extent [dc (is-a?/c dc<%>)] (get-extent [dc (is-a?/c dc<%>)]
[x real?] [x real?]
[y real?] [y real?]
@ -198,7 +199,7 @@ See also @method[editor-snip% set-tight-text-fit].
} }
@defmethod[#:mode 'override @defmethod[#:mode override
(resize [w (and/c real? (not/c negative?))] (resize [w (and/c real? (not/c negative?))]
[h (and/c real? (not/c negative?))]) [h (and/c real? (not/c negative?))])
boolean?]{ boolean?]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["editor-stream-in-base-class.scrbl"]
@defclass[editor-stream-in-bytes-base% editor-stream-in-base% ()]{ @defclass[editor-stream-in-bytes-base% editor-stream-in-base% ()]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["editor-stream-out-base-class.scrbl"]
@defclass[editor-stream-out-bytes-base% editor-stream-out-base% ()]{ @defclass[editor-stream-out-bytes-base% editor-stream-out-base% ()]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["top-level-window-intf.scrbl"]
@defclass[frame% object% (top-level-window<%>)]{ @defclass[frame% object% (top-level-window<%>)]{
@ -241,7 +242,7 @@ If the event does not correspond to a complete shortcut combination,
} }
@defmethod[#:mode 'override @defmethod[#:mode override
(on-subwindow-char [receiver (is-a?/c window<%>)] (on-subwindow-char [receiver (is-a?/c window<%>)]
[event (is-a?/c key-event%)]) [event (is-a?/c key-event%)])
boolean?]{ boolean?]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["control-intf.scrbl"]
@defclass[gauge% object% (control<%>)]{ @defclass[gauge% object% (control<%>)]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["vertical-panel-class.scrbl"]
@defclass[group-box-panel% vertical-panel% ()]{ @defclass[group-box-panel% vertical-panel% ()]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["pane-class.scrbl"]
@defclass[grow-box-spacer-pane% pane% ()]{ @defclass[grow-box-spacer-pane% pane% ()]{

View File

@ -1,7 +1,7 @@
#reader(lib "docreader.ss" "scribble") #reader(lib "docreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@title{PLT Scheme GUI Toolbox} @title{PLT Scheme GUI: MrEd}
This manual describes MrEd. This manual describes MrEd.

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["pane-class.scrbl"]
@defclass[horizontal-pane% pane% ()]{ @defclass[horizontal-pane% pane% ()]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["panel-class.scrbl"]
@defclass[horizontal-panel% panel% ()]{ @defclass[horizontal-panel% panel% ()]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["snip-class.scrbl"]
@defclass[image-snip% snip% ()]{ @defclass[image-snip% snip% ()]{
@ -105,7 +106,7 @@ If @scheme[inline?] is not @scheme[#f], the image data will be saved
} }
@defmethod[#:mode 'override @defmethod[#:mode override
(resize [w (and/c real? (not/c negative?))] (resize [w (and/c real? (not/c negative?))]
[h (and/c real? (not/c negative?))]) [h (and/c real? (not/c negative?))])
void?]{ void?]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["event-class.scrbl"]
@defclass[key-event% event% ()]{ @defclass[key-event% event% ()]{

View File

@ -327,7 +327,7 @@ Examples:
A call to @method[keymap% map-function] that would map a particular A call to @method[keymap% map-function] that would map a particular
key sequence both as a prefix and as a complete sequence raises an key sequence both as a prefix and as a complete sequence raises an
exception, but the exception handler cannot escape (see exception, but the exception handler cannot escape (see
@secref["mr:mr:evtcontjump"]). @secref["mr:evtcontjump"]).
A function name does not have to be mapped to a handler before input A function name does not have to be mapped to a handler before input
states are mapped to the name; the handler is dispatched by name at states are mapped to the name; the handler is dispatched by name at

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["menu-item-intf.scrbl"]
@definterface[labelled-menu-item<%> (menu-item<%>)]{ @definterface[labelled-menu-item<%> (menu-item<%>)]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["list-control-intf.scrbl"]
@define[lbnumnote @elem{List box items are indexed from @scheme[0].}] @define[lbnumnote @elem{List box items are indexed from @scheme[0].}]
@ -94,16 +95,18 @@ If @scheme[selection] is an integer, it is passed to
} }
@defmethod[#:mode 'add @defmethod[#:mode override
(append [item string] (append [item string]
[data any/c]) [data any/c #f])
void?]{ void?]{
Adds a new item to the list box with an associated ``data'' object. Adds a new item to the list box with an associated ``data'' object.
The @scheme[data] object is not displayed in the list box; it is The @scheme[data] object is not displayed in the list box; it is
provided merely as a convenience for use with provided merely as a convenience for use with @method[list-box%
@method[list-box% get-data], possibly allowing a programmer to avoid managing a separate get-data], possibly allowing a programmer to avoid managing a
item-to-data mapping in addition to the list box control. separate item-to-data mapping in addition to the list box control.
See also @xmethod[list-control<%> append].
} }

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["control-intf.scrbl"]
@definterface[list-control<%> (control<%>)]{ @definterface[list-control<%> (control<%>)]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["menu-item-container-intf.scrbl"]
@defclass[menu-bar% object% (menu-item-container<%>)]{ @defclass[menu-bar% object% (menu-item-container<%>)]{

View File

@ -1,5 +1,7 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["labelled-menu-item-intf.scrbl"]
@require["menu-item-container-intf.scrbl"]
@defclass[menu% object% (menu-item-container<%> labelled-menu-item<%>)]{ @defclass[menu% object% (menu-item-container<%> labelled-menu-item<%>)]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["selectable-menu-item-intf.scrbl"]
@defclass[menu-item% object% (selectable-menu-item<%>)]{ @defclass[menu-item% object% (selectable-menu-item<%>)]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["control-intf.scrbl"]
@defclass[message% object% (control<%>)]{ @defclass[message% object% (control<%>)]{
@ -38,11 +39,14 @@ Creates a string or bitmap message initially showing @scheme[label].
} }
@defmethod[#:mode 'add @defmethod[#:mode override
(set-label [label (is-a?/c bitmap%)]) (set-label [label (or/c label-string? (is-a?/c bitmap%))])
void?]{ void?]{
Sets the bitmap label for a bitmap message. The same as @xmethod[window<%> set-label] when @scheme[label] is a
string.
Otherwise, sets the bitmap label for a bitmap message.
@bitmaplabeluseisbm[label] @|bitmapiforiglabel| @bitmaplabeluseisbm[label] @|bitmapiforiglabel|
}} }}

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["event-class.scrbl"]
@defclass[mouse-event% event% ()]{ @defclass[mouse-event% event% ()]{

View File

@ -1,5 +1,7 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["area-container-intf.scrbl"]
@require["subarea-intf.scrbl"]
@defclass[pane% object% (area-container<%> subarea<%>)]{ @defclass[pane% object% (area-container<%> subarea<%>)]{

View File

@ -1,5 +1,7 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["subwindow-intf.scrbl"]
@require["area-container-window-intf.scrbl"]
@defclass[panel% object% (area-container-window<%> subwindow<%>)]{ @defclass[panel% object% (area-container-window<%> subwindow<%>)]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["editor-intf.scrbl"]
@defclass[pasteboard% object% (editor<%>)]{ @defclass[pasteboard% object% (editor<%>)]{
@ -38,7 +39,7 @@ Selects snips without deselecting other snips. When coordinates are
} }
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(after-delete [snip (is-a?/c snip%)]) (after-delete [snip (is-a?/c snip%)])
void?]{ void?]{
@methspec{ @methspec{
@ -60,7 +61,7 @@ Does nothing.
} }
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(after-insert [snip (is-a?/c snip%)] (after-insert [snip (is-a?/c snip%)]
[before (or/c (is-a?/c snip%) false/c)] [before (or/c (is-a?/c snip%) false/c)]
[x real?] [x real?]
@ -86,7 +87,7 @@ Does nothing.
} }
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(after-interactive-move [event (is-a?/c mouse-event%)]) (after-interactive-move [event (is-a?/c mouse-event%)])
void?]{ void?]{
@methspec{ @methspec{
@ -108,7 +109,7 @@ Does nothing.
} }
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(after-interactive-resize [snip (is-a?/c snip%)]) (after-interactive-resize [snip (is-a?/c snip%)])
void?]{ void?]{
@methspec{ @methspec{
@ -129,7 +130,7 @@ Does nothing.
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(after-move-to [snip (is-a?/c snip%)] (after-move-to [snip (is-a?/c snip%)]
[x real?] [x real?]
[y real?] [y real?]
@ -159,7 +160,7 @@ Does nothing.
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(after-reorder [snip (is-a?/c snip%)] (after-reorder [snip (is-a?/c snip%)]
[to-snip (is-a?/c snip%)] [to-snip (is-a?/c snip%)]
[before? any/c]) [before? any/c])
@ -188,7 +189,7 @@ Does nothing.
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(after-resize [snip (is-a?/c snip%)] (after-resize [snip (is-a?/c snip%)]
[w (and/c real? (not/c negative?))] [w (and/c real? (not/c negative?))]
[h (and/c real? (not/c negative?))] [h (and/c real? (not/c negative?))]
@ -218,7 +219,7 @@ Does nothing.
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(after-select [snip (is-a?/c snip%)] (after-select [snip (is-a?/c snip%)]
[on? any/c]) [on? any/c])
void?]{ void?]{
@ -246,7 +247,7 @@ Does nothing.
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(can-delete? [snip (is-a?/c snip%)]) (can-delete? [snip (is-a?/c snip%)])
boolean?]{ boolean?]{
@ -270,7 +271,7 @@ Returns @scheme[#t].
} }
} }
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(can-insert? [snip (is-a?/c snip%)] (can-insert? [snip (is-a?/c snip%)]
[before (or/c (is-a?/c snip%) false/c)] [before (or/c (is-a?/c snip%) false/c)]
[x real?] [x real?]
@ -297,7 +298,7 @@ Returns @scheme[#t].
} }
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(can-interactive-move? [event (is-a?/c mouse-event%)]) (can-interactive-move? [event (is-a?/c mouse-event%)])
boolean?]{ boolean?]{
@ -322,7 +323,7 @@ Returns @scheme[#t].
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(can-interactive-resize? [snip (is-a?/c snip%)]) (can-interactive-resize? [snip (is-a?/c snip%)])
boolean?]{ boolean?]{
@methspec{ @methspec{
@ -346,7 +347,7 @@ Returns @scheme[#t].
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(can-move-to? [snip (is-a?/c snip%)] (can-move-to? [snip (is-a?/c snip%)]
[x real?] [x real?]
[y real?] [y real?]
@ -374,7 +375,7 @@ Returns @scheme[#t].
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(can-reorder? [snip (is-a?/c snip%)] (can-reorder? [snip (is-a?/c snip%)]
[to-snip (is-a?/c snip%)] [to-snip (is-a?/c snip%)]
[before? any/c]) [before? any/c])
@ -403,7 +404,7 @@ Returns @scheme[#t].
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(can-resize? [snip (is-a?/c snip%)] (can-resize? [snip (is-a?/c snip%)]
[w (and/c real? (not/c negative?))] [w (and/c real? (not/c negative?))]
[h (and/c real? (not/c negative?))]) [h (and/c real? (not/c negative?))])
@ -427,7 +428,7 @@ Returns @scheme[#t].
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(can-select? [snip (is-a?/c snip%)] (can-select? [snip (is-a?/c snip%)]
[on? any/c]) [on? any/c])
boolean?]{ boolean?]{
@ -456,28 +457,29 @@ Returns @scheme[#t].
}} }}
@defmethod*[#:mode 'add @defmethod*[#:mode override
([(change-style [style (or/c (is-a?/c style<%>) false/c)] ([(change-style [style (or/c (is-a?/c style<%>) false/c)]
[snip (or/c (is-a?/c snip%) false/c) #f]) [snip (or/c (is-a?/c snip%) false/c) #f])
void?] void?]
[(change-style [delta (or/c (is-a?/c style-delta%) false/c)] [(change-style [delta (or/c (is-a?/c style-delta%) false/c)]
[snip (is-a?/c snip%)]) [snip (is-a?/c snip%) #f])
void?])]{ void?])]{
Changes the style of @scheme[style] to a specific style or by applying Changes the style of @scheme[style] to a specific style or by applying
a style delta. If @scheme[snip] is @scheme[#f], then all currently a style delta. If @scheme[snip] is @scheme[#f], then all currently
selected snips are changed. selected snips are changed. See also @xmethod[editor<%> change-style].
When a @scheme[style] is provided: @InStyleListNote[] When a @scheme[style] is provided: @InStyleListNote[]
} }
@defmethod[#:mode 'auto-super @defmethod[#:mode override
(copy-self-to [dest (or/c (is-a?/c text%) (is-a?/c pasteboard%))]) (copy-self-to [dest (or/c (is-a?/c text%) (is-a?/c pasteboard%))])
void?]{ void?]{
The dragability, selection visibility state, and scroll step of In addition to the default @xmethod[editor<%> copy-self-to] work, the
dragability, selection visibility state, and scroll step of
@this-obj[] are installed into @scheme[dest]. @this-obj[] are installed into @scheme[dest].
} }
@ -648,8 +650,10 @@ Returns whether selection dots are drawn around the edge of selected
} }
@defmethod*[#:mode 'add @defmethod*[#:mode extend
([(insert [snip (is-a?/c snip%)] ([(insert [snip (is-a?/c snip%)])
void?]
[(insert [snip (is-a?/c snip%)]
[before (or/c (is-a?/c snip%) false/c)] [before (or/c (is-a?/c snip%) false/c)]
[x real?] [x real?]
[y real?]) [y real?])
@ -666,7 +670,8 @@ Inserts @scheme[snip] at @techlink{location} @math{(@scheme[x],
@scheme[y])} just in front of @scheme[y])} just in front of
@scheme[before]. (@|seesniporderdiscuss|) If @scheme[before] is nor @scheme[before]. (@|seesniporderdiscuss|) If @scheme[before] is nor
provided or is @scheme[#f], then @scheme[snip] is inserted behind all provided or is @scheme[#f], then @scheme[snip] is inserted behind all
other snips. other snips. If @scheme[x] and @scheme[y] are not provided, the snip
is added at @math{(0, 0)}.
} }
@ -802,7 +807,7 @@ Deselects all selected snips in the editor.
} }
@defmethod[#:mode 'override @defmethod[#:mode override
(on-default-event [event (is-a?/c mouse-event%)]) (on-default-event [event (is-a?/c mouse-event%)])
void?]{ void?]{
@ -831,7 +836,7 @@ object.}
} }
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(on-delete [snip (is-a?/c snip%)]) (on-delete [snip (is-a?/c snip%)])
void?]{ void?]{
@ -865,7 +870,7 @@ If @scheme[snip] accepts events, it is designated as the caret owner
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(on-insert [snip (is-a?/c snip%)] (on-insert [snip (is-a?/c snip%)]
[before (or/c (is-a?/c snip%) false/c)] [before (or/c (is-a?/c snip%) false/c)]
[x real?] [x real?]
@ -885,7 +890,7 @@ The editor is internally locked for writing when this method is called
} }
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(on-interactive-move [event (is-a?/c mouse-event%)]) (on-interactive-move [event (is-a?/c mouse-event%)])
void?]{ void?]{
@methspec{ @methspec{
@ -908,7 +913,7 @@ Does nothing.
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(on-interactive-resize [snip (is-a?/c snip%)]) (on-interactive-resize [snip (is-a?/c snip%)])
void?]{ void?]{
@methspec{ @methspec{
@ -930,7 +935,7 @@ Does nothing.
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(on-move-to [snip (is-a?/c snip%)] (on-move-to [snip (is-a?/c snip%)]
[x real?] [x real?]
[y real?] [y real?]
@ -960,7 +965,7 @@ Does nothing.
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(on-reorder [snip (is-a?/c snip%)] (on-reorder [snip (is-a?/c snip%)]
[to-snip (is-a?/c snip%)] [to-snip (is-a?/c snip%)]
[before? any/c]) [before? any/c])
@ -987,7 +992,7 @@ Does nothing.
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(on-resize [snip (is-a?/c snip%)] (on-resize [snip (is-a?/c snip%)]
[w (and/c real? (not/c negative?))] [w (and/c real? (not/c negative?))]
[h (and/c real? (not/c negative?))]) [h (and/c real? (not/c negative?))])
@ -1016,7 +1021,7 @@ Does nothing.
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(on-select [snip (is-a?/c snip%)] (on-select [snip (is-a?/c snip%)]
[on? any/c]) [on? any/c])
void?]{ void?]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["menu-item-container-intf.scrbl"]
@defclass[popup-menu% object% (menu-item-container<%>)]{ @defclass[popup-menu% object% (menu-item-container<%>)]{

View File

@ -0,0 +1,85 @@
#reader(lib "docreader.ss" "scribble")
@require["common.ss"]
@title[#:tag "mr:mredprefs"]{Preferences}
MrEd supports a number of preferences for global configuration. The
MrEd preferences are stored in the common file reported by
@scheme[find-system-path] for @indexed-scheme['pref-file], and
preference values can be retrieved and changed through
@scheme[get-preference] and @scheme[set-preference]. However, MrEd
reads most preferences once at startup (all except the
@Resource{playcmd}).
The following are the (case-sensitive) preference names used by MrEd:
@itemize{
@item{@ResourceFirst{default-font-size} --- sets the default font size
the basic style in a style list, and thus the default font size for
an editor.}
@item{@ResourceFirst{controlFontSize} --- sets the font size for
control and menu labels (Windows, X); the font is the @scheme['system]
font, which can be configured as described in
@secref["mr:fontresources"].}
@item{@ResourceFirst{defaultMenuPrefix} --- sets the prefix used by
default for menu item shortcuts under X, one of @scheme['ctl],
@scheme['meta], or @scheme['alt]. The default is
@scheme['ctl]. When this preference is set to @scheme['meta] or
@scheme['alt], underlined mnemonics (introduced by @litchar{&} in menu
labels) are suppressed.}
@item{@ResourceFirst{altUpSelectsMenu} --- a true value makes
pressing and releasing the Alt key select the first menu in the menu
bar under X.}
@item{@ResourceFirst{emacsUndo} --- a true value makes undo in
editors work as in Emacs (i.e., undo operations are themselves kept
in the undo stack).}
@item{@ResourceFirst{hiliteColor} --- a string to sets the color for
highlighting text, menus, and other GUI elements under X; the
preference string should contain six hexadecimal digits, two for each
component of the color. For example, set @Resource{hiliteColor} to
@scheme["0000A0"] and set @Resource{hiliteMenuBorder} to @scheme[#t]
for a Bluecurve-like look.}
@item{@ResourceFirst{hiliteMenuBorder} --- a true value causes a menu
selection to be highlighted with a border (in addition to a color) under
X.}
@item{@ResourceFirst{wheelStep} --- sets the default mouse-wheel step
size of @scheme[editor-canvas%] objects.}
@item{@ResourceFirst{outlineInactiveSelection} --- a true value
causes selections in text editors to be shown with an outline of the
selected region when the editor does no have the keyboard focus.}
@item{@ResourceFirst{playcmd} --- used to format a sound-playing
command; see @scheme[play-sound] for details.}
@item{@ResourceFirst{forceFocus} --- a true value enables extra
effort in MrEd to move the focus to a top-level window that is shown
or raised.}
@item{@ResourceFirst{doubleClickTime} --- overrides the
platform-specific default interval (in milliseconds) for double-click
events.}
@item{@ResourceFirst{gamma} --- sets the gamma value used in
gamma-correcting PNG files.}
@item{@ResourceFirst{selectionAsClipboard} --- under X, a true value
causes @scheme[the-clipboard] to be an alias to
@scheme[the-x-selection-clipboard], which means that cut and paste
operations use the X selection instead of the X clipboard. See also
@scheme[clipboard<%>].}
}
In addition, preference names built from font face names can provide
or override default entries for the @scheme[font-name-directory<%>];
see @secref["mr:fontresources"] for information.

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["dc-intf.scrbl"]
@defclass[printer-dc% object% (dc<%>)]{ @defclass[printer-dc% object% (dc<%>)]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["control-intf.scrbl"]
@defclass[radio-box% object% (control<%>)]{ @defclass[radio-box% object% (control<%>)]{
@ -72,7 +73,7 @@ By default, the first radio button is initially selected. If
} }
@defmethod*[#:mode 'override @defmethod*[#:mode override
([(enable [enable? any/c]) ([(enable [enable? any/c])
void?] void?]
[(enable [n nonnegative-exact-integer?] [(enable [n nonnegative-exact-integer?]
@ -122,7 +123,7 @@ numbered from @scheme[0].
} }
@defmethod*[#:mode 'override @defmethod*[#:mode override
([(is-enabled?) ([(is-enabled?)
boolean?] boolean?]
[(is-enabled? [n nonnegative-exact-integer?]) [(is-enabled? [n nonnegative-exact-integer?])

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["event-class.scrbl"]
@defclass[scroll-event% event% ()]{ @defclass[scroll-event% event% ()]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["labelled-menu-item-intf.scrbl"]
@definterface[selectable-menu-item<%> (labelled-menu-item<%>)]{ @definterface[selectable-menu-item<%> (labelled-menu-item<%>)]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["menu-item-intf.scrbl"]
@defclass[separator-menu-item% object% (menu-item<%>)]{ @defclass[separator-menu-item% object% (menu-item<%>)]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["control-intf.scrbl"]
@defclass[slider% object% (control<%>)]{ @defclass[slider% object% (control<%>)]{

View File

@ -117,7 +117,7 @@ The drawing context and snip's @techlink{location}s in drawing context
} }
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(can-do-edit-operation? [op (one-of/c 'undo 'redo 'clear 'cut 'copy (can-do-edit-operation? [op (one-of/c 'undo 'redo 'clear 'cut 'copy
'paste 'kill 'select-all 'paste 'kill 'select-all
'insert-text-box 'insert-pasteboard-box 'insert-text-box 'insert-pasteboard-box

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["snip-class.scrbl"]
@defclass[string-snip% snip% ()]{ @defclass[string-snip% snip% ()]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["area-intf.scrbl"]
@definterface[subarea<%> (area<%>)]{ @definterface[subarea<%> (area<%>)]{

View File

@ -1,5 +1,7 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["window-intf.scrbl"]
@require["subarea-intf.scrbl"]
@definterface[subwindow<%> (subarea<%> window<%>)]{ @definterface[subwindow<%> (subarea<%> window<%>)]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["vertical-panel-class.scrbl"]
@defclass[tab-panel% vertical-panel% ()]{ @defclass[tab-panel% vertical-panel% ()]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["string-snip-class.scrbl"]
@defclass[tab-snip% string-snip% ()]{ @defclass[tab-snip% string-snip% ()]{

View File

@ -1,6 +1,8 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["editor-intf.scrbl"]
@defclass[text% object% (editor<%>)]{ @defclass[text% object% (editor<%>)]{
A @scheme[text%] object is a standard text editor. A text editor is A @scheme[text%] object is a standard text editor. A text editor is
@ -32,7 +34,7 @@ A new @scheme[style-list%] object is created for the new editor. See
} }
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(after-change-style [start nonnegative-exact-integer?] (after-change-style [start nonnegative-exact-integer?]
[len nonnegative-exact-integer?]) [len nonnegative-exact-integer?])
void?]{ void?]{
@ -55,7 +57,7 @@ Does nothing.
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(after-delete [start nonnegative-exact-integer?] (after-delete [start nonnegative-exact-integer?]
[len nonnegative-exact-integer?]) [len nonnegative-exact-integer?])
void?]{ void?]{
@ -83,7 +85,7 @@ Does nothing.
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(after-insert [start nonnegative-exact-integer?] (after-insert [start nonnegative-exact-integer?]
[len nonnegative-exact-integer?]) [len nonnegative-exact-integer?])
void?]{ void?]{
@ -110,7 +112,7 @@ Does nothing.
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(after-merge-snips [pos nonnegative-exact-integer?]) (after-merge-snips [pos nonnegative-exact-integer?])
void?]{ void?]{
@methspec{ @methspec{
@ -131,7 +133,7 @@ Does nothing.
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(after-set-position) (after-set-position)
void?]{ void?]{
@ -150,7 +152,7 @@ Does nothing.
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(after-set-size-constraint) (after-set-size-constraint)
void?]{ void?]{
@ -176,7 +178,7 @@ Does nothing.
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(after-split-snip [pos nonnegative-exact-integer?]) (after-split-snip [pos nonnegative-exact-integer?])
void?]{ void?]{
@methspec{ @methspec{
@ -205,7 +207,7 @@ Simulates a user click that invokes a clickback, if the given range of
} }
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(can-change-style? [start nonnegative-exact-integer?] (can-change-style? [start nonnegative-exact-integer?]
[len nonnegative-exact-integer?]) [len nonnegative-exact-integer?])
boolean?]{ boolean?]{
@ -231,7 +233,7 @@ Returns @scheme[#t].
} }
} }
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(can-delete? [start nonnegative-exact-integer?] (can-delete? [start nonnegative-exact-integer?]
[len nonnegative-exact-integer?]) [len nonnegative-exact-integer?])
boolean?]{ boolean?]{
@ -260,7 +262,7 @@ Returns @scheme[#t].
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(can-insert? [start nonnegative-exact-integer?] (can-insert? [start nonnegative-exact-integer?]
[len nonnegative-exact-integer?]) [len nonnegative-exact-integer?])
boolean?]{ boolean?]{
@ -288,7 +290,7 @@ Returns @scheme[#t].
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(can-set-size-constraint?) (can-set-size-constraint?)
boolean?]{ boolean?]{
@ -323,9 +325,9 @@ See also @method[text% hide-caret].
} }
@defmethod*[#:mode 'add @defmethod*[#:mode extend
([(change-style [delta (or/c (is-a?/c style-delta%) false/c)] ([(change-style [delta (or/c (is-a?/c style-delta%) false/c)]
[start (or/c nonnegative-exact-integer? (one/of 'start))] [start (or/c nonnegative-exact-integer? (one/of 'start)) 'start]
[end (or/c nonnegative-exact-integer? (one/of 'end)) 'end] [end (or/c nonnegative-exact-integer? (one/of 'end)) 'end]
[counts-as-mod? any/c @scheme[#t]]) [counts-as-mod? any/c @scheme[#t]])
void?] void?]
@ -349,10 +351,10 @@ When @scheme[style] is provided: @InStyleListNote[]
} }
@defmethod[#:mode 'add @defmethod[#:mode extend
(copy [extend? any/c] (copy [extend? any/c]
[time (and/c exact? integer?)] [time (and/c exact? integer?)]
[start (or/c nonnegative-exact-integer? (one/of 'start))] [start (or/c nonnegative-exact-integer? (one/of 'start)) 'start]
[end (or/c nonnegative-exact-integer? (one/of 'end)) 'end]) [end (or/c nonnegative-exact-integer? (one/of 'end)) 'end])
void?]{ void?]{
@ -365,25 +367,25 @@ See @|timediscuss| for a discussion of the @scheme[time] argument. If
@scheme[time] is outside the platform-specific range of times, @scheme[time] is outside the platform-specific range of times,
@|MismatchExn|. @|MismatchExn|.
} }
@defmethod[#:mode 'auto-super @defmethod[#:mode override
(copy-self-to [dest (or/c (is-a?/c text%) (is-a?/c pasteboard%))]) (copy-self-to [dest (or/c (is-a?/c text%) (is-a?/c pasteboard%))])
void?]{ void?]{
This editor's file format, wordbreak function, wordbreak map, In addition to the default @xmethod[editor<%> copy-self-to] work,
this editor's file format, wordbreak function, wordbreak map,
click-between-threshold, caret visibility state, overwrite mode click-between-threshold, caret visibility state, overwrite mode
state, and autowrap bitmap are installed into @scheme[dest]. state, and autowrap bitmap are installed into @scheme[dest].
} }
@defmethod[#:mode 'add @defmethod[#:mode override
(cut [extend? any/c] (cut [extend? any/c]
[time (and/c exact? integer?)] [time (and/c exact? integer?)]
[start (or/c nonnegative-exact-integer? (one/of 'start))] [start (or/c nonnegative-exact-integer? (one/of 'start)) 'start]
[end (or/c nonnegative-exact-integer? (one/of 'end)) 'end]) [end (or/c nonnegative-exact-integer? (one/of 'end)) 'end])
void?]{ void?]{
@ -1027,7 +1029,7 @@ See also @method[text% caret-hidden?] and @method[editor<%> lock].
} }
@defmethod*[#:mode 'override @defmethod*[#:mode override
([(insert [str string?] ([(insert [str string?]
[start nonnegative-exact-integer?] [start nonnegative-exact-integer?]
[end (or/c nonnegative-exact-integer? (one/of 'same)) 'same] [end (or/c nonnegative-exact-integer? (one/of 'same)) 'same]
@ -1094,13 +1096,18 @@ See also @method[text% get-styles-sticky].
} }
@defmethod[#:mode 'add @defmethod*[#:mode override
(kill [time (and/c exact? integer?)] ([(kill [time (and/c exact? integer?) 0])
[start nonnegative-exact-integer?] void?]
[end nonnegative-exact-integer?]) [(kill [time (and/c exact? integer?)]
void?]{ [start nonnegative-exact-integer?]
[end nonnegative-exact-integer?])
void?])]{
Cuts the text in the given region. Cuts the text in the given region. If @scheme[start] and @scheme[end]
are not supplied, then the selected region plus all whitespace to the
end of line is cut; the newline is also cut if only whitespace exists
between the selection and the end of line.
See @|timediscuss| for a discussion of the @scheme[time] argument. If See @|timediscuss| for a discussion of the @scheme[time] argument. If
@scheme[time] is outside the platform-specific range of times, @scheme[time] is outside the platform-specific range of times,
@ -1276,7 +1283,7 @@ See also @method[text% set-position].
} }
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(on-change-style [start nonnegative-exact-integer?] (on-change-style [start nonnegative-exact-integer?]
[len nonnegative-exact-integer?]) [len nonnegative-exact-integer?])
void?]{ void?]{
@ -1303,7 +1310,7 @@ Does nothing.
} }
@defmethod[#:mode 'override @defmethod[#:mode override
(on-default-char [event (is-a?/c key-event%)]) (on-default-char [event (is-a?/c key-event%)])
void?]{ void?]{
@ -1329,7 +1336,7 @@ Note that an editor's @scheme[editor-canvas%] normally handles mouse
} }
@defmethod[#:mode 'override @defmethod[#:mode override
(on-default-event [event (is-a?/c mouse-event%)]) (on-default-event [event (is-a?/c mouse-event%)])
void?]{ void?]{
@ -1354,7 +1361,7 @@ Tracks clicks on a clickback (see @method[text% set-clickback]) of
} }
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(on-delete [start nonnegative-exact-integer?] (on-delete [start nonnegative-exact-integer?]
[len nonnegative-exact-integer?]) [len nonnegative-exact-integer?])
void?]{ void?]{
@ -1385,7 +1392,7 @@ Does nothing.
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(on-insert [start nonnegative-exact-integer?] (on-insert [start nonnegative-exact-integer?]
[len nonnegative-exact-integer?]) [len nonnegative-exact-integer?])
void?]{ void?]{
@ -1448,7 +1455,7 @@ Returns a @scheme[tab-snip%] instance.
}} }}
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(on-set-size-constraint) (on-set-size-constraint)
void?]{ void?]{
@ -1526,9 +1533,9 @@ If the paragraph starts with invisible @techlink{item}s and @scheme[visible?] is
} }
@defmethod[#:mode 'add @defmethod[#:mode override
(paste [time (and/c exact? integer?)] (paste [time (and/c exact? integer?)]
[start (or/c nonnegative-exact-integer? (one/of 'end))] [start (or/c nonnegative-exact-integer? (one/of 'end)) 'end]
[end (or/c nonnegative-exact-integer? (one/of 'same)) 'same]) [end (or/c nonnegative-exact-integer? (one/of 'same)) 'same])
void?]{ void?]{
@ -1564,9 +1571,9 @@ If the previous operation on the editor was not a paste, calling
} }
@defmethod[#:mode 'add @defmethod[#:mode override
(paste-x-selection [time (and/c exact? integer?)] (paste-x-selection [time (and/c exact? integer?)]
[start (or/c nonnegative-exact-integer? (one/of 'end))] [start (or/c nonnegative-exact-integer? (one/of 'end)) 'end]
[end (or/c nonnegative-exact-integer? (one/of 'same)) 'same]) [end (or/c nonnegative-exact-integer? (one/of 'same)) 'same])
void?]{ void?]{
@ -1637,7 +1644,7 @@ Returns the paragraph number of the paragraph containing a given @techlink{posit
} }
@defmethod[#:mode 'add @defmethod[#:mode extend
(read-from-file [stream (is-a?/c editor-stream-in%)] (read-from-file [stream (is-a?/c editor-stream-in%)]
[start (or/c nonnegative-exact-integer? (one/of 'start))] [start (or/c nonnegative-exact-integer? (one/of 'start))]
[overwrite-styles? any/c #t]) [overwrite-styles? any/c #t])
@ -2020,9 +2027,9 @@ Splitting a snip is disallowed when the editor is internally locked
} }
@defmethod[#:mode 'add @defmethod[#:mode extend
(write-to-file [stream (is-a?/c editor-stream-out%)] (write-to-file [stream (is-a?/c editor-stream-out%)]
[start nonnegative-exact-integer?] [start nonnegative-exact-integer? 0]
[end (or/c nonnegative-exact-integer? (one/of 'eof)) 'eof]) [end (or/c nonnegative-exact-integer? (one/of 'eof)) 'eof])
boolean?]{ boolean?]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["control-intf.scrbl"]
@defclass[text-field% object% (control<%>)]{ @defclass[text-field% object% (control<%>)]{

View File

@ -1,12 +1,13 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["area-container-window-intf.scrbl"]
@definterface[top-level-window<%> (area-container-window<%>)]{ @definterface[top-level-window<%> (area-container-window<%>)]{
A top-level window is either a @scheme[frame%] or @scheme[dialog%] A top-level window is either a @scheme[frame%] or @scheme[dialog%]
object. object.
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(can-close?) (can-close?)
boolean?]{ boolean?]{
@ -135,7 +136,7 @@ The method's argument is @scheme[#t] when the window is activated,
} }
@defmethod[#:mode 'pubment @defmethod[#:mode pubment
(on-close) (on-close)
void?]{ void?]{
@ -312,12 +313,13 @@ Sets the size of the window (in pixels), but only if the given size is
} }
@defmethod[#:mode 'auto-super @defmethod[(show [show any/c])
(show [show any/c])
void?]{ void?]{
If the window is already shown, it is moved front of other top-level If the window is already shown, it is moved front of other top-level
windows. If the window is iconized (frames only), it is deiconized. windows. If the window is iconized (frames only), it is deiconized.
See also @xmethod[window<%> show].
}} }}

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["pane-class.scrbl"]
@defclass[vertical-pane% pane% ()]{ @defclass[vertical-pane% pane% ()]{

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["panel-class.scrbl"]
@defclass[vertical-panel% panel% ()]{ @defclass[vertical-panel% panel% ()]{

View File

@ -1,6 +1,7 @@
#reader(lib "docreader.ss" "scribble") #reader(lib "docreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["diagrams.ss"] @require["diagrams.ss"]
@require["mred-classes.ss"]
@title[#:style '(toc quiet)]{Windowing Classes} @title[#:style '(toc quiet)]{Windowing Classes}
@ -20,58 +21,6 @@ Alphabetical:
@local-table-of-contents[] @local-table-of-contents[]
@require["area-intf.scrbl"]
@require["area-container-intf.scrbl"]
@require["area-container-window-intf.scrbl"]
@require["button-class.scrbl"]
@require["canvas-intf.scrbl"]
@require["canvas-class.scrbl"]
@require["check-box-class.scrbl"]
@require["checkable-menu-item-class.scrbl"]
@require["choice-class.scrbl"]
@require["clipboard-client-class.scrbl"]
@require["clipboard-intf.scrbl"]
@require["combo-field-class.scrbl"]
@require["control-intf.scrbl"]
@require["control-event-class.scrbl"]
@require["cursor-class.scrbl"]
@require["dialog-class.scrbl"]
@require["event-class.scrbl"]
@require["frame-class.scrbl"]
@require["gauge-class.scrbl"]
@require["group-box-panel-class.scrbl"]
@require["grow-box-spacer-pane-class.scrbl"]
@require["horizontal-pane-class.scrbl"]
@require["horizontal-panel-class.scrbl"]
@require["key-event-class.scrbl"]
@require["labelled-menu-item-intf.scrbl"]
@require["list-box-class.scrbl"]
@require["list-control-intf.scrbl"]
@require["menu-class.scrbl"]
@require["menu-bar-class.scrbl"]
@require["menu-item-intf.scrbl"]
@require["menu-item-class.scrbl"]
@require["menu-item-container-intf.scrbl"]
@require["message-class.scrbl"]
@require["mouse-event-class.scrbl"]
@require["pane-class.scrbl"]
@require["panel-class.scrbl"]
@require["popup-menu-class.scrbl"]
@require["radio-box-class.scrbl"]
@require["selectable-menu-item-intf.scrbl"]
@require["separator-menu-item-class.scrbl"]
@require["scroll-event-class.scrbl"]
@require["slider-class.scrbl"]
@require["subarea-intf.scrbl"]
@require["subwindow-intf.scrbl"]
@require["tab-panel-class.scrbl"]
@require["text-field-class.scrbl"]
@require["timer-class.scrbl"]
@require["top-level-window-intf.scrbl"]
@require["vertical-pane-class.scrbl"]
@require["vertical-panel-class.scrbl"]
@require["window-intf.scrbl"]
@include-class[area<%>] @include-class[area<%>]
@include-class[area-container<%>] @include-class[area-container<%>]
@include-class[area-container-window<%>] @include-class[area-container-window<%>]

View File

@ -180,7 +180,7 @@ The fundamental graphical element in MrEd's windowing toolbox is an
@item{@scheme[editor-canvas%] --- an @deftech{editor canvas} is a @item{@scheme[editor-canvas%] --- an @deftech{editor canvas} is a
subwindow for displaying a text editor or pasteboard editor. The subwindow for displaying a text editor or pasteboard editor. The
@scheme[editor-canvas%] class is documented with the editor classes @scheme[editor-canvas%] class is documented with the editor classes
in @secref["mr:editoredit"].} in @secref["mr:editor-overview"].}
@item{@deftech{Controls} --- containees that the user can manipulate: @item{@deftech{Controls} --- containees that the user can manipulate:
@ -700,7 +700,7 @@ Controls, such as buttons and list boxes, handle keyboard and mouse
@section[#:tag "mr:eventspaceinfo"]{Event Dispatching and Eventspaces} @section[#:tag "mr:eventspaceinfo"]{Event Dispatching and Eventspaces}
@section-index['("events" "dispatching")] @section-index["events" "dispatching"]
A graphical user interface is an inherently multi-threaded system: one A graphical user interface is an inherently multi-threaded system: one
thread is the program managing windows on the screen, and the other thread is the program managing windows on the screen, and the other
@ -770,15 +770,15 @@ In MrEd, an @deftech{eventspace} is a context for processing GUI
@subsection{Event Types and Priorities} @subsection{Event Types and Priorities}
@section-index['("events" "timer")] @section-index["events" "timer"]
@section-index['("events" "explicitly queued")] @section-index["events" "explicitly queued"]
In addition to events corresponding to user and windowing actions, In addition to events corresponding to user and windowing actions,
such as button clicks, key presses, and updates, the system such as button clicks, key presses, and updates, the system
dispatches two kinds of internal events: @tech{timer events} and dispatches two kinds of internal events: @tech{timer events} and
@tech{explicitly queued events}. @tech{explicitly queued events}.
@tech{Timer events} are created by instances of @scheme[timer%]. When @deftech{Timer events} are created by instances of @scheme[timer%]. When
a timer is started and then expires, the timer queues an event to a timer is started and then expires, the timer queues an event to
call the timer's @method[timer% notify] method. Like a top-level call the timer's @method[timer% notify] method. Like a top-level
window, each timer is associated with a particular eventspace (the window, each timer is associated with a particular eventspace (the
@ -786,7 +786,7 @@ In addition to events corresponding to user and windowing actions,
@secref["mr:currenteventspace"]) when it is created, and the timer @secref["mr:currenteventspace"]) when it is created, and the timer
queues the event in its eventspace. queues the event in its eventspace.
@deftech{Explicitly queued} events are created with @deftech{Explicitly queued events} are created with
@scheme[queue-callback], which accepts a callback procedure to handle @scheme[queue-callback], which accepts a callback procedure to handle
the event. The event is enqueued in the current eventspace at the the event. The event is enqueued in the current eventspace at the
time of the call to @scheme[queue-callback], with either a high or time of the call to @scheme[queue-callback], with either a high or
@ -843,11 +843,8 @@ When a handler thread shows a dialog, the dialog's @method[dialog%
@subsection[#:tag "mr:currenteventspace"]{Creating and Setting the Eventspace} @subsection[#:tag "mr:currenteventspace"]{Creating and Setting the Eventspace}
Whenever a frame, dialog, or timer is created, it is associated with Whenever a frame, dialog, or timer is created, it is associated with
the eventspace specified by the @scheme[current-eventspace] parameter the @deftech{current eventspace} as determined by the
@|SeeMzParam|. When the @scheme[current-eventspace] procedure is @scheme[current-eventspace] parameter @|SeeMzParam|.
called with no arguments, it returns the current eventspace value.
When @scheme[current-eventspace] is called with an eventspace value,
it changes the current eventspace to the provided one.
The @scheme[make-eventspace] procedure creates a new The @scheme[make-eventspace] procedure creates a new
eventspace. The following example creates a new eventspace and a new eventspace. The following example creates a new eventspace and a new

View File

@ -1,5 +1,6 @@
#reader(lib "defreader.ss" "scribble") #reader(lib "defreader.ss" "scribble")
@require["common.ss"] @require["common.ss"]
@require["area-intf.scrbl"]
@definterface[window<%> (area<%>)]{ @definterface[window<%> (area<%>)]{