From 9489fbe1d32c9785fac5806fa6b26c291011ed65 Mon Sep 17 00:00:00 2001 From: Matthew Flatt Date: Thu, 6 Sep 2007 13:19:15 +0000 Subject: [PATCH] improced scribble class/interface doc forms svn: r7284 original commit: 93cc35bd5bbc419650b2c9a85dfce555658dfdb4 --- collects/scribblings/gui/add-color-intf.scrbl | 4 +- .../scribblings/gui/area-container-intf.scrbl | 5 +- .../gui/area-container-window-intf.scrbl | 6 +- collects/scribblings/gui/area-intf.scrbl | 4 +- collects/scribblings/gui/button-class.scrbl | 5 +- collects/scribblings/gui/canvas-class.scrbl | 5 +- collects/scribblings/gui/canvas-intf.scrbl | 5 +- .../scribblings/gui/check-box-class.scrbl | 5 +- .../gui/checkable-menu-item-class.scrbl | 5 +- collects/scribblings/gui/choice-class.scrbl | 5 +- .../gui/clipboard-client-class.scrbl | 4 +- collects/scribblings/gui/clipboard-intf.scrbl | 4 +- .../scribblings/gui/combo-field-class.scrbl | 5 +- .../scribblings/gui/control-event-class.scrbl | 5 +- collects/scribblings/gui/control-intf.scrbl | 5 +- collects/scribblings/gui/cursor-class.scrbl | 4 +- collects/scribblings/gui/dialog-class.scrbl | 5 +- .../scribblings/gui/editor-admin-class.scrbl | 4 +- .../scribblings/gui/editor-canvas-class.scrbl | 5 +- collects/scribblings/gui/editor-classes.scrbl | 63 ++++++----- .../gui/editor-data-class-class.scrbl | 4 +- .../gui/editor-data-class-list-intf.scrbl | 4 +- .../scribblings/gui/editor-data-class.scrbl | 4 +- collects/scribblings/gui/editor-intf.scrbl | 4 +- .../scribblings/gui/editor-snip-class.scrbl | 5 +- .../gui/editor-snip-editor-admin-intf.scrbl | 4 +- .../gui/editor-stream-in-base-class.scrbl | 4 +- .../editor-stream-in-bytes-base-class.scrbl | 5 +- .../gui/editor-stream-in-class.scrbl | 4 +- .../gui/editor-stream-out-base-class.scrbl | 4 +- .../editor-stream-out-bytes-base-class.scrbl | 5 +- .../gui/editor-stream-out-class.scrbl | 4 +- .../gui/editor-wordbreak-map-class.scrbl | 4 +- collects/scribblings/gui/event-class.scrbl | 4 +- collects/scribblings/gui/frame-class.scrbl | 5 +- collects/scribblings/gui/gauge-class.scrbl | 5 +- .../gui/group-box-panel-class.scrbl | 5 +- .../gui/grow-box-spacer-pane-class.scrbl | 5 +- .../gui/horizontal-pane-class.scrbl | 5 +- .../gui/horizontal-panel-class.scrbl | 5 +- .../scribblings/gui/image-snip-class.scrbl | 5 +- .../scribblings/gui/key-event-class.scrbl | 5 +- collects/scribblings/gui/keymap-class.scrbl | 4 +- .../gui/labelled-menu-item-intf.scrbl | 5 +- collects/scribblings/gui/list-box-class.scrbl | 5 +- .../scribblings/gui/list-control-intf.scrbl | 5 +- collects/scribblings/gui/menu-bar-class.scrbl | 5 +- collects/scribblings/gui/menu-class.scrbl | 6 +- .../scribblings/gui/menu-item-class.scrbl | 5 +- .../gui/menu-item-container-intf.scrbl | 4 +- collects/scribblings/gui/menu-item-intf.scrbl | 4 +- collects/scribblings/gui/message-class.scrbl | 5 +- .../scribblings/gui/mouse-event-class.scrbl | 5 +- .../scribblings/gui/mult-color-intf.scrbl | 4 +- collects/scribblings/gui/pane-class.scrbl | 6 +- collects/scribblings/gui/panel-class.scrbl | 6 +- .../scribblings/gui/pasteboard-class.scrbl | 5 +- .../scribblings/gui/popup-menu-class.scrbl | 5 +- .../scribblings/gui/printer-dc-class.scrbl | 5 +- .../scribblings/gui/radio-box-class.scrbl | 5 +- .../scribblings/gui/readable-snip-intf.scrbl | 4 +- .../scribblings/gui/scroll-event-class.scrbl | 5 +- .../gui/selectable-menu-item-intf.scrbl | 5 +- .../gui/separator-menu-item-class.scrbl | 5 +- collects/scribblings/gui/slider-class.scrbl | 5 +- .../scribblings/gui/snip-admin-class.scrbl | 4 +- .../scribblings/gui/snip-class-class.scrbl | 4 +- .../gui/snip-class-list-intf.scrbl | 4 +- collects/scribblings/gui/snip-class.scrbl | 4 +- .../scribblings/gui/string-snip-class.scrbl | 5 +- .../scribblings/gui/style-delta-class.scrbl | 4 +- collects/scribblings/gui/style-intf.scrbl | 4 +- .../scribblings/gui/style-list-class.scrbl | 4 +- collects/scribblings/gui/subarea-intf.scrbl | 5 +- collects/scribblings/gui/subwindow-intf.scrbl | 6 +- .../scribblings/gui/tab-panel-class.scrbl | 5 +- collects/scribblings/gui/tab-snip-class.scrbl | 5 +- collects/scribblings/gui/text-class.scrbl | 6 +- .../scribblings/gui/text-field-class.scrbl | 5 +- collects/scribblings/gui/timer-class.scrbl | 4 +- .../gui/top-level-window-intf.scrbl | 5 +- .../scribblings/gui/vertical-pane-class.scrbl | 5 +- .../gui/vertical-panel-class.scrbl | 5 +- collects/scribblings/gui/win-classes.scrbl | 103 +++++++++--------- collects/scribblings/gui/window-intf.scrbl | 5 +- 85 files changed, 248 insertions(+), 309 deletions(-) diff --git a/collects/scribblings/gui/add-color-intf.scrbl b/collects/scribblings/gui/add-color-intf.scrbl index 1c545c11..3c6d55fe 100644 --- a/collects/scribblings/gui/add-color-intf.scrbl +++ b/collects/scribblings/gui/add-color-intf.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-interface-doc[add-color<%> ()]{ +@definterface/title[add-color<%> ()]{ An @scheme[add-color<%>] object is used to additively change the RGB values of a @scheme[color%] object. An @scheme[add-color<%>] object diff --git a/collects/scribblings/gui/area-container-intf.scrbl b/collects/scribblings/gui/area-container-intf.scrbl index a1b36811..2727d310 100644 --- a/collects/scribblings/gui/area-container-intf.scrbl +++ b/collects/scribblings/gui/area-container-intf.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["area-intf.scrbl"] -@define-interface-doc[area-container<%> (area<%>)]{ +@definterface/title[area-container<%> (area<%>)]{ An @scheme[area-container<%>] is a container @scheme[area<%>]. diff --git a/collects/scribblings/gui/area-container-window-intf.scrbl b/collects/scribblings/gui/area-container-window-intf.scrbl index 109ec0c0..80719605 100644 --- a/collects/scribblings/gui/area-container-window-intf.scrbl +++ b/collects/scribblings/gui/area-container-window-intf.scrbl @@ -1,9 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["area-container-intf.scrbl"] -@require["window-intf.scrbl"] -@define-interface-doc[area-container-window<%> (area-container<%> window<%>)]{ +@definterface/title[area-container-window<%> (area-container<%> window<%>)]{ Combines two interfaces. diff --git a/collects/scribblings/gui/area-intf.scrbl b/collects/scribblings/gui/area-intf.scrbl index 21533563..cb1f60fd 100644 --- a/collects/scribblings/gui/area-intf.scrbl +++ b/collects/scribblings/gui/area-intf.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-interface-doc[area<%> ()]{ +@definterface/title[area<%> ()]{ An @scheme[area<%>] object is either a window or a windowless container for managing the position and size of other areas. An diff --git a/collects/scribblings/gui/button-class.scrbl b/collects/scribblings/gui/button-class.scrbl index 6de59b97..cfc8b2d6 100644 --- a/collects/scribblings/gui/button-class.scrbl +++ b/collects/scribblings/gui/button-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["control-intf.scrbl"] -@define-class-doc[button% object% (control<%>)]{ +@defclass/title[button% object% (control<%>)]{ Whenever a button is clicked by the user, the buttons's callback procedure is invoked. A callback procedure is provided as an diff --git a/collects/scribblings/gui/canvas-class.scrbl b/collects/scribblings/gui/canvas-class.scrbl index 42a84b36..0cfc9ad8 100644 --- a/collects/scribblings/gui/canvas-class.scrbl +++ b/collects/scribblings/gui/canvas-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["canvas-intf.scrbl"] -@define-class-doc[canvas% object% (canvas<%>)]{ +@defclass/title[canvas% object% (canvas<%>)]{ A @scheme[canvas%] object is a general-purpose window for drawing and handling events. diff --git a/collects/scribblings/gui/canvas-intf.scrbl b/collects/scribblings/gui/canvas-intf.scrbl index e10ec458..f4c62587 100644 --- a/collects/scribblings/gui/canvas-intf.scrbl +++ b/collects/scribblings/gui/canvas-intf.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["subwindow-intf.scrbl"] -@define-interface-doc[canvas<%> (subwindow<%>)]{ +@definterface/title[canvas<%> (subwindow<%>)]{ A canvas is a subwindow onto which graphics and text can be drawn. Canvases also receive mouse and keyboard events. diff --git a/collects/scribblings/gui/check-box-class.scrbl b/collects/scribblings/gui/check-box-class.scrbl index 01333596..37b30f64 100644 --- a/collects/scribblings/gui/check-box-class.scrbl +++ b/collects/scribblings/gui/check-box-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["control-intf.scrbl"] -@define-class-doc[check-box% object% (control<%>)]{ +@defclass/title[check-box% object% (control<%>)]{ A check box is a labeled box which is either checked or unchecked. diff --git a/collects/scribblings/gui/checkable-menu-item-class.scrbl b/collects/scribblings/gui/checkable-menu-item-class.scrbl index 28306b56..2abff568 100644 --- a/collects/scribblings/gui/checkable-menu-item-class.scrbl +++ b/collects/scribblings/gui/checkable-menu-item-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["selectable-menu-item-intf.scrbl"] -@define-class-doc[checkable-menu-item% object% (selectable-menu-item<%>)]{ +@defclass/title[checkable-menu-item% object% (selectable-menu-item<%>)]{ A @scheme[checkable-menu-item%] is a string-labelled menu item that maintains a check mark. Its parent must be a @scheme[menu%] or diff --git a/collects/scribblings/gui/choice-class.scrbl b/collects/scribblings/gui/choice-class.scrbl index b1fe6e3b..27594d3f 100644 --- a/collects/scribblings/gui/choice-class.scrbl +++ b/collects/scribblings/gui/choice-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["list-control-intf.scrbl"] -@define-class-doc[choice% object% (list-control<%>)]{ +@defclass/title[choice% object% (list-control<%>)]{ A choice item allows the user to select one string item from a pop-up list of items. Unlike a list box, only the currently selection is diff --git a/collects/scribblings/gui/clipboard-client-class.scrbl b/collects/scribblings/gui/clipboard-client-class.scrbl index ddf79abf..b4fb0501 100644 --- a/collects/scribblings/gui/clipboard-client-class.scrbl +++ b/collects/scribblings/gui/clipboard-client-class.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-class-doc[clipboard-client% object% ()]{ +@defclass/title[clipboard-client% object% ()]{ A @scheme[clipboard-client%] object allows a program to take over the clipboard and service requests for clipboard data. See diff --git a/collects/scribblings/gui/clipboard-intf.scrbl b/collects/scribblings/gui/clipboard-intf.scrbl index 747f3618..7b97a438 100644 --- a/collects/scribblings/gui/clipboard-intf.scrbl +++ b/collects/scribblings/gui/clipboard-intf.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-interface-doc[clipboard<%> ()]{ +@definterface/title[clipboard<%> ()]{ A single @scheme[clipboard<%>] object, @indexed-scheme[the-clipboard], manages the content of the system-wide clipboard for cut and paste. diff --git a/collects/scribblings/gui/combo-field-class.scrbl b/collects/scribblings/gui/combo-field-class.scrbl index 6803d827..13a36fd3 100644 --- a/collects/scribblings/gui/combo-field-class.scrbl +++ b/collects/scribblings/gui/combo-field-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["text-field-class.scrbl"] -@define-class-doc[combo-field% text-field% ()]{ +@defclass/title[combo-field% text-field% ()]{ A @scheme[combo-field%] object is a @scheme[text-field%] object that also resembles a @scheme[choice%] object, because it diff --git a/collects/scribblings/gui/control-event-class.scrbl b/collects/scribblings/gui/control-event-class.scrbl index af8c08e8..e7c88732 100644 --- a/collects/scribblings/gui/control-event-class.scrbl +++ b/collects/scribblings/gui/control-event-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["event-class.scrbl"] -@define-class-doc[control-event% event% ()]{ +@defclass/title[control-event% event% ()]{ A @scheme[control-event%] object contains information about a control event. An instance of @scheme[control-event%] is always diff --git a/collects/scribblings/gui/control-intf.scrbl b/collects/scribblings/gui/control-intf.scrbl index c29657d0..02204dc1 100644 --- a/collects/scribblings/gui/control-intf.scrbl +++ b/collects/scribblings/gui/control-intf.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["subwindow-intf.scrbl"] -@define-interface-doc[control<%> (subwindow<%>)]{ +@definterface/title[control<%> (subwindow<%>)]{ The @scheme[control<%>] interface is implemented by the built-in control window classes: diff --git a/collects/scribblings/gui/cursor-class.scrbl b/collects/scribblings/gui/cursor-class.scrbl index 22963b66..9369c355 100644 --- a/collects/scribblings/gui/cursor-class.scrbl +++ b/collects/scribblings/gui/cursor-class.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-class-doc[cursor% object% ()]{ +@defclass/title[cursor% object% ()]{ A cursor is a small icon that indicates the location of the mouse pointer. The bitmap image typically indicates the current mode or diff --git a/collects/scribblings/gui/dialog-class.scrbl b/collects/scribblings/gui/dialog-class.scrbl index 4d7e4b6a..6099cb21 100644 --- a/collects/scribblings/gui/dialog-class.scrbl +++ b/collects/scribblings/gui/dialog-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["top-level-window-intf.scrbl"] -@define-class-doc[dialog% object% (top-level-window<%>)]{ +@defclass/title[dialog% object% (top-level-window<%>)]{ A dialog is a top-level window that is @defterm{modal}: while the dialog is shown, all other top-level windows in the dialog's diff --git a/collects/scribblings/gui/editor-admin-class.scrbl b/collects/scribblings/gui/editor-admin-class.scrbl index 93028ffe..74ad865d 100644 --- a/collects/scribblings/gui/editor-admin-class.scrbl +++ b/collects/scribblings/gui/editor-admin-class.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-class-doc[editor-admin% object% ()]{ +@defclass/title[editor-admin% object% ()]{ See @|admindiscuss| for information about the role of administrators. The @scheme[editor-admin%] class is never instantiated directly. It diff --git a/collects/scribblings/gui/editor-canvas-class.scrbl b/collects/scribblings/gui/editor-canvas-class.scrbl index f73d3c10..c0fe65d8 100644 --- a/collects/scribblings/gui/editor-canvas-class.scrbl +++ b/collects/scribblings/gui/editor-canvas-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["canvas-intf.scrbl"] -@define-class-doc[editor-canvas% object% (canvas<%>)]{ +@defclass/title[editor-canvas% object% (canvas<%>)]{ An @scheme[editor-canvas%] object manages and displays a @scheme[text%] or @scheme[pasteboard%] object. diff --git a/collects/scribblings/gui/editor-classes.scrbl b/collects/scribblings/gui/editor-classes.scrbl index f2f4dac8..c8b23f91 100644 --- a/collects/scribblings/gui/editor-classes.scrbl +++ b/collects/scribblings/gui/editor-classes.scrbl @@ -1,7 +1,6 @@ #reader(lib "docreader.ss" "scribble") @require["common.ss"] @require["diagrams.ss"] -@require["mred-classes.ss"] @title[#:style '(toc quiet)]{Editor Classes} @@ -29,34 +28,34 @@ Alphabetical: @local-table-of-contents[] -@include-class-section[add-color<%>] -@include-class-section[editor<%>] -@include-class-section[editor-admin%] -@include-class-section[editor-canvas%] -@include-class-section[editor-data%] -@include-class-section[editor-data-class%] -@include-class-section[editor-data-class-list<%>] -@include-class-section[editor-snip-editor-admin<%>] -@include-class-section[editor-snip%] -@include-class-section[editor-stream-in%] -@include-class-section[editor-stream-in-base%] -@include-class-section[editor-stream-in-bytes-base%] -@include-class-section[editor-stream-out%] -@include-class-section[editor-stream-out-base%] -@include-class-section[editor-stream-out-bytes-base%] -@include-class-section[editor-wordbreak-map%] -@include-class-section[image-snip%] -@include-class-section[keymap%] -@include-class-section[mult-color<%>] -@include-class-section[pasteboard%] -@include-class-section[readable-snip<%>] -@include-class-section[snip%] -@include-class-section[snip-admin%] -@include-class-section[snip-class%] -@include-class-section[snip-class-list<%>] -@include-class-section[string-snip%] -@include-class-section[style<%>] -@include-class-section[style-delta%] -@include-class-section[style-list%] -@include-class-section[tab-snip%] -@include-class-section[text%] +@include-section["add-color-intf.scrbl"] +@include-section["editor-intf.scrbl"] +@include-section["editor-admin-class.scrbl"] +@include-section["editor-canvas-class.scrbl"] +@include-section["editor-data-class.scrbl"] +@include-section["editor-data-class-class.scrbl"] +@include-section["editor-data-class-list-intf.scrbl"] +@include-section["editor-snip-editor-admin-intf.scrbl"] +@include-section["editor-snip-class.scrbl"] +@include-section["editor-stream-in-class.scrbl"] +@include-section["editor-stream-in-base-class.scrbl"] +@include-section["editor-stream-in-bytes-base-class.scrbl"] +@include-section["editor-stream-out-class.scrbl"] +@include-section["editor-stream-out-base-class.scrbl"] +@include-section["editor-stream-out-bytes-base-class.scrbl"] +@include-section["editor-wordbreak-map-class.scrbl"] +@include-section["image-snip-class.scrbl"] +@include-section["keymap-class.scrbl"] +@include-section["mult-color-intf.scrbl"] +@include-section["pasteboard-class.scrbl"] +@include-section["readable-snip-intf.scrbl"] +@include-section["snip-class.scrbl"] +@include-section["snip-admin-class.scrbl"] +@include-section["snip-class-class.scrbl"] +@include-section["snip-class-list-intf.scrbl"] +@include-section["string-snip-class.scrbl"] +@include-section["style-intf.scrbl"] +@include-section["style-delta-class.scrbl"] +@include-section["style-list-class.scrbl"] +@include-section["tab-snip-class.scrbl"] +@include-section["text-class.scrbl"] diff --git a/collects/scribblings/gui/editor-data-class-class.scrbl b/collects/scribblings/gui/editor-data-class-class.scrbl index 4b60b845..749fedb6 100644 --- a/collects/scribblings/gui/editor-data-class-class.scrbl +++ b/collects/scribblings/gui/editor-data-class-class.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-class-doc[editor-data-class% object% ()]{ +@defclass/title[editor-data-class% object% ()]{ An @scheme[editor-data-class%] object defines a type for @scheme[editor-data%] objects. See also @|editordatadiscuss|. diff --git a/collects/scribblings/gui/editor-data-class-list-intf.scrbl b/collects/scribblings/gui/editor-data-class-list-intf.scrbl index 2f287ee6..db108a00 100644 --- a/collects/scribblings/gui/editor-data-class-list-intf.scrbl +++ b/collects/scribblings/gui/editor-data-class-list-intf.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-interface-doc[editor-data-class-list<%> ()]{ +@definterface/title[editor-data-class-list<%> ()]{ Each eventspace has an instance of @scheme[editor-data-class-list<%>], obtained with @scheme[(get-the-editor-data-class-list)]. New diff --git a/collects/scribblings/gui/editor-data-class.scrbl b/collects/scribblings/gui/editor-data-class.scrbl index 7f58477b..f350a39b 100644 --- a/collects/scribblings/gui/editor-data-class.scrbl +++ b/collects/scribblings/gui/editor-data-class.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-class-doc[editor-data% object% ()]{ +@defclass/title[editor-data% object% ()]{ An @scheme[editor-data%] object contains extra data associated to a snip or region in an editor. See also @|editordatadiscuss|. diff --git a/collects/scribblings/gui/editor-intf.scrbl b/collects/scribblings/gui/editor-intf.scrbl index ba199e41..25fe49a7 100644 --- a/collects/scribblings/gui/editor-intf.scrbl +++ b/collects/scribblings/gui/editor-intf.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-interface-doc[editor<%> ()]{ +@definterface/title[editor<%> ()]{ The @scheme[editor<%>] interface is implemented by @scheme[text%] and @scheme[pasteboard%]. diff --git a/collects/scribblings/gui/editor-snip-class.scrbl b/collects/scribblings/gui/editor-snip-class.scrbl index 8aea28de..18e73a52 100644 --- a/collects/scribblings/gui/editor-snip-class.scrbl +++ b/collects/scribblings/gui/editor-snip-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["snip-class.scrbl"] -@define-class-doc[editor-snip% snip% ()]{ +@defclass/title[editor-snip% snip% ()]{ An @scheme[editor-snip%] object is a @scheme[snip%] object that contains and displays an @scheme[editor<%>] object. This snip class diff --git a/collects/scribblings/gui/editor-snip-editor-admin-intf.scrbl b/collects/scribblings/gui/editor-snip-editor-admin-intf.scrbl index 44733239..12104c6a 100644 --- a/collects/scribblings/gui/editor-snip-editor-admin-intf.scrbl +++ b/collects/scribblings/gui/editor-snip-editor-admin-intf.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-interface-doc[editor-snip-editor-admin<%> ()]{ +@definterface/title[editor-snip-editor-admin<%> ()]{ An instance of this administrator interface is created with each @scheme[editor-snip%] object; new instances cannot be diff --git a/collects/scribblings/gui/editor-stream-in-base-class.scrbl b/collects/scribblings/gui/editor-stream-in-base-class.scrbl index 6784ac81..355e3ee0 100644 --- a/collects/scribblings/gui/editor-stream-in-base-class.scrbl +++ b/collects/scribblings/gui/editor-stream-in-base-class.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-class-doc[editor-stream-in-base% object% ()]{ +@defclass/title[editor-stream-in-base% object% ()]{ An @scheme[editor-stream-in-base%] object is used by an @scheme[editor-stream-in%] object to perform low-level reading of 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 d4d74d42..d1d97126 100644 --- a/collects/scribblings/gui/editor-stream-in-bytes-base-class.scrbl +++ b/collects/scribblings/gui/editor-stream-in-bytes-base-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["editor-stream-in-base-class.scrbl"] -@define-class-doc[editor-stream-in-bytes-base% editor-stream-in-base% ()]{ +@defclass/title[editor-stream-in-bytes-base% editor-stream-in-base% ()]{ An @scheme[editor-stream-in-bytes-base%] object can be used to read editor data from a byte string. diff --git a/collects/scribblings/gui/editor-stream-in-class.scrbl b/collects/scribblings/gui/editor-stream-in-class.scrbl index de5e40fc..0427dfd9 100644 --- a/collects/scribblings/gui/editor-stream-in-class.scrbl +++ b/collects/scribblings/gui/editor-stream-in-class.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-class-doc[editor-stream-in% object% ()]{ +@defclass/title[editor-stream-in% object% ()]{ An @scheme[editor-stream-in%] object is used to read editor information from a file or other input stream (such as the diff --git a/collects/scribblings/gui/editor-stream-out-base-class.scrbl b/collects/scribblings/gui/editor-stream-out-base-class.scrbl index 98f64a03..fcd279e3 100644 --- a/collects/scribblings/gui/editor-stream-out-base-class.scrbl +++ b/collects/scribblings/gui/editor-stream-out-base-class.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-class-doc[editor-stream-out-base% object% ()]{ +@defclass/title[editor-stream-out-base% object% ()]{ An @scheme[editor-stream-out-base%] object is used by an @scheme[editor-stream-out%] object to perform low-level writing of 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 17baf9f6..c6fef1ba 100644 --- a/collects/scribblings/gui/editor-stream-out-bytes-base-class.scrbl +++ b/collects/scribblings/gui/editor-stream-out-bytes-base-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["editor-stream-out-base-class.scrbl"] -@define-class-doc[editor-stream-out-bytes-base% editor-stream-out-base% ()]{ +@defclass/title[editor-stream-out-bytes-base% editor-stream-out-base% ()]{ An @scheme[editor-stream-out-bytes-base%] object can be used to write editor data into a byte string. diff --git a/collects/scribblings/gui/editor-stream-out-class.scrbl b/collects/scribblings/gui/editor-stream-out-class.scrbl index c004c844..3736046d 100644 --- a/collects/scribblings/gui/editor-stream-out-class.scrbl +++ b/collects/scribblings/gui/editor-stream-out-class.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-class-doc[editor-stream-out% object% ()]{ +@defclass/title[editor-stream-out% object% ()]{ An @scheme[editor-stream-out%] object is used to write editor information to a file or other output stream (such as the diff --git a/collects/scribblings/gui/editor-wordbreak-map-class.scrbl b/collects/scribblings/gui/editor-wordbreak-map-class.scrbl index 1b63f70d..3e319901 100644 --- a/collects/scribblings/gui/editor-wordbreak-map-class.scrbl +++ b/collects/scribblings/gui/editor-wordbreak-map-class.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-class-doc[editor-wordbreak-map% object% ()]{ +@defclass/title[editor-wordbreak-map% object% ()]{ An @scheme[editor-wordbreak-map%] objects is used with a @scheme[text%] objects to specify word-breaking criteria for the diff --git a/collects/scribblings/gui/event-class.scrbl b/collects/scribblings/gui/event-class.scrbl index 1a668c61..d5fea2bb 100644 --- a/collects/scribblings/gui/event-class.scrbl +++ b/collects/scribblings/gui/event-class.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-class-doc[event% object% ()]{ +@defclass/title[event% object% ()]{ An @scheme[event%] object contains information about a control, keyboard, mouse, or scroll event. See also diff --git a/collects/scribblings/gui/frame-class.scrbl b/collects/scribblings/gui/frame-class.scrbl index cf846e4f..336ddfa6 100644 --- a/collects/scribblings/gui/frame-class.scrbl +++ b/collects/scribblings/gui/frame-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["top-level-window-intf.scrbl"] -@define-class-doc[frame% object% (top-level-window<%>)]{ +@defclass/title[frame% object% (top-level-window<%>)]{ A frame is a top-level container window. It has a title bar (which displays the frame's label), an optional menu bar, and an optional diff --git a/collects/scribblings/gui/gauge-class.scrbl b/collects/scribblings/gui/gauge-class.scrbl index 9d748dc5..3b6c9ace 100644 --- a/collects/scribblings/gui/gauge-class.scrbl +++ b/collects/scribblings/gui/gauge-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["control-intf.scrbl"] -@define-class-doc[gauge% object% (control<%>)]{ +@defclass/title[gauge% object% (control<%>)]{ A gauge is a horizontal or vertical bar for displaying the output value of a bounded integer quantity. Each gauge has an adjustable diff --git a/collects/scribblings/gui/group-box-panel-class.scrbl b/collects/scribblings/gui/group-box-panel-class.scrbl index c9c957f4..110997a7 100644 --- a/collects/scribblings/gui/group-box-panel-class.scrbl +++ b/collects/scribblings/gui/group-box-panel-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["vertical-panel-class.scrbl"] -@define-class-doc[group-box-panel% vertical-panel% ()]{ +@defclass/title[group-box-panel% vertical-panel% ()]{ A group-box panel arranges its subwindows in a single column, but also draws an optional label at the top of the panel and a border around diff --git a/collects/scribblings/gui/grow-box-spacer-pane-class.scrbl b/collects/scribblings/gui/grow-box-spacer-pane-class.scrbl index 7ae9bc7f..445234af 100644 --- a/collects/scribblings/gui/grow-box-spacer-pane-class.scrbl +++ b/collects/scribblings/gui/grow-box-spacer-pane-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["pane-class.scrbl"] -@define-class-doc[grow-box-spacer-pane% pane% ()]{ +@defclass/title[grow-box-spacer-pane% pane% ()]{ A @scheme[grow-box-spacer-pane%] object is intended for use as a lightweight spacer in the bottom-right corner of a frame, rather than diff --git a/collects/scribblings/gui/horizontal-pane-class.scrbl b/collects/scribblings/gui/horizontal-pane-class.scrbl index 6046a503..6d861146 100644 --- a/collects/scribblings/gui/horizontal-pane-class.scrbl +++ b/collects/scribblings/gui/horizontal-pane-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["pane-class.scrbl"] -@define-class-doc[horizontal-pane% pane% ()]{ +@defclass/title[horizontal-pane% pane% ()]{ A horizontal pane arranges its subwindows in a single row. See also @scheme[pane%]. diff --git a/collects/scribblings/gui/horizontal-panel-class.scrbl b/collects/scribblings/gui/horizontal-panel-class.scrbl index 06a72a3c..c68b45d3 100644 --- a/collects/scribblings/gui/horizontal-panel-class.scrbl +++ b/collects/scribblings/gui/horizontal-panel-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["panel-class.scrbl"] -@define-class-doc[horizontal-panel% panel% ()]{ +@defclass/title[horizontal-panel% panel% ()]{ A horizontal panel arranges its subwindows in a single row. See also @scheme[panel%]. diff --git a/collects/scribblings/gui/image-snip-class.scrbl b/collects/scribblings/gui/image-snip-class.scrbl index fe22bbdf..493f78c8 100644 --- a/collects/scribblings/gui/image-snip-class.scrbl +++ b/collects/scribblings/gui/image-snip-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["snip-class.scrbl"] -@define-class-doc[image-snip% snip% ()]{ +@defclass/title[image-snip% snip% ()]{ An @scheme[image-snip%] is a snip that can display bitmap images (usually loaded from a file). When the image file cannot be found, a diff --git a/collects/scribblings/gui/key-event-class.scrbl b/collects/scribblings/gui/key-event-class.scrbl index 6cc8caec..56ba23c3 100644 --- a/collects/scribblings/gui/key-event-class.scrbl +++ b/collects/scribblings/gui/key-event-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["event-class.scrbl"] -@define-class-doc[key-event% event% ()]{ +@defclass/title[key-event% event% ()]{ A @scheme[key-event%] object contains information about a key press or release event. Key events are primarily processed by diff --git a/collects/scribblings/gui/keymap-class.scrbl b/collects/scribblings/gui/keymap-class.scrbl index 72d1ce79..070ecbb3 100644 --- a/collects/scribblings/gui/keymap-class.scrbl +++ b/collects/scribblings/gui/keymap-class.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-class-doc[keymap% object% ()]{ +@defclass/title[keymap% object% ()]{ A @scheme[keymap%] object is used by @scheme[editor<%>] objects to map keyboard and mouse sequences to arbitrary functions in an diff --git a/collects/scribblings/gui/labelled-menu-item-intf.scrbl b/collects/scribblings/gui/labelled-menu-item-intf.scrbl index c70cfbc8..3a6bf570 100644 --- a/collects/scribblings/gui/labelled-menu-item-intf.scrbl +++ b/collects/scribblings/gui/labelled-menu-item-intf.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["menu-item-intf.scrbl"] -@define-interface-doc[labelled-menu-item<%> (menu-item<%>)]{ +@definterface/title[labelled-menu-item<%> (menu-item<%>)]{ A @scheme[labelled-menu-item<%>] object is a @scheme[menu-item<%>] with a string label (i.e., any menu item other than a separator). More diff --git a/collects/scribblings/gui/list-box-class.scrbl b/collects/scribblings/gui/list-box-class.scrbl index fce81309..e7045813 100644 --- a/collects/scribblings/gui/list-box-class.scrbl +++ b/collects/scribblings/gui/list-box-class.scrbl @@ -1,11 +1,10 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["list-control-intf.scrbl"] @define[lbnumnote @elem{List box items are indexed from @scheme[0].}] -@define-class-doc[list-box% object% (list-control<%>)]{ +@defclass/title[list-box% object% (list-control<%>)]{ A list box allows the user to select one or more string items from a scrolling list. A list box is either a single-selection control (if diff --git a/collects/scribblings/gui/list-control-intf.scrbl b/collects/scribblings/gui/list-control-intf.scrbl index 44deed3c..8f984c19 100644 --- a/collects/scribblings/gui/list-control-intf.scrbl +++ b/collects/scribblings/gui/list-control-intf.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["control-intf.scrbl"] -@define-interface-doc[list-control<%> (control<%>)]{ +@definterface/title[list-control<%> (control<%>)]{ A list control gives the user a list of string items to choose from. There are two built-in classes that implement diff --git a/collects/scribblings/gui/menu-bar-class.scrbl b/collects/scribblings/gui/menu-bar-class.scrbl index 2e4bc4fb..6668d8f6 100644 --- a/collects/scribblings/gui/menu-bar-class.scrbl +++ b/collects/scribblings/gui/menu-bar-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["menu-item-container-intf.scrbl"] -@define-class-doc[menu-bar% object% (menu-item-container<%>)]{ +@defclass/title[menu-bar% object% (menu-item-container<%>)]{ A @scheme[menu-bar%] object is created for a particular @scheme[frame%] object. A frame can have at most one menu bar; diff --git a/collects/scribblings/gui/menu-class.scrbl b/collects/scribblings/gui/menu-class.scrbl index 861e680a..461e5d9c 100644 --- a/collects/scribblings/gui/menu-class.scrbl +++ b/collects/scribblings/gui/menu-class.scrbl @@ -1,9 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["labelled-menu-item-intf.scrbl"] -@require["menu-item-container-intf.scrbl"] -@define-class-doc[menu% object% (menu-item-container<%> labelled-menu-item<%>)]{ +@defclass/title[menu% object% (menu-item-container<%> labelled-menu-item<%>)]{ A @scheme[menu%] object is a submenu within a @scheme[menu%] or @scheme[popup-menu%], or as a top-level menu in a diff --git a/collects/scribblings/gui/menu-item-class.scrbl b/collects/scribblings/gui/menu-item-class.scrbl index 1e707085..1aafc024 100644 --- a/collects/scribblings/gui/menu-item-class.scrbl +++ b/collects/scribblings/gui/menu-item-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["selectable-menu-item-intf.scrbl"] -@define-class-doc[menu-item% object% (selectable-menu-item<%>)]{ +@defclass/title[menu-item% object% (selectable-menu-item<%>)]{ A @scheme[menu-item%] is a plain string-labelled menu item. Its parent must be a @scheme[menu%] or @scheme[popup-menu%]. When the diff --git a/collects/scribblings/gui/menu-item-container-intf.scrbl b/collects/scribblings/gui/menu-item-container-intf.scrbl index b7812aca..25dfab95 100644 --- a/collects/scribblings/gui/menu-item-container-intf.scrbl +++ b/collects/scribblings/gui/menu-item-container-intf.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-interface-doc[menu-item-container<%> ()]{ +@definterface/title[menu-item-container<%> ()]{ A @scheme[menu-item-container<%>] object is a @scheme[menu%], @scheme[popup-menu%], or @scheme[menu-bar%]. diff --git a/collects/scribblings/gui/menu-item-intf.scrbl b/collects/scribblings/gui/menu-item-intf.scrbl index 2d78011a..6acef1b1 100644 --- a/collects/scribblings/gui/menu-item-intf.scrbl +++ b/collects/scribblings/gui/menu-item-intf.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-interface-doc[menu-item<%> ()]{ +@definterface/title[menu-item<%> ()]{ A @scheme[menu-item<%>] object is an element within a @scheme[menu%], @scheme[popup-menu%], or @scheme[menu-bar%]. Operations that affect diff --git a/collects/scribblings/gui/message-class.scrbl b/collects/scribblings/gui/message-class.scrbl index 12e1dac4..f410106c 100644 --- a/collects/scribblings/gui/message-class.scrbl +++ b/collects/scribblings/gui/message-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["control-intf.scrbl"] -@define-class-doc[message% object% (control<%>)]{ +@defclass/title[message% object% (control<%>)]{ A message control is a static line of text or a static bitmap. The text or bitmap corresponds to the message's label (see diff --git a/collects/scribblings/gui/mouse-event-class.scrbl b/collects/scribblings/gui/mouse-event-class.scrbl index 3127a80b..baeb281e 100644 --- a/collects/scribblings/gui/mouse-event-class.scrbl +++ b/collects/scribblings/gui/mouse-event-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["event-class.scrbl"] -@define-class-doc[mouse-event% event% ()]{ +@defclass/title[mouse-event% event% ()]{ A @scheme[mouse-event%] object encapsulates a mouse event. Mouse events are primarily processed by diff --git a/collects/scribblings/gui/mult-color-intf.scrbl b/collects/scribblings/gui/mult-color-intf.scrbl index d55c69a7..2ecf1914 100644 --- a/collects/scribblings/gui/mult-color-intf.scrbl +++ b/collects/scribblings/gui/mult-color-intf.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-interface-doc[mult-color<%> ()]{ +@definterface/title[mult-color<%> ()]{ A @scheme[mult-color<%>] object is used to scale the RGB values of a @scheme[color%] object. A @scheme[mult-color<%>] object exist only diff --git a/collects/scribblings/gui/pane-class.scrbl b/collects/scribblings/gui/pane-class.scrbl index f7e76aa6..d4665726 100644 --- a/collects/scribblings/gui/pane-class.scrbl +++ b/collects/scribblings/gui/pane-class.scrbl @@ -1,9 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["area-container-intf.scrbl"] -@require["subarea-intf.scrbl"] -@define-class-doc[pane% object% (area-container<%> subarea<%>)]{ +@defclass/title[pane% object% (area-container<%> subarea<%>)]{ A pane is a both a container and a containee area. It serves only as a geometry management device. A @scheme[pane%] diff --git a/collects/scribblings/gui/panel-class.scrbl b/collects/scribblings/gui/panel-class.scrbl index 4c758bf5..09b80883 100644 --- a/collects/scribblings/gui/panel-class.scrbl +++ b/collects/scribblings/gui/panel-class.scrbl @@ -1,9 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["subwindow-intf.scrbl"] -@require["area-container-window-intf.scrbl"] -@define-class-doc[panel% object% (area-container-window<%> subwindow<%>)]{ +@defclass/title[panel% object% (area-container-window<%> subwindow<%>)]{ A panel is a both a container and a containee window. It serves mainly as a geometry management device, but the @scheme['border] creates a diff --git a/collects/scribblings/gui/pasteboard-class.scrbl b/collects/scribblings/gui/pasteboard-class.scrbl index 55683479..87afbaeb 100644 --- a/collects/scribblings/gui/pasteboard-class.scrbl +++ b/collects/scribblings/gui/pasteboard-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["editor-intf.scrbl"] -@define-class-doc[pasteboard% object% (editor<%>)]{ +@defclass/title[pasteboard% object% (editor<%>)]{ A @scheme[pasteboard%] object is an editor for displaying snips with arbitrary @techlink{location}s. diff --git a/collects/scribblings/gui/popup-menu-class.scrbl b/collects/scribblings/gui/popup-menu-class.scrbl index 3629136b..078241bd 100644 --- a/collects/scribblings/gui/popup-menu-class.scrbl +++ b/collects/scribblings/gui/popup-menu-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["menu-item-container-intf.scrbl"] -@define-class-doc[popup-menu% object% (menu-item-container<%>)]{ +@defclass/title[popup-menu% object% (menu-item-container<%>)]{ A @scheme[popup-menu%] object is created without a parent. Dynamically display a @scheme[popup-menu%] with @xmethod[window<%> popup-menu] diff --git a/collects/scribblings/gui/printer-dc-class.scrbl b/collects/scribblings/gui/printer-dc-class.scrbl index 20a7755c..d7cd196b 100644 --- a/collects/scribblings/gui/printer-dc-class.scrbl +++ b/collects/scribblings/gui/printer-dc-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["dc-intf.scrbl"] -@define-class-doc[printer-dc% object% (dc<%>)]{ +@defclass/title[printer-dc% object% (dc<%>)]{ A @scheme[printer-dc%] object is a Windows or Mac OS X printer device context. The class cannot be instantiated under X (an diff --git a/collects/scribblings/gui/radio-box-class.scrbl b/collects/scribblings/gui/radio-box-class.scrbl index 2bd2738f..1171cfbf 100644 --- a/collects/scribblings/gui/radio-box-class.scrbl +++ b/collects/scribblings/gui/radio-box-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["control-intf.scrbl"] -@define-class-doc[radio-box% object% (control<%>)]{ +@defclass/title[radio-box% object% (control<%>)]{ A @scheme[radio-box%] control allows the user to select one of diff --git a/collects/scribblings/gui/readable-snip-intf.scrbl b/collects/scribblings/gui/readable-snip-intf.scrbl index ded9a28e..36d18f48 100644 --- a/collects/scribblings/gui/readable-snip-intf.scrbl +++ b/collects/scribblings/gui/readable-snip-intf.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-interface-doc[readable-snip<%> ()]{ +@definterface/title[readable-snip<%> ()]{ A @scheme[readable-snip<%>] object is treated specially by the port generated by @scheme[open-input-text-editor]. When a diff --git a/collects/scribblings/gui/scroll-event-class.scrbl b/collects/scribblings/gui/scroll-event-class.scrbl index 97163506..a82e74de 100644 --- a/collects/scribblings/gui/scroll-event-class.scrbl +++ b/collects/scribblings/gui/scroll-event-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["event-class.scrbl"] -@define-class-doc[scroll-event% event% ()]{ +@defclass/title[scroll-event% event% ()]{ A @scheme[scroll-event%] object contains information about a scroll event. An instance of @scheme[scroll-event%] is always provided to diff --git a/collects/scribblings/gui/selectable-menu-item-intf.scrbl b/collects/scribblings/gui/selectable-menu-item-intf.scrbl index 38912684..ec7262f3 100644 --- a/collects/scribblings/gui/selectable-menu-item-intf.scrbl +++ b/collects/scribblings/gui/selectable-menu-item-intf.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["labelled-menu-item-intf.scrbl"] -@define-interface-doc[selectable-menu-item<%> (labelled-menu-item<%>)]{ +@definterface/title[selectable-menu-item<%> (labelled-menu-item<%>)]{ A @scheme[selectable-menu-item<%>] object is a @scheme[labelled-menu-item<%>] that the user can select. It may also diff --git a/collects/scribblings/gui/separator-menu-item-class.scrbl b/collects/scribblings/gui/separator-menu-item-class.scrbl index a2b4cb84..8dfd0fd0 100644 --- a/collects/scribblings/gui/separator-menu-item-class.scrbl +++ b/collects/scribblings/gui/separator-menu-item-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["menu-item-intf.scrbl"] -@define-class-doc[separator-menu-item% object% (menu-item<%>)]{ +@defclass/title[separator-menu-item% object% (menu-item<%>)]{ A separator is an unselectable line in a menu. Its parent must be a @scheme[menu%] or @scheme[popup-menu%]. diff --git a/collects/scribblings/gui/slider-class.scrbl b/collects/scribblings/gui/slider-class.scrbl index 29f98153..4a4263c3 100644 --- a/collects/scribblings/gui/slider-class.scrbl +++ b/collects/scribblings/gui/slider-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["control-intf.scrbl"] -@define-class-doc[slider% object% (control<%>)]{ +@defclass/title[slider% object% (control<%>)]{ A @scheme[slider] object is a panel item with a handle that the user can drag to change the control's value. Each slider has a fixed minimum diff --git a/collects/scribblings/gui/snip-admin-class.scrbl b/collects/scribblings/gui/snip-admin-class.scrbl index 0f109cf6..a2f06693 100644 --- a/collects/scribblings/gui/snip-admin-class.scrbl +++ b/collects/scribblings/gui/snip-admin-class.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-class-doc[snip-admin% object% ()]{ +@defclass/title[snip-admin% object% ()]{ See @|admindiscuss| for information about the role of administrators. The @scheme[snip-admin%] class is never instantiated directly. It diff --git a/collects/scribblings/gui/snip-class-class.scrbl b/collects/scribblings/gui/snip-class-class.scrbl index 25223ff1..ac60c58f 100644 --- a/collects/scribblings/gui/snip-class-class.scrbl +++ b/collects/scribblings/gui/snip-class-class.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-class-doc[snip-class% object% ()]{ +@defclass/title[snip-class% object% ()]{ Useful snip classes are defined by instantiating derived subclasses of @scheme[snip-class%]. A class derived from @scheme[snip-class%] diff --git a/collects/scribblings/gui/snip-class-list-intf.scrbl b/collects/scribblings/gui/snip-class-list-intf.scrbl index c721991d..e4ce30c8 100644 --- a/collects/scribblings/gui/snip-class-list-intf.scrbl +++ b/collects/scribblings/gui/snip-class-list-intf.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-interface-doc[snip-class-list<%> ()]{ +@definterface/title[snip-class-list<%> ()]{ Each eventspace has its own instance of @scheme[snip-class-list<%>], obtained with @scheme[(get-the-snip-class-list)]. New instances diff --git a/collects/scribblings/gui/snip-class.scrbl b/collects/scribblings/gui/snip-class.scrbl index f37529d3..56d67987 100644 --- a/collects/scribblings/gui/snip-class.scrbl +++ b/collects/scribblings/gui/snip-class.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-class-doc[snip% object% ()]{ +@defclass/title[snip% object% ()]{ A direct instance of @scheme[snip%] is uninteresting. Useful snips are defined by instantiating derived subclasses, but this class defines diff --git a/collects/scribblings/gui/string-snip-class.scrbl b/collects/scribblings/gui/string-snip-class.scrbl index 7507480a..926659e7 100644 --- a/collects/scribblings/gui/string-snip-class.scrbl +++ b/collects/scribblings/gui/string-snip-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["snip-class.scrbl"] -@define-class-doc[string-snip% snip% ()]{ +@defclass/title[string-snip% snip% ()]{ An instance of @scheme[string-snip%] is created automatically when text is inserted into a text editor. See also @xmethod[text% diff --git a/collects/scribblings/gui/style-delta-class.scrbl b/collects/scribblings/gui/style-delta-class.scrbl index 95e10330..9e4d55be 100644 --- a/collects/scribblings/gui/style-delta-class.scrbl +++ b/collects/scribblings/gui/style-delta-class.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-class-doc[style-delta% object% ()]{ +@defclass/title[style-delta% object% ()]{ A @scheme[style-delta%] object encapsulates a style change. The changes expressible by a delta include: diff --git a/collects/scribblings/gui/style-intf.scrbl b/collects/scribblings/gui/style-intf.scrbl index 2cf305c6..f240ca16 100644 --- a/collects/scribblings/gui/style-intf.scrbl +++ b/collects/scribblings/gui/style-intf.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-interface-doc[style<%> ()]{ +@definterface/title[style<%> ()]{ A @scheme[style<%>] object encapsulates drawing information (font, color, alignment, etc.) in a hierarchical manner. A @scheme[style<%>] diff --git a/collects/scribblings/gui/style-list-class.scrbl b/collects/scribblings/gui/style-list-class.scrbl index 287a1344..9a9f99c1 100644 --- a/collects/scribblings/gui/style-list-class.scrbl +++ b/collects/scribblings/gui/style-list-class.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-class-doc[style-list% object% ()]{ +@defclass/title[style-list% object% ()]{ A @scheme[style-list%] object contains a set of @scheme[style<%>] objects and maintains the hierarchical relationships between them. A diff --git a/collects/scribblings/gui/subarea-intf.scrbl b/collects/scribblings/gui/subarea-intf.scrbl index 5d767623..455b81ce 100644 --- a/collects/scribblings/gui/subarea-intf.scrbl +++ b/collects/scribblings/gui/subarea-intf.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["area-intf.scrbl"] -@define-interface-doc[subarea<%> (area<%>)]{ +@definterface/title[subarea<%> (area<%>)]{ A @scheme[subarea<%>] is a containee @scheme[area<%>]. diff --git a/collects/scribblings/gui/subwindow-intf.scrbl b/collects/scribblings/gui/subwindow-intf.scrbl index 9957b0ea..47a4c558 100644 --- a/collects/scribblings/gui/subwindow-intf.scrbl +++ b/collects/scribblings/gui/subwindow-intf.scrbl @@ -1,9 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["window-intf.scrbl"] -@require["subarea-intf.scrbl"] -@define-interface-doc[subwindow<%> (subarea<%> window<%>)]{ +@definterface/title[subwindow<%> (subarea<%> window<%>)]{ A @scheme[subwindow<%>] is a containee window. diff --git a/collects/scribblings/gui/tab-panel-class.scrbl b/collects/scribblings/gui/tab-panel-class.scrbl index c276c0ff..39f4813a 100644 --- a/collects/scribblings/gui/tab-panel-class.scrbl +++ b/collects/scribblings/gui/tab-panel-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["vertical-panel-class.scrbl"] -@define-class-doc[tab-panel% vertical-panel% ()]{ +@defclass/title[tab-panel% vertical-panel% ()]{ A tab panel arranges its subwindows in a single column, but also includes a horizontal row of tabs at the top of the panel. See diff --git a/collects/scribblings/gui/tab-snip-class.scrbl b/collects/scribblings/gui/tab-snip-class.scrbl index b8d4a557..44676ed6 100644 --- a/collects/scribblings/gui/tab-snip-class.scrbl +++ b/collects/scribblings/gui/tab-snip-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["string-snip-class.scrbl"] -@define-class-doc[tab-snip% string-snip% ()]{ +@defclass/title[tab-snip% string-snip% ()]{ An instance of @scheme[tab-snip%] is created automatically when a tab is inserted into an editor. diff --git a/collects/scribblings/gui/text-class.scrbl b/collects/scribblings/gui/text-class.scrbl index 8a35036c..64709074 100644 --- a/collects/scribblings/gui/text-class.scrbl +++ b/collects/scribblings/gui/text-class.scrbl @@ -1,9 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["editor-intf.scrbl"] - -@define-class-doc[text% object% (editor<%>)]{ +@defclass/title[text% object% (editor<%>)]{ A @scheme[text%] object is a standard text editor. A text editor is displayed on the screen through an @scheme[editor-canvas%] object or diff --git a/collects/scribblings/gui/text-field-class.scrbl b/collects/scribblings/gui/text-field-class.scrbl index df079b62..628947c5 100644 --- a/collects/scribblings/gui/text-field-class.scrbl +++ b/collects/scribblings/gui/text-field-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["control-intf.scrbl"] -@define-class-doc[text-field% object% (control<%>)]{ +@defclass/title[text-field% object% (control<%>)]{ A @scheme[text-field%] object is an editable text field with an optional label displayed in front of it. There are two text field diff --git a/collects/scribblings/gui/timer-class.scrbl b/collects/scribblings/gui/timer-class.scrbl index 02dc425c..355f8cd2 100644 --- a/collects/scribblings/gui/timer-class.scrbl +++ b/collects/scribblings/gui/timer-class.scrbl @@ -1,7 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@define-class-doc[timer% object% ()]{ +@defclass/title[timer% object% ()]{ A @scheme[timer%] object encapsulates an event-based alarm. To use a timer, either instantiate it with a @scheme[timer-callback] thunk to diff --git a/collects/scribblings/gui/top-level-window-intf.scrbl b/collects/scribblings/gui/top-level-window-intf.scrbl index 7f79176d..48ae1702 100644 --- a/collects/scribblings/gui/top-level-window-intf.scrbl +++ b/collects/scribblings/gui/top-level-window-intf.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["area-container-window-intf.scrbl"] -@define-interface-doc[top-level-window<%> (area-container-window<%>)]{ +@definterface/title[top-level-window<%> (area-container-window<%>)]{ A top-level window is either a @scheme[frame%] or @scheme[dialog%] object. diff --git a/collects/scribblings/gui/vertical-pane-class.scrbl b/collects/scribblings/gui/vertical-pane-class.scrbl index c0023b1c..3ca068ca 100644 --- a/collects/scribblings/gui/vertical-pane-class.scrbl +++ b/collects/scribblings/gui/vertical-pane-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["pane-class.scrbl"] -@define-class-doc[vertical-pane% pane% ()]{ +@defclass/title[vertical-pane% pane% ()]{ A vertical pane arranges its subwindows in a single column. See also @scheme[pane%]. diff --git a/collects/scribblings/gui/vertical-panel-class.scrbl b/collects/scribblings/gui/vertical-panel-class.scrbl index 9002878c..eb33af08 100644 --- a/collects/scribblings/gui/vertical-panel-class.scrbl +++ b/collects/scribblings/gui/vertical-panel-class.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["panel-class.scrbl"] -@define-class-doc[vertical-panel% panel% ()]{ +@defclass/title[vertical-panel% panel% ()]{ A vertical panel arranges its subwindows in a single column. See also @scheme[panel%]. diff --git a/collects/scribblings/gui/win-classes.scrbl b/collects/scribblings/gui/win-classes.scrbl index 33317bae..ea8e1ff5 100644 --- a/collects/scribblings/gui/win-classes.scrbl +++ b/collects/scribblings/gui/win-classes.scrbl @@ -1,7 +1,6 @@ #reader(lib "docreader.ss" "scribble") @require["common.ss"] @require["diagrams.ss"] -@require["mred-classes.ss"] @title[#:style '(toc quiet)]{Windowing Classes} @@ -21,54 +20,54 @@ Alphabetical: @local-table-of-contents[] -@include-class-section[area<%>] -@include-class-section[area-container<%>] -@include-class-section[area-container-window<%>] -@include-class-section[button%] -@include-class-section[canvas<%>] -@include-class-section[canvas%] -@include-class-section[check-box%] -@include-class-section[checkable-menu-item%] -@include-class-section[choice%] -@include-class-section[clipboard<%>] -@include-class-section[clipboard-client%] -@include-class-section[combo-field%] -@include-class-section[control<%>] -@include-class-section[control-event%] -@include-class-section[cursor%] -@include-class-section[dialog%] -@include-class-section[event%] -@include-class-section[frame%] -@include-class-section[gauge%] -@include-class-section[group-box-panel%] -@include-class-section[grow-box-spacer-pane%] -@include-class-section[horizontal-pane%] -@include-class-section[horizontal-panel%] -@include-class-section[key-event%] -@include-class-section[labelled-menu-item<%>] -@include-class-section[list-box%] -@include-class-section[list-control<%>] -@include-class-section[menu%] -@include-class-section[menu-bar%] -@include-class-section[menu-item<%>] -@include-class-section[menu-item%] -@include-class-section[menu-item-container<%>] -@include-class-section[message%] -@include-class-section[mouse-event%] -@include-class-section[pane%] -@include-class-section[panel%] -@include-class-section[popup-menu%] -@include-class-section[radio-box%] -@include-class-section[scroll-event%] -@include-class-section[selectable-menu-item<%>] -@include-class-section[separator-menu-item%] -@include-class-section[slider%] -@include-class-section[subarea<%>] -@include-class-section[subwindow<%>] -@include-class-section[tab-panel%] -@include-class-section[text-field%] -@include-class-section[timer%] -@include-class-section[top-level-window<%>] -@include-class-section[vertical-pane%] -@include-class-section[vertical-panel%] -@include-class-section[window<%>] +@include-section["area-intf.scrbl"] +@include-section["area-container-intf.scrbl"] +@include-section["area-container-window-intf.scrbl"] +@include-section["button-class.scrbl"] +@include-section["canvas-intf.scrbl"] +@include-section["canvas-class.scrbl"] +@include-section["check-box-class.scrbl"] +@include-section["checkable-menu-item-class.scrbl"] +@include-section["choice-class.scrbl"] +@include-section["clipboard-client-class.scrbl"] +@include-section["clipboard-intf.scrbl"] +@include-section["combo-field-class.scrbl"] +@include-section["control-intf.scrbl"] +@include-section["control-event-class.scrbl"] +@include-section["cursor-class.scrbl"] +@include-section["dialog-class.scrbl"] +@include-section["event-class.scrbl"] +@include-section["frame-class.scrbl"] +@include-section["gauge-class.scrbl"] +@include-section["group-box-panel-class.scrbl"] +@include-section["grow-box-spacer-pane-class.scrbl"] +@include-section["horizontal-pane-class.scrbl"] +@include-section["horizontal-panel-class.scrbl"] +@include-section["key-event-class.scrbl"] +@include-section["labelled-menu-item-intf.scrbl"] +@include-section["list-box-class.scrbl"] +@include-section["list-control-intf.scrbl"] +@include-section["menu-class.scrbl"] +@include-section["menu-bar-class.scrbl"] +@include-section["menu-item-intf.scrbl"] +@include-section["menu-item-class.scrbl"] +@include-section["menu-item-container-intf.scrbl"] +@include-section["message-class.scrbl"] +@include-section["mouse-event-class.scrbl"] +@include-section["pane-class.scrbl"] +@include-section["panel-class.scrbl"] +@include-section["popup-menu-class.scrbl"] +@include-section["radio-box-class.scrbl"] +@include-section["selectable-menu-item-intf.scrbl"] +@include-section["separator-menu-item-class.scrbl"] +@include-section["scroll-event-class.scrbl"] +@include-section["slider-class.scrbl"] +@include-section["subarea-intf.scrbl"] +@include-section["subwindow-intf.scrbl"] +@include-section["tab-panel-class.scrbl"] +@include-section["text-field-class.scrbl"] +@include-section["timer-class.scrbl"] +@include-section["top-level-window-intf.scrbl"] +@include-section["vertical-pane-class.scrbl"] +@include-section["vertical-panel-class.scrbl"] +@include-section["window-intf.scrbl"] diff --git a/collects/scribblings/gui/window-intf.scrbl b/collects/scribblings/gui/window-intf.scrbl index d8e7d111..0e5acb52 100644 --- a/collects/scribblings/gui/window-intf.scrbl +++ b/collects/scribblings/gui/window-intf.scrbl @@ -1,8 +1,7 @@ -#reader(lib "defreader.ss" "scribble") +#reader(lib "docreader.ss" "scribble") @require["common.ss"] -@require["area-intf.scrbl"] -@define-interface-doc[window<%> (area<%>)]{ +@definterface/title[window<%> (area<%>)]{ A @scheme[window<%>] object is an @scheme[area<%>] with a graphical representation that can respond to events.