From ccf8eccf1ac45e49d3403dc5004b4f8ba14e36cf Mon Sep 17 00:00:00 2001 From: Matthew Flatt Date: Sat, 18 Aug 2007 22:37:36 +0000 Subject: [PATCH] turn on GUI doc generation in scribblings setup svn: r7118 original commit: 190b8f6e21d10486c9bac51a5e09937ab92dd7a3 --- .../scribblings/gui/area-container-intf.scrbl | 1 + .../gui/area-container-window-intf.scrbl | 2 + collects/scribblings/gui/button-class.scrbl | 11 ++- collects/scribblings/gui/canvas-class.scrbl | 3 +- collects/scribblings/gui/canvas-intf.scrbl | 1 + .../scribblings/gui/check-box-class.scrbl | 11 +-- .../gui/checkable-menu-item-class.scrbl | 1 + collects/scribblings/gui/choice-class.scrbl | 1 + .../scribblings/gui/combo-field-class.scrbl | 1 + .../scribblings/gui/control-event-class.scrbl | 1 + collects/scribblings/gui/control-intf.scrbl | 1 + collects/scribblings/gui/dialog-class.scrbl | 7 +- .../scribblings/gui/editor-canvas-class.scrbl | 11 +-- collects/scribblings/gui/editor-classes.scrbl | 33 +------ collects/scribblings/gui/editor-intf.scrbl | 24 ++--- .../scribblings/gui/editor-snip-class.scrbl | 7 +- .../editor-stream-in-bytes-base-class.scrbl | 1 + .../editor-stream-out-bytes-base-class.scrbl | 1 + collects/scribblings/gui/frame-class.scrbl | 3 +- collects/scribblings/gui/gauge-class.scrbl | 1 + .../gui/group-box-panel-class.scrbl | 1 + .../gui/grow-box-spacer-pane-class.scrbl | 1 + collects/scribblings/gui/gui.scrbl | 2 +- .../gui/horizontal-pane-class.scrbl | 1 + .../gui/horizontal-panel-class.scrbl | 1 + .../scribblings/gui/image-snip-class.scrbl | 3 +- .../scribblings/gui/key-event-class.scrbl | 1 + collects/scribblings/gui/keymap-class.scrbl | 2 +- .../gui/labelled-menu-item-intf.scrbl | 1 + collects/scribblings/gui/list-box-class.scrbl | 13 +-- .../scribblings/gui/list-control-intf.scrbl | 1 + collects/scribblings/gui/menu-bar-class.scrbl | 1 + collects/scribblings/gui/menu-class.scrbl | 2 + .../scribblings/gui/menu-item-class.scrbl | 1 + collects/scribblings/gui/message-class.scrbl | 10 ++- .../scribblings/gui/mouse-event-class.scrbl | 1 + collects/scribblings/gui/pane-class.scrbl | 2 + collects/scribblings/gui/panel-class.scrbl | 2 + .../scribblings/gui/pasteboard-class.scrbl | 71 ++++++++------- .../scribblings/gui/popup-menu-class.scrbl | 1 + collects/scribblings/gui/prefs.scrbl | 85 ++++++++++++++++++ .../scribblings/gui/printer-dc-class.scrbl | 1 + .../scribblings/gui/radio-box-class.scrbl | 5 +- .../scribblings/gui/scroll-event-class.scrbl | 1 + .../gui/selectable-menu-item-intf.scrbl | 1 + .../gui/separator-menu-item-class.scrbl | 1 + collects/scribblings/gui/slider-class.scrbl | 1 + collects/scribblings/gui/snip-class.scrbl | 2 +- .../scribblings/gui/string-snip-class.scrbl | 1 + collects/scribblings/gui/subarea-intf.scrbl | 1 + collects/scribblings/gui/subwindow-intf.scrbl | 2 + .../scribblings/gui/tab-panel-class.scrbl | 1 + collects/scribblings/gui/tab-snip-class.scrbl | 1 + collects/scribblings/gui/text-class.scrbl | 87 ++++++++++--------- .../scribblings/gui/text-field-class.scrbl | 1 + .../gui/top-level-window-intf.scrbl | 10 ++- .../scribblings/gui/vertical-pane-class.scrbl | 1 + .../gui/vertical-panel-class.scrbl | 1 + collects/scribblings/gui/win-classes.scrbl | 53 +---------- collects/scribblings/gui/win-overview.scrbl | 19 ++-- collects/scribblings/gui/window-intf.scrbl | 1 + 61 files changed, 295 insertions(+), 221 deletions(-) create mode 100644 collects/scribblings/gui/prefs.scrbl diff --git a/collects/scribblings/gui/area-container-intf.scrbl b/collects/scribblings/gui/area-container-intf.scrbl index c7f7e4ba..b4ffa86d 100644 --- a/collects/scribblings/gui/area-container-intf.scrbl +++ b/collects/scribblings/gui/area-container-intf.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["area-intf.scrbl"] @definterface[area-container<%> (area<%>)]{ diff --git a/collects/scribblings/gui/area-container-window-intf.scrbl b/collects/scribblings/gui/area-container-window-intf.scrbl index 8498dc71..9b38ea3e 100644 --- a/collects/scribblings/gui/area-container-window-intf.scrbl +++ b/collects/scribblings/gui/area-container-window-intf.scrbl @@ -1,5 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["area-container-intf.scrbl"] +@require["window-intf.scrbl"] @definterface[area-container-window<%> (area-container<%> window<%>)]{ diff --git a/collects/scribblings/gui/button-class.scrbl b/collects/scribblings/gui/button-class.scrbl index 0831fcb9..f8216dc3 100644 --- a/collects/scribblings/gui/button-class.scrbl +++ b/collects/scribblings/gui/button-class.scrbl @@ -1,6 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] - +@require["control-intf.scrbl"] @defclass[button% object% (control<%>)]{ @@ -56,11 +56,14 @@ on-traverse-char]). @DeletedStyleNote{button} @FontKWs[] @WindowKWs[] @SubareaKWs[] @AreaKWs[]} -@defmethod[#:mode 'add - (set-label [label (is-a?/c bitmap%)]) +@defmethod[#:mode override + (set-label [label (or/c label-string? (is-a?/c bitmap%))]) 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| }} diff --git a/collects/scribblings/gui/canvas-class.scrbl b/collects/scribblings/gui/canvas-class.scrbl index d65a5f76..83dd7901 100644 --- a/collects/scribblings/gui/canvas-class.scrbl +++ b/collects/scribblings/gui/canvas-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["canvas-intf.scrbl"] @defclass[canvas% object% (canvas<%>)]{ @@ -269,7 +270,7 @@ See also } -@defmethod[#:mode 'override +@defmethod[#:mode override (on-paint) void?]{ diff --git a/collects/scribblings/gui/canvas-intf.scrbl b/collects/scribblings/gui/canvas-intf.scrbl index f1358382..4bb5444d 100644 --- a/collects/scribblings/gui/canvas-intf.scrbl +++ b/collects/scribblings/gui/canvas-intf.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["subwindow-intf.scrbl"] @definterface[canvas<%> (subwindow<%>)]{ diff --git a/collects/scribblings/gui/check-box-class.scrbl b/collects/scribblings/gui/check-box-class.scrbl index 5c6484da..f57c5fdd 100644 --- a/collects/scribblings/gui/check-box-class.scrbl +++ b/collects/scribblings/gui/check-box-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["control-intf.scrbl"] @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 - (set-label [label (is-a?/c bitmap%)]) +@defmethod[#:mode override + (set-label [label (or/c label-string? (is-a?/c bitmap%))]) 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| - - } @defmethod[(set-value [state any/c]) diff --git a/collects/scribblings/gui/checkable-menu-item-class.scrbl b/collects/scribblings/gui/checkable-menu-item-class.scrbl index 735759ff..bc14bff6 100644 --- a/collects/scribblings/gui/checkable-menu-item-class.scrbl +++ b/collects/scribblings/gui/checkable-menu-item-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["selectable-menu-item-intf.scrbl"] @defclass[checkable-menu-item% object% (selectable-menu-item<%>)]{ diff --git a/collects/scribblings/gui/choice-class.scrbl b/collects/scribblings/gui/choice-class.scrbl index 384fb41c..d6b3904f 100644 --- a/collects/scribblings/gui/choice-class.scrbl +++ b/collects/scribblings/gui/choice-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["list-control-intf.scrbl"] @defclass[choice% object% (list-control<%>)]{ diff --git a/collects/scribblings/gui/combo-field-class.scrbl b/collects/scribblings/gui/combo-field-class.scrbl index 4a8b6bef..c978045d 100644 --- a/collects/scribblings/gui/combo-field-class.scrbl +++ b/collects/scribblings/gui/combo-field-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["text-field-class.scrbl"] @defclass[combo-field% text-field% ()]{ diff --git a/collects/scribblings/gui/control-event-class.scrbl b/collects/scribblings/gui/control-event-class.scrbl index ac0376d1..cc16964a 100644 --- a/collects/scribblings/gui/control-event-class.scrbl +++ b/collects/scribblings/gui/control-event-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["event-class.scrbl"] @defclass[control-event% event% ()]{ diff --git a/collects/scribblings/gui/control-intf.scrbl b/collects/scribblings/gui/control-intf.scrbl index 8f4bc84e..cd6e2592 100644 --- a/collects/scribblings/gui/control-intf.scrbl +++ b/collects/scribblings/gui/control-intf.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["subwindow-intf.scrbl"] @definterface[control<%> (subwindow<%>)]{ diff --git a/collects/scribblings/gui/dialog-class.scrbl b/collects/scribblings/gui/dialog-class.scrbl index a6a90639..a79963f6 100644 --- a/collects/scribblings/gui/dialog-class.scrbl +++ b/collects/scribblings/gui/dialog-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["top-level-window-intf.scrbl"] @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[] } -@defmethod[#:mode 'override +@defmethod[#:mode override (on-subwindow-char [receiver (is-a?/c window<%>)] [event (is-a?/c key-event%)]) boolean?]{ @@ -92,7 +93,7 @@ Returns the result of } -@defmethod[#:mode 'auto-super +@defmethod[#:mode override (show [show? any/c]) 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] method returns as soon as possible after the dialog is hidden. - - } } diff --git a/collects/scribblings/gui/editor-canvas-class.scrbl b/collects/scribblings/gui/editor-canvas-class.scrbl index 8c6fd304..87392f0e 100644 --- a/collects/scribblings/gui/editor-canvas-class.scrbl +++ b/collects/scribblings/gui/editor-canvas-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["canvas-intf.scrbl"] @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%)]) 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%)]) void?]{ @@ -222,7 +223,7 @@ See also @method[editor-canvas% get-editor]. } -@defmethod[#:mode 'override +@defmethod[#:mode override (on-focus [on? any/c]) 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) void?]{ @@ -239,7 +240,7 @@ Repaints the editor. } -@defmethod[#:mode 'override +@defmethod[#:mode override (on-size [width (integer-in 0 10000)] [height (integer-in 0 10000)]) void?]{ diff --git a/collects/scribblings/gui/editor-classes.scrbl b/collects/scribblings/gui/editor-classes.scrbl index cbcd6268..248e714b 100644 --- a/collects/scribblings/gui/editor-classes.scrbl +++ b/collects/scribblings/gui/editor-classes.scrbl @@ -1,6 +1,7 @@ #reader(lib "docreader.ss" "scribble") @require["common.ss"] @require["diagrams.ss"] +@require["mred-classes.ss"] @title[#:style '(toc quiet)]{Editor Classes} @@ -28,38 +29,6 @@ Alphabetical: @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[editor<%>] @include-class[editor-admin%] diff --git a/collects/scribblings/gui/editor-intf.scrbl b/collects/scribblings/gui/editor-intf.scrbl index b765b3b4..600153f2 100644 --- a/collects/scribblings/gui/editor-intf.scrbl +++ b/collects/scribblings/gui/editor-intf.scrbl @@ -93,7 +93,7 @@ pasteboard editor, the default cursor is an arrow. }} -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (after-edit-sequence) void?]{ @@ -115,7 +115,7 @@ Does nothing. } -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (after-load-file [success? any/c]) void?]{ @@ -140,7 +140,7 @@ Does nothing. } } -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (after-save-file [success? any/c]) void?]{ @@ -280,7 +280,7 @@ locked, etc. }} -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (can-load-file? [filename path?] [format (one-of/c 'guess 'standard 'text 'text-force-cr 'same 'copy)]) boolean?]{ @@ -305,7 +305,7 @@ Returns @scheme[#t]. }} -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (can-save-file? [filename path?] [format (one-of/c 'guess 'standard 'text 'text-force-cr 'same 'copy)]) boolean?]{ @@ -336,7 +336,7 @@ Returns @scheme[#t]. void?])]{ 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, 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) void?]{ @@ -1289,7 +1289,7 @@ Does nothing. See also @xmethod[text% on-default-event] and }} -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (on-display-size) void?]{ @@ -1328,7 +1328,7 @@ Calls @method[editor<%> on-display-size] unless the editor is } -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (on-edit-sequence) 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?] [format (one-of/c 'guess 'standard 'text 'text-force-cr 'same 'copy)]) void?]{ @@ -1566,7 +1566,7 @@ Does nothing. }} -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (on-save-file [filename path?] [format (one-of/c 'guess 'standard 'text 'text-force-cr 'same 'copy)]) void?]{ @@ -1592,7 +1592,7 @@ Does nothing. }} -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (on-snip-modified [snip (is-a?/c snip%)] [modified? any/c]) void?]{ diff --git a/collects/scribblings/gui/editor-snip-class.scrbl b/collects/scribblings/gui/editor-snip-class.scrbl index 25f5de6c..09560f37 100644 --- a/collects/scribblings/gui/editor-snip-class.scrbl +++ b/collects/scribblings/gui/editor-snip-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["snip-class.scrbl"] @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<%>)] [x 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<%>)] [x 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?))] [h (and/c real? (not/c negative?))]) boolean?]{ diff --git a/collects/scribblings/gui/editor-stream-in-bytes-base-class.scrbl b/collects/scribblings/gui/editor-stream-in-bytes-base-class.scrbl index 0723e9bb..dfad9c82 100644 --- a/collects/scribblings/gui/editor-stream-in-bytes-base-class.scrbl +++ b/collects/scribblings/gui/editor-stream-in-bytes-base-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["editor-stream-in-base-class.scrbl"] @defclass[editor-stream-in-bytes-base% editor-stream-in-base% ()]{ diff --git a/collects/scribblings/gui/editor-stream-out-bytes-base-class.scrbl b/collects/scribblings/gui/editor-stream-out-bytes-base-class.scrbl index e68796ba..cbf88102 100644 --- a/collects/scribblings/gui/editor-stream-out-bytes-base-class.scrbl +++ b/collects/scribblings/gui/editor-stream-out-bytes-base-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["editor-stream-out-base-class.scrbl"] @defclass[editor-stream-out-bytes-base% editor-stream-out-base% ()]{ diff --git a/collects/scribblings/gui/frame-class.scrbl b/collects/scribblings/gui/frame-class.scrbl index aab294dd..6ff7338c 100644 --- a/collects/scribblings/gui/frame-class.scrbl +++ b/collects/scribblings/gui/frame-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["top-level-window-intf.scrbl"] @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<%>)] [event (is-a?/c key-event%)]) boolean?]{ diff --git a/collects/scribblings/gui/gauge-class.scrbl b/collects/scribblings/gui/gauge-class.scrbl index 1ad22d14..f4c0c7a0 100644 --- a/collects/scribblings/gui/gauge-class.scrbl +++ b/collects/scribblings/gui/gauge-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["control-intf.scrbl"] @defclass[gauge% object% (control<%>)]{ diff --git a/collects/scribblings/gui/group-box-panel-class.scrbl b/collects/scribblings/gui/group-box-panel-class.scrbl index 56b96b20..d178576f 100644 --- a/collects/scribblings/gui/group-box-panel-class.scrbl +++ b/collects/scribblings/gui/group-box-panel-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["vertical-panel-class.scrbl"] @defclass[group-box-panel% vertical-panel% ()]{ diff --git a/collects/scribblings/gui/grow-box-spacer-pane-class.scrbl b/collects/scribblings/gui/grow-box-spacer-pane-class.scrbl index c622a5be..b9d5a06a 100644 --- a/collects/scribblings/gui/grow-box-spacer-pane-class.scrbl +++ b/collects/scribblings/gui/grow-box-spacer-pane-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["pane-class.scrbl"] @defclass[grow-box-spacer-pane% pane% ()]{ diff --git a/collects/scribblings/gui/gui.scrbl b/collects/scribblings/gui/gui.scrbl index 877bae78..43fca16e 100644 --- a/collects/scribblings/gui/gui.scrbl +++ b/collects/scribblings/gui/gui.scrbl @@ -1,7 +1,7 @@ #reader(lib "docreader.ss" "scribble") @require["common.ss"] -@title{PLT Scheme GUI Toolbox} +@title{PLT Scheme GUI: MrEd} This manual describes MrEd. diff --git a/collects/scribblings/gui/horizontal-pane-class.scrbl b/collects/scribblings/gui/horizontal-pane-class.scrbl index f85a0a31..f779d8d9 100644 --- a/collects/scribblings/gui/horizontal-pane-class.scrbl +++ b/collects/scribblings/gui/horizontal-pane-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["pane-class.scrbl"] @defclass[horizontal-pane% pane% ()]{ diff --git a/collects/scribblings/gui/horizontal-panel-class.scrbl b/collects/scribblings/gui/horizontal-panel-class.scrbl index 3e410050..09502153 100644 --- a/collects/scribblings/gui/horizontal-panel-class.scrbl +++ b/collects/scribblings/gui/horizontal-panel-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["panel-class.scrbl"] @defclass[horizontal-panel% panel% ()]{ diff --git a/collects/scribblings/gui/image-snip-class.scrbl b/collects/scribblings/gui/image-snip-class.scrbl index a63924da..7f9c25c4 100644 --- a/collects/scribblings/gui/image-snip-class.scrbl +++ b/collects/scribblings/gui/image-snip-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["snip-class.scrbl"] @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?))] [h (and/c real? (not/c negative?))]) void?]{ diff --git a/collects/scribblings/gui/key-event-class.scrbl b/collects/scribblings/gui/key-event-class.scrbl index a830e3b3..0e33c12a 100644 --- a/collects/scribblings/gui/key-event-class.scrbl +++ b/collects/scribblings/gui/key-event-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["event-class.scrbl"] @defclass[key-event% event% ()]{ diff --git a/collects/scribblings/gui/keymap-class.scrbl b/collects/scribblings/gui/keymap-class.scrbl index 77d5409e..6f6c5470 100644 --- a/collects/scribblings/gui/keymap-class.scrbl +++ b/collects/scribblings/gui/keymap-class.scrbl @@ -327,7 +327,7 @@ Examples: 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 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 states are mapped to the name; the handler is dispatched by name at diff --git a/collects/scribblings/gui/labelled-menu-item-intf.scrbl b/collects/scribblings/gui/labelled-menu-item-intf.scrbl index 4893c98b..25cee105 100644 --- a/collects/scribblings/gui/labelled-menu-item-intf.scrbl +++ b/collects/scribblings/gui/labelled-menu-item-intf.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["menu-item-intf.scrbl"] @definterface[labelled-menu-item<%> (menu-item<%>)]{ diff --git a/collects/scribblings/gui/list-box-class.scrbl b/collects/scribblings/gui/list-box-class.scrbl index f6baa9fb..97adb5f7 100644 --- a/collects/scribblings/gui/list-box-class.scrbl +++ b/collects/scribblings/gui/list-box-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["list-control-intf.scrbl"] @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] - [data any/c]) + [data any/c #f]) void?]{ 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 - provided merely as a convenience for use with -@method[list-box% get-data], possibly allowing a programmer to avoid managing a separate - item-to-data mapping in addition to the list box control. + provided merely as a convenience for use with @method[list-box% + get-data], possibly allowing a programmer to avoid managing a + separate item-to-data mapping in addition to the list box control. + +See also @xmethod[list-control<%> append]. } diff --git a/collects/scribblings/gui/list-control-intf.scrbl b/collects/scribblings/gui/list-control-intf.scrbl index 10f72bec..335b080d 100644 --- a/collects/scribblings/gui/list-control-intf.scrbl +++ b/collects/scribblings/gui/list-control-intf.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["control-intf.scrbl"] @definterface[list-control<%> (control<%>)]{ diff --git a/collects/scribblings/gui/menu-bar-class.scrbl b/collects/scribblings/gui/menu-bar-class.scrbl index 6d60c142..b43c05d8 100644 --- a/collects/scribblings/gui/menu-bar-class.scrbl +++ b/collects/scribblings/gui/menu-bar-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["menu-item-container-intf.scrbl"] @defclass[menu-bar% object% (menu-item-container<%>)]{ diff --git a/collects/scribblings/gui/menu-class.scrbl b/collects/scribblings/gui/menu-class.scrbl index 73d6703f..13905478 100644 --- a/collects/scribblings/gui/menu-class.scrbl +++ b/collects/scribblings/gui/menu-class.scrbl @@ -1,5 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["labelled-menu-item-intf.scrbl"] +@require["menu-item-container-intf.scrbl"] @defclass[menu% object% (menu-item-container<%> labelled-menu-item<%>)]{ diff --git a/collects/scribblings/gui/menu-item-class.scrbl b/collects/scribblings/gui/menu-item-class.scrbl index e660cfcb..b5fad9bd 100644 --- a/collects/scribblings/gui/menu-item-class.scrbl +++ b/collects/scribblings/gui/menu-item-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["selectable-menu-item-intf.scrbl"] @defclass[menu-item% object% (selectable-menu-item<%>)]{ diff --git a/collects/scribblings/gui/message-class.scrbl b/collects/scribblings/gui/message-class.scrbl index 725a55b4..ec7aae8b 100644 --- a/collects/scribblings/gui/message-class.scrbl +++ b/collects/scribblings/gui/message-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["control-intf.scrbl"] @defclass[message% object% (control<%>)]{ @@ -38,11 +39,14 @@ Creates a string or bitmap message initially showing @scheme[label]. } -@defmethod[#:mode 'add - (set-label [label (is-a?/c bitmap%)]) +@defmethod[#:mode override + (set-label [label (or/c label-string? (is-a?/c bitmap%))]) 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| }} diff --git a/collects/scribblings/gui/mouse-event-class.scrbl b/collects/scribblings/gui/mouse-event-class.scrbl index ccd4380d..0836fd91 100644 --- a/collects/scribblings/gui/mouse-event-class.scrbl +++ b/collects/scribblings/gui/mouse-event-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["event-class.scrbl"] @defclass[mouse-event% event% ()]{ diff --git a/collects/scribblings/gui/pane-class.scrbl b/collects/scribblings/gui/pane-class.scrbl index d271fd6b..339ff8ce 100644 --- a/collects/scribblings/gui/pane-class.scrbl +++ b/collects/scribblings/gui/pane-class.scrbl @@ -1,5 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["area-container-intf.scrbl"] +@require["subarea-intf.scrbl"] @defclass[pane% object% (area-container<%> subarea<%>)]{ diff --git a/collects/scribblings/gui/panel-class.scrbl b/collects/scribblings/gui/panel-class.scrbl index 63e9fd5e..34c9933b 100644 --- a/collects/scribblings/gui/panel-class.scrbl +++ b/collects/scribblings/gui/panel-class.scrbl @@ -1,5 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["subwindow-intf.scrbl"] +@require["area-container-window-intf.scrbl"] @defclass[panel% object% (area-container-window<%> subwindow<%>)]{ diff --git a/collects/scribblings/gui/pasteboard-class.scrbl b/collects/scribblings/gui/pasteboard-class.scrbl index 678664db..2e244ea2 100644 --- a/collects/scribblings/gui/pasteboard-class.scrbl +++ b/collects/scribblings/gui/pasteboard-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["editor-intf.scrbl"] @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%)]) void?]{ @methspec{ @@ -60,7 +61,7 @@ Does nothing. } -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (after-insert [snip (is-a?/c snip%)] [before (or/c (is-a?/c snip%) false/c)] [x real?] @@ -86,7 +87,7 @@ Does nothing. } -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (after-interactive-move [event (is-a?/c mouse-event%)]) void?]{ @methspec{ @@ -108,7 +109,7 @@ Does nothing. } -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (after-interactive-resize [snip (is-a?/c snip%)]) void?]{ @methspec{ @@ -129,7 +130,7 @@ Does nothing. }} -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (after-move-to [snip (is-a?/c snip%)] [x real?] [y real?] @@ -159,7 +160,7 @@ Does nothing. }} -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (after-reorder [snip (is-a?/c snip%)] [to-snip (is-a?/c snip%)] [before? any/c]) @@ -188,7 +189,7 @@ Does nothing. }} -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (after-resize [snip (is-a?/c snip%)] [w (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%)] [on? any/c]) void?]{ @@ -246,7 +247,7 @@ Does nothing. }} -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (can-delete? [snip (is-a?/c snip%)]) boolean?]{ @@ -270,7 +271,7 @@ Returns @scheme[#t]. } } -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (can-insert? [snip (is-a?/c snip%)] [before (or/c (is-a?/c snip%) false/c)] [x real?] @@ -297,7 +298,7 @@ Returns @scheme[#t]. } -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (can-interactive-move? [event (is-a?/c mouse-event%)]) boolean?]{ @@ -322,7 +323,7 @@ Returns @scheme[#t]. }} -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (can-interactive-resize? [snip (is-a?/c snip%)]) boolean?]{ @methspec{ @@ -346,7 +347,7 @@ Returns @scheme[#t]. }} -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (can-move-to? [snip (is-a?/c snip%)] [x real?] [y real?] @@ -374,7 +375,7 @@ Returns @scheme[#t]. }} -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (can-reorder? [snip (is-a?/c snip%)] [to-snip (is-a?/c snip%)] [before? any/c]) @@ -403,7 +404,7 @@ Returns @scheme[#t]. }} -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (can-resize? [snip (is-a?/c snip%)] [w (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%)] [on? any/c]) 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)] [snip (or/c (is-a?/c snip%) false/c) #f]) void?] [(change-style [delta (or/c (is-a?/c style-delta%) false/c)] - [snip (is-a?/c snip%)]) + [snip (is-a?/c snip%) #f]) void?])]{ 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 - selected snips are changed. + selected snips are changed. See also @xmethod[editor<%> change-style]. 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%))]) 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]. } @@ -648,8 +650,10 @@ Returns whether selection dots are drawn around the edge of selected } -@defmethod*[#:mode 'add - ([(insert [snip (is-a?/c snip%)] +@defmethod*[#:mode extend + ([(insert [snip (is-a?/c snip%)]) + void?] + [(insert [snip (is-a?/c snip%)] [before (or/c (is-a?/c snip%) false/c)] [x real?] [y real?]) @@ -666,7 +670,8 @@ Inserts @scheme[snip] at @techlink{location} @math{(@scheme[x], @scheme[y])} just in front of @scheme[before]. (@|seesniporderdiscuss|) If @scheme[before] is nor 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%)]) void?]{ @@ -831,7 +836,7 @@ object.} } -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (on-delete [snip (is-a?/c snip%)]) 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%)] [before (or/c (is-a?/c snip%) false/c)] [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%)]) void?]{ @methspec{ @@ -908,7 +913,7 @@ Does nothing. }} -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (on-interactive-resize [snip (is-a?/c snip%)]) void?]{ @methspec{ @@ -930,7 +935,7 @@ Does nothing. }} -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (on-move-to [snip (is-a?/c snip%)] [x real?] [y real?] @@ -960,7 +965,7 @@ Does nothing. }} -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (on-reorder [snip (is-a?/c snip%)] [to-snip (is-a?/c snip%)] [before? any/c]) @@ -987,7 +992,7 @@ Does nothing. }} -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (on-resize [snip (is-a?/c snip%)] [w (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? any/c]) void?]{ diff --git a/collects/scribblings/gui/popup-menu-class.scrbl b/collects/scribblings/gui/popup-menu-class.scrbl index 92e703d0..18af8e54 100644 --- a/collects/scribblings/gui/popup-menu-class.scrbl +++ b/collects/scribblings/gui/popup-menu-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["menu-item-container-intf.scrbl"] @defclass[popup-menu% object% (menu-item-container<%>)]{ diff --git a/collects/scribblings/gui/prefs.scrbl b/collects/scribblings/gui/prefs.scrbl new file mode 100644 index 00000000..d44ee569 --- /dev/null +++ b/collects/scribblings/gui/prefs.scrbl @@ -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. diff --git a/collects/scribblings/gui/printer-dc-class.scrbl b/collects/scribblings/gui/printer-dc-class.scrbl index 49b8abfb..b010e44a 100644 --- a/collects/scribblings/gui/printer-dc-class.scrbl +++ b/collects/scribblings/gui/printer-dc-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["dc-intf.scrbl"] @defclass[printer-dc% object% (dc<%>)]{ diff --git a/collects/scribblings/gui/radio-box-class.scrbl b/collects/scribblings/gui/radio-box-class.scrbl index 672584fe..8775873f 100644 --- a/collects/scribblings/gui/radio-box-class.scrbl +++ b/collects/scribblings/gui/radio-box-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["control-intf.scrbl"] @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]) void?] [(enable [n nonnegative-exact-integer?] @@ -122,7 +123,7 @@ numbered from @scheme[0]. } -@defmethod*[#:mode 'override +@defmethod*[#:mode override ([(is-enabled?) boolean?] [(is-enabled? [n nonnegative-exact-integer?]) diff --git a/collects/scribblings/gui/scroll-event-class.scrbl b/collects/scribblings/gui/scroll-event-class.scrbl index 6cd32336..f95bd451 100644 --- a/collects/scribblings/gui/scroll-event-class.scrbl +++ b/collects/scribblings/gui/scroll-event-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["event-class.scrbl"] @defclass[scroll-event% event% ()]{ diff --git a/collects/scribblings/gui/selectable-menu-item-intf.scrbl b/collects/scribblings/gui/selectable-menu-item-intf.scrbl index e3b94c05..56336b5a 100644 --- a/collects/scribblings/gui/selectable-menu-item-intf.scrbl +++ b/collects/scribblings/gui/selectable-menu-item-intf.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["labelled-menu-item-intf.scrbl"] @definterface[selectable-menu-item<%> (labelled-menu-item<%>)]{ diff --git a/collects/scribblings/gui/separator-menu-item-class.scrbl b/collects/scribblings/gui/separator-menu-item-class.scrbl index b34c8005..3f732ca8 100644 --- a/collects/scribblings/gui/separator-menu-item-class.scrbl +++ b/collects/scribblings/gui/separator-menu-item-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["menu-item-intf.scrbl"] @defclass[separator-menu-item% object% (menu-item<%>)]{ diff --git a/collects/scribblings/gui/slider-class.scrbl b/collects/scribblings/gui/slider-class.scrbl index 027bc240..3a935187 100644 --- a/collects/scribblings/gui/slider-class.scrbl +++ b/collects/scribblings/gui/slider-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["control-intf.scrbl"] @defclass[slider% object% (control<%>)]{ diff --git a/collects/scribblings/gui/snip-class.scrbl b/collects/scribblings/gui/snip-class.scrbl index d3a4332e..cd248399 100644 --- a/collects/scribblings/gui/snip-class.scrbl +++ b/collects/scribblings/gui/snip-class.scrbl @@ -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 'paste 'kill 'select-all 'insert-text-box 'insert-pasteboard-box diff --git a/collects/scribblings/gui/string-snip-class.scrbl b/collects/scribblings/gui/string-snip-class.scrbl index d4796dfd..7305bbfc 100644 --- a/collects/scribblings/gui/string-snip-class.scrbl +++ b/collects/scribblings/gui/string-snip-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["snip-class.scrbl"] @defclass[string-snip% snip% ()]{ diff --git a/collects/scribblings/gui/subarea-intf.scrbl b/collects/scribblings/gui/subarea-intf.scrbl index 3c808f1b..45895824 100644 --- a/collects/scribblings/gui/subarea-intf.scrbl +++ b/collects/scribblings/gui/subarea-intf.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["area-intf.scrbl"] @definterface[subarea<%> (area<%>)]{ diff --git a/collects/scribblings/gui/subwindow-intf.scrbl b/collects/scribblings/gui/subwindow-intf.scrbl index 324f9616..e6508632 100644 --- a/collects/scribblings/gui/subwindow-intf.scrbl +++ b/collects/scribblings/gui/subwindow-intf.scrbl @@ -1,5 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["window-intf.scrbl"] +@require["subarea-intf.scrbl"] @definterface[subwindow<%> (subarea<%> window<%>)]{ diff --git a/collects/scribblings/gui/tab-panel-class.scrbl b/collects/scribblings/gui/tab-panel-class.scrbl index 36f351f6..50e83601 100644 --- a/collects/scribblings/gui/tab-panel-class.scrbl +++ b/collects/scribblings/gui/tab-panel-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["vertical-panel-class.scrbl"] @defclass[tab-panel% vertical-panel% ()]{ diff --git a/collects/scribblings/gui/tab-snip-class.scrbl b/collects/scribblings/gui/tab-snip-class.scrbl index 5f3d0403..2033ea00 100644 --- a/collects/scribblings/gui/tab-snip-class.scrbl +++ b/collects/scribblings/gui/tab-snip-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["string-snip-class.scrbl"] @defclass[tab-snip% string-snip% ()]{ diff --git a/collects/scribblings/gui/text-class.scrbl b/collects/scribblings/gui/text-class.scrbl index 622859b9..1aa4e55b 100644 --- a/collects/scribblings/gui/text-class.scrbl +++ b/collects/scribblings/gui/text-class.scrbl @@ -1,6 +1,8 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["editor-intf.scrbl"] + @defclass[text% object% (editor<%>)]{ 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?] [len nonnegative-exact-integer?]) void?]{ @@ -55,7 +57,7 @@ Does nothing. }} -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (after-delete [start nonnegative-exact-integer?] [len nonnegative-exact-integer?]) void?]{ @@ -83,7 +85,7 @@ Does nothing. }} -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (after-insert [start nonnegative-exact-integer?] [len nonnegative-exact-integer?]) void?]{ @@ -110,7 +112,7 @@ Does nothing. }} -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (after-merge-snips [pos nonnegative-exact-integer?]) void?]{ @methspec{ @@ -131,7 +133,7 @@ Does nothing. }} -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (after-set-position) void?]{ @@ -150,7 +152,7 @@ Does nothing. }} -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (after-set-size-constraint) void?]{ @@ -176,7 +178,7 @@ Does nothing. }} -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (after-split-snip [pos nonnegative-exact-integer?]) void?]{ @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?] [len nonnegative-exact-integer?]) boolean?]{ @@ -231,7 +233,7 @@ Returns @scheme[#t]. } } -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (can-delete? [start nonnegative-exact-integer?] [len nonnegative-exact-integer?]) boolean?]{ @@ -260,7 +262,7 @@ Returns @scheme[#t]. }} -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (can-insert? [start nonnegative-exact-integer?] [len nonnegative-exact-integer?]) boolean?]{ @@ -288,7 +290,7 @@ Returns @scheme[#t]. }} -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (can-set-size-constraint?) 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)] - [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] [counts-as-mod? any/c @scheme[#t]]) void?] @@ -349,10 +351,10 @@ When @scheme[style] is provided: @InStyleListNote[] } -@defmethod[#:mode 'add +@defmethod[#:mode extend (copy [extend? any/c] [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]) 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, @|MismatchExn|. - } -@defmethod[#:mode 'auto-super +@defmethod[#:mode override (copy-self-to [dest (or/c (is-a?/c text%) (is-a?/c pasteboard%))]) 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 state, and autowrap bitmap are installed into @scheme[dest]. } -@defmethod[#:mode 'add +@defmethod[#:mode override (cut [extend? any/c] [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]) void?]{ @@ -1027,7 +1029,7 @@ See also @method[text% caret-hidden?] and @method[editor<%> lock]. } -@defmethod*[#:mode 'override +@defmethod*[#:mode override ([(insert [str string?] [start nonnegative-exact-integer?] [end (or/c nonnegative-exact-integer? (one/of 'same)) 'same] @@ -1094,13 +1096,18 @@ See also @method[text% get-styles-sticky]. } -@defmethod[#:mode 'add - (kill [time (and/c exact? integer?)] - [start nonnegative-exact-integer?] - [end nonnegative-exact-integer?]) - void?]{ +@defmethod*[#:mode override + ([(kill [time (and/c exact? integer?) 0]) + void?] + [(kill [time (and/c exact? integer?)] + [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 @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?] [len nonnegative-exact-integer?]) void?]{ @@ -1303,7 +1310,7 @@ Does nothing. } -@defmethod[#:mode 'override +@defmethod[#:mode override (on-default-char [event (is-a?/c key-event%)]) 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%)]) 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?] [len nonnegative-exact-integer?]) void?]{ @@ -1385,7 +1392,7 @@ Does nothing. }} -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (on-insert [start nonnegative-exact-integer?] [len nonnegative-exact-integer?]) void?]{ @@ -1448,7 +1455,7 @@ Returns a @scheme[tab-snip%] instance. }} -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (on-set-size-constraint) 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?)] - [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]) 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?)] - [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]) 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%)] [start (or/c nonnegative-exact-integer? (one/of 'start))] [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%)] - [start nonnegative-exact-integer?] + [start nonnegative-exact-integer? 0] [end (or/c nonnegative-exact-integer? (one/of 'eof)) 'eof]) boolean?]{ diff --git a/collects/scribblings/gui/text-field-class.scrbl b/collects/scribblings/gui/text-field-class.scrbl index 0c5a093f..cd40f1eb 100644 --- a/collects/scribblings/gui/text-field-class.scrbl +++ b/collects/scribblings/gui/text-field-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["control-intf.scrbl"] @defclass[text-field% object% (control<%>)]{ diff --git a/collects/scribblings/gui/top-level-window-intf.scrbl b/collects/scribblings/gui/top-level-window-intf.scrbl index 3f4a6097..63673cd6 100644 --- a/collects/scribblings/gui/top-level-window-intf.scrbl +++ b/collects/scribblings/gui/top-level-window-intf.scrbl @@ -1,12 +1,13 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["area-container-window-intf.scrbl"] @definterface[top-level-window<%> (area-container-window<%>)]{ A top-level window is either a @scheme[frame%] or @scheme[dialog%] object. -@defmethod[#:mode 'pubment +@defmethod[#:mode pubment (can-close?) 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) void?]{ @@ -312,12 +313,13 @@ Sets the size of the window (in pixels), but only if the given size is } -@defmethod[#:mode 'auto-super - (show [show any/c]) +@defmethod[(show [show any/c]) void?]{ 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. +See also @xmethod[window<%> show]. + }} diff --git a/collects/scribblings/gui/vertical-pane-class.scrbl b/collects/scribblings/gui/vertical-pane-class.scrbl index f02221f1..1f05ebb1 100644 --- a/collects/scribblings/gui/vertical-pane-class.scrbl +++ b/collects/scribblings/gui/vertical-pane-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["pane-class.scrbl"] @defclass[vertical-pane% pane% ()]{ diff --git a/collects/scribblings/gui/vertical-panel-class.scrbl b/collects/scribblings/gui/vertical-panel-class.scrbl index a68080be..5cd7aad1 100644 --- a/collects/scribblings/gui/vertical-panel-class.scrbl +++ b/collects/scribblings/gui/vertical-panel-class.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["panel-class.scrbl"] @defclass[vertical-panel% panel% ()]{ diff --git a/collects/scribblings/gui/win-classes.scrbl b/collects/scribblings/gui/win-classes.scrbl index 3d254d09..585a5e4a 100644 --- a/collects/scribblings/gui/win-classes.scrbl +++ b/collects/scribblings/gui/win-classes.scrbl @@ -1,6 +1,7 @@ #reader(lib "docreader.ss" "scribble") @require["common.ss"] @require["diagrams.ss"] +@require["mred-classes.ss"] @title[#:style '(toc quiet)]{Windowing Classes} @@ -20,58 +21,6 @@ Alphabetical: @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-container<%>] @include-class[area-container-window<%>] diff --git a/collects/scribblings/gui/win-overview.scrbl b/collects/scribblings/gui/win-overview.scrbl index ebf911ea..7dc42d50 100644 --- a/collects/scribblings/gui/win-overview.scrbl +++ b/collects/scribblings/gui/win-overview.scrbl @@ -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 subwindow for displaying a text editor or pasteboard editor. The @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: @@ -700,7 +700,7 @@ Controls, such as buttons and list boxes, handle keyboard and mouse @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 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} -@section-index['("events" "timer")] -@section-index['("events" "explicitly queued")] +@section-index["events" "timer"] +@section-index["events" "explicitly queued"] In addition to events corresponding to user and windowing actions, such as button clicks, key presses, and updates, the system dispatches two kinds of internal events: @tech{timer events} and @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 call the timer's @method[timer% notify] method. Like a top-level 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 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 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 @@ -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} Whenever a frame, dialog, or timer is created, it is associated with - the eventspace specified by the @scheme[current-eventspace] parameter - @|SeeMzParam|. When the @scheme[current-eventspace] procedure is - 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 @deftech{current eventspace} as determined by the + @scheme[current-eventspace] parameter @|SeeMzParam|. The @scheme[make-eventspace] procedure creates a new eventspace. The following example creates a new eventspace and a new diff --git a/collects/scribblings/gui/window-intf.scrbl b/collects/scribblings/gui/window-intf.scrbl index 4c201e60..9e2a7317 100644 --- a/collects/scribblings/gui/window-intf.scrbl +++ b/collects/scribblings/gui/window-intf.scrbl @@ -1,5 +1,6 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] +@require["area-intf.scrbl"] @definterface[window<%> (area<%>)]{