diff --git a/collects/scribble/latex-render.ss b/collects/scribble/latex-render.ss index 57dcc9bc2b..db64784aba 100644 --- a/collects/scribble/latex-render.ss +++ b/collects/scribble/latex-render.ss @@ -159,7 +159,7 @@ [(italic) (wrap e "textit" #f)] [(bold) (wrap e "textbf" #f)] [(tt) (wrap e "mytexttt" #t)] - [(nobreak) (super render-element e part ri)] + [(no-break) (super render-element e part ri)] [(sf) (wrap e "textsf" #f)] [(subscript) (wrap e "textsub" #f)] [(superscript) (wrap e "textsuper" #f)] diff --git a/collects/scribble/manual.ss b/collects/scribble/manual.ss index 29e177086f..35140712e3 100644 --- a/collects/scribble/manual.ss +++ b/collects/scribble/manual.ss @@ -1322,7 +1322,9 @@ ;; ---------------------------------------- (provide defclass + define-class-doc definterface + define-interface-doc defconstructor defconstructor/make defconstructor*/make @@ -1332,6 +1334,7 @@ methspec methimpl this-obj + include-class-section include-class) (define-syntax-parameter current-class #f) @@ -1426,7 +1429,7 @@ ht)) ht))) - (define (*include-class decl) + (define (*include-class-section decl) (make-splice (cons (section #:style 'hidden (to-element (decl-name decl))) (map (lambda (i) @@ -1439,11 +1442,32 @@ ((decl-mk-head decl) #t) (decl-body decl)))))) + (define (*include-class decl) + (make-splice + (append + ((decl-mk-head decl) #f) + (list + (make-blockquote + "leftindent" + (flow-paragraphs + (decode-flow + (map (lambda (i) + (cond + [(constructor? i) ((constructor-def i))] + [(meth? i) + ((meth-def i) (meth-desc i))] + [else i])) + (decl-body decl))))))))) + + (define-syntax include-class-section + (syntax-rules () + [(_ id) (*include-class-section (class-doc-info id))])) + (define-syntax include-class (syntax-rules () [(_ id) (*include-class (class-doc-info id))])) - (define (*defclass stx-id super intfs whole-page?) + (define (*define-class-doc stx-id super intfs whole-page?) (let ([spacer (hspace 1)]) (make-table 'boxed @@ -1497,7 +1521,7 @@ (make-flow (list (make-paragraph (list (to-element i))))))) (cdr intfs))))))))))))) - (define-syntax defclass + (define-syntax define-class-doc (syntax-rules () [(_ name super (intf ...) body ...) (define-class-doc-info name @@ -1507,13 +1531,20 @@ (list (class-doc-info intf) ...) (lambda (whole-page?) (list - (*defclass (quote-syntax/loc name) - (quote-syntax super) - (list (quote-syntax intf) ...) - whole-page?))) + (*define-class-doc (quote-syntax/loc name) + (quote-syntax super) + (list (quote-syntax intf) ...) + whole-page?))) (list body ...))))])) - (define-syntax definterface + (define-syntax defclass + (syntax-rules () + [(_ name . rest) + (begin + (define-class-doc name . rest) + (include-class name))])) + + (define-syntax define-interface-doc (syntax-rules () [(_ name (intf ...) body ...) (define-class-doc-info name @@ -1523,12 +1554,19 @@ (list (class-doc-info intf) ...) (lambda (whole-page?) (list - (*defclass (quote-syntax/loc name) - #f - (list (quote-syntax intf) ...) - whole-page?))) + (*define-class-doc (quote-syntax/loc name) + #f + (list (quote-syntax intf) ...) + whole-page?))) (list body ...))))])) + (define-syntax definterface + (syntax-rules () + [(_ name . rest) + (begin + (define-interface-doc name . rest) + (include-class name))])) + (define-syntax (defconstructor*/* stx) (syntax-case stx () [(_ mode ((arg ...) ...) desc ...) diff --git a/collects/scribblings/gui/add-color-intf.scrbl b/collects/scribblings/gui/add-color-intf.scrbl index 8640c47f17..1c545c11df 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") @require["common.ss"] -@definterface[add-color<%> ()]{ +@define-interface-doc[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 b4ffa86d25..a1b3681101 100644 --- a/collects/scribblings/gui/area-container-intf.scrbl +++ b/collects/scribblings/gui/area-container-intf.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["area-intf.scrbl"] -@definterface[area-container<%> (area<%>)]{ +@define-interface-doc[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 9b38ea3e89..109ec0c0e8 100644 --- a/collects/scribblings/gui/area-container-window-intf.scrbl +++ b/collects/scribblings/gui/area-container-window-intf.scrbl @@ -3,7 +3,7 @@ @require["area-container-intf.scrbl"] @require["window-intf.scrbl"] -@definterface[area-container-window<%> (area-container<%> window<%>)]{ +@define-interface-doc[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 f5411add06..2153356331 100644 --- a/collects/scribblings/gui/area-intf.scrbl +++ b/collects/scribblings/gui/area-intf.scrbl @@ -1,7 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] -@definterface[area<%> ()]{ +@define-interface-doc[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/bitmap-class.scrbl b/collects/scribblings/gui/bitmap-class.scrbl index 6a4a347089..308447c1e4 100644 --- a/collects/scribblings/gui/bitmap-class.scrbl +++ b/collects/scribblings/gui/bitmap-class.scrbl @@ -1,7 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] -@defclass[bitmap% object% ()]{ +@define-class-doc[bitmap% object% ()]{ A @scheme[bitmap%] object is a pixel-based image, either monochrome or color. diff --git a/collects/scribblings/gui/bitmap-dc-class.scrbl b/collects/scribblings/gui/bitmap-dc-class.scrbl index 4ff59f5f1d..5763a9a5ba 100644 --- a/collects/scribblings/gui/bitmap-dc-class.scrbl +++ b/collects/scribblings/gui/bitmap-dc-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["dc-intf.scrbl"] -@defclass[bitmap-dc% object% (dc<%>)]{ +@define-class-doc[bitmap-dc% object% (dc<%>)]{ A @scheme[bitmap-dc%] object allows drawing directly into a bitmap. A @scheme[bitmap%] object must be supplied at initialization or diff --git a/collects/scribblings/gui/brush-class.scrbl b/collects/scribblings/gui/brush-class.scrbl index 2741c22878..245de8e8a4 100644 --- a/collects/scribblings/gui/brush-class.scrbl +++ b/collects/scribblings/gui/brush-class.scrbl @@ -1,7 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] -@defclass[brush% object% ()]{ +@define-class-doc[brush% object% ()]{ A brush is a drawing tool with a color and a style that is used for filling in areas, such as the interior of a rectangle or ellipse. On diff --git a/collects/scribblings/gui/brush-list-class.scrbl b/collects/scribblings/gui/brush-list-class.scrbl index e4d4159dc0..c78320e534 100644 --- a/collects/scribblings/gui/brush-list-class.scrbl +++ b/collects/scribblings/gui/brush-list-class.scrbl @@ -1,7 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] -@defclass[brush-list% object% ()]{ +@define-class-doc[brush-list% object% ()]{ A @scheme[brush-list%] object maintains a list of @scheme[brush%] objects to avoid creating brushes repeatedly. A @scheme[brush%] diff --git a/collects/scribblings/gui/button-class.scrbl b/collects/scribblings/gui/button-class.scrbl index f8216dc3e7..6de59b978c 100644 --- a/collects/scribblings/gui/button-class.scrbl +++ b/collects/scribblings/gui/button-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["control-intf.scrbl"] -@defclass[button% object% (control<%>)]{ +@define-class-doc[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 83dd790198..42a84b3670 100644 --- a/collects/scribblings/gui/canvas-class.scrbl +++ b/collects/scribblings/gui/canvas-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["canvas-intf.scrbl"] -@defclass[canvas% object% (canvas<%>)]{ +@define-class-doc[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 4bb5444d0e..e10ec45819 100644 --- a/collects/scribblings/gui/canvas-intf.scrbl +++ b/collects/scribblings/gui/canvas-intf.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["subwindow-intf.scrbl"] -@definterface[canvas<%> (subwindow<%>)]{ +@define-interface-doc[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 f57c5fdd89..0133359609 100644 --- a/collects/scribblings/gui/check-box-class.scrbl +++ b/collects/scribblings/gui/check-box-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["control-intf.scrbl"] -@defclass[check-box% object% (control<%>)]{ +@define-class-doc[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 bc14bff66c..28306b56a5 100644 --- a/collects/scribblings/gui/checkable-menu-item-class.scrbl +++ b/collects/scribblings/gui/checkable-menu-item-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["selectable-menu-item-intf.scrbl"] -@defclass[checkable-menu-item% object% (selectable-menu-item<%>)]{ +@define-class-doc[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 d6b3904fa3..b1fe6e3b79 100644 --- a/collects/scribblings/gui/choice-class.scrbl +++ b/collects/scribblings/gui/choice-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["list-control-intf.scrbl"] -@defclass[choice% object% (list-control<%>)]{ +@define-class-doc[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 23a3f3e985..ddf79abfd8 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") @require["common.ss"] -@defclass[clipboard-client% object% ()]{ +@define-class-doc[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 b53454be4d..747f361873 100644 --- a/collects/scribblings/gui/clipboard-intf.scrbl +++ b/collects/scribblings/gui/clipboard-intf.scrbl @@ -1,7 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] -@definterface[clipboard<%> ()]{ +@define-interface-doc[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/color-class.scrbl b/collects/scribblings/gui/color-class.scrbl index abfd9b4b0e..a3a87f1189 100644 --- a/collects/scribblings/gui/color-class.scrbl +++ b/collects/scribblings/gui/color-class.scrbl @@ -1,7 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] -@defclass[color% object% ()]{ +@define-class-doc[color% object% ()]{ A color is an object representing a red-green-blue (RGB) combination of primary colors, and is used to determine drawing colors. Each red, diff --git a/collects/scribblings/gui/color-database-intf.scrbl b/collects/scribblings/gui/color-database-intf.scrbl index 287ec732e4..ef6be82ef2 100644 --- a/collects/scribblings/gui/color-database-intf.scrbl +++ b/collects/scribblings/gui/color-database-intf.scrbl @@ -1,7 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] -@definterface[color-database<%> ()]{ +@define-interface-doc[color-database<%> ()]{ The global @indexed-scheme[the-color-database] object is an instance of @scheme[color-database<%>]. It maintains a database of standard RGB diff --git a/collects/scribblings/gui/combo-field-class.scrbl b/collects/scribblings/gui/combo-field-class.scrbl index c978045d01..6803d827ab 100644 --- a/collects/scribblings/gui/combo-field-class.scrbl +++ b/collects/scribblings/gui/combo-field-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["text-field-class.scrbl"] -@defclass[combo-field% text-field% ()]{ +@define-class-doc[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 cc16964ad1..af8c08e805 100644 --- a/collects/scribblings/gui/control-event-class.scrbl +++ b/collects/scribblings/gui/control-event-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["event-class.scrbl"] -@defclass[control-event% event% ()]{ +@define-class-doc[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 cd6e25926d..c29657d0c0 100644 --- a/collects/scribblings/gui/control-intf.scrbl +++ b/collects/scribblings/gui/control-intf.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["subwindow-intf.scrbl"] -@definterface[control<%> (subwindow<%>)]{ +@define-interface-doc[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 7d28041bba..22963b6692 100644 --- a/collects/scribblings/gui/cursor-class.scrbl +++ b/collects/scribblings/gui/cursor-class.scrbl @@ -1,7 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] -@defclass[cursor% object% ()]{ +@define-class-doc[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/dc-intf.scrbl b/collects/scribblings/gui/dc-intf.scrbl index 7e313303fe..23e7c26fab 100644 --- a/collects/scribblings/gui/dc-intf.scrbl +++ b/collects/scribblings/gui/dc-intf.scrbl @@ -1,7 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] -@definterface[dc<%> ()]{ +@define-interface-doc[dc<%> ()]{ A @scheme[dc<%>] object is a drawing context for drawing graphics and text. It represents output devices in a generic way; e.g., a canvas diff --git a/collects/scribblings/gui/dc-path-class.scrbl b/collects/scribblings/gui/dc-path-class.scrbl index 0d63b745d9..2ea4f58799 100644 --- a/collects/scribblings/gui/dc-path-class.scrbl +++ b/collects/scribblings/gui/dc-path-class.scrbl @@ -1,7 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] -@defclass[dc-path% object% ()]{ +@define-class-doc[dc-path% object% ()]{ A path is a set of figures defined by curves. A path can be used with the @method[dc<%> draw-path] method of a @scheme[dc<%>] object to draw diff --git a/collects/scribblings/gui/dialog-class.scrbl b/collects/scribblings/gui/dialog-class.scrbl index a79963f61e..4d7e4b6aac 100644 --- a/collects/scribblings/gui/dialog-class.scrbl +++ b/collects/scribblings/gui/dialog-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["top-level-window-intf.scrbl"] -@defclass[dialog% object% (top-level-window<%>)]{ +@define-class-doc[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/draw-classes.scrbl b/collects/scribblings/gui/draw-classes.scrbl index 30bb028dfd..6f1b7ef635 100644 --- a/collects/scribblings/gui/draw-classes.scrbl +++ b/collects/scribblings/gui/draw-classes.scrbl @@ -7,23 +7,23 @@ @local-table-of-contents[] -@include-class[bitmap%] -@include-class[bitmap-dc%] -@include-class[brush%] -@include-class[brush-list%] -@include-class[color%] -@include-class[color-database<%>] -@include-class[dc<%>] -@include-class[dc-path%] -@include-class[font%] -@include-class[font-list%] -@include-class[font-name-directory<%>] -@include-class[gl-config%] -@include-class[gl-context<%>] -@include-class[pen%] -@include-class[pen-list%] -@include-class[point%] -@include-class[post-script-dc%] -@include-class[printer-dc%] -@include-class[ps-setup%] -@include-class[region%] +@include-class-section[bitmap%] +@include-class-section[bitmap-dc%] +@include-class-section[brush%] +@include-class-section[brush-list%] +@include-class-section[color%] +@include-class-section[color-database<%>] +@include-class-section[dc<%>] +@include-class-section[dc-path%] +@include-class-section[font%] +@include-class-section[font-list%] +@include-class-section[font-name-directory<%>] +@include-class-section[gl-config%] +@include-class-section[gl-context<%>] +@include-class-section[pen%] +@include-class-section[pen-list%] +@include-class-section[point%] +@include-class-section[post-script-dc%] +@include-class-section[printer-dc%] +@include-class-section[ps-setup%] +@include-class-section[region%] diff --git a/collects/scribblings/gui/editor-admin-class.scrbl b/collects/scribblings/gui/editor-admin-class.scrbl index 9b634507a1..93028ffe60 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") @require["common.ss"] -@defclass[editor-admin% object% ()]{ +@define-class-doc[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 87392f0ee2..f73d3c10d3 100644 --- a/collects/scribblings/gui/editor-canvas-class.scrbl +++ b/collects/scribblings/gui/editor-canvas-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["canvas-intf.scrbl"] -@defclass[editor-canvas% object% (canvas<%>)]{ +@define-class-doc[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 248e714b61..f2f4dac81e 100644 --- a/collects/scribblings/gui/editor-classes.scrbl +++ b/collects/scribblings/gui/editor-classes.scrbl @@ -29,34 +29,34 @@ Alphabetical: @local-table-of-contents[] -@include-class[add-color<%>] -@include-class[editor<%>] -@include-class[editor-admin%] -@include-class[editor-canvas%] -@include-class[editor-data%] -@include-class[editor-data-class%] -@include-class[editor-data-class-list<%>] -@include-class[editor-snip-editor-admin<%>] -@include-class[editor-snip%] -@include-class[editor-stream-in%] -@include-class[editor-stream-in-base%] -@include-class[editor-stream-in-bytes-base%] -@include-class[editor-stream-out%] -@include-class[editor-stream-out-base%] -@include-class[editor-stream-out-bytes-base%] -@include-class[editor-wordbreak-map%] -@include-class[image-snip%] -@include-class[keymap%] -@include-class[mult-color<%>] -@include-class[pasteboard%] -@include-class[readable-snip<%>] -@include-class[snip%] -@include-class[snip-admin%] -@include-class[snip-class%] -@include-class[snip-class-list<%>] -@include-class[string-snip%] -@include-class[style<%>] -@include-class[style-delta%] -@include-class[style-list%] -@include-class[tab-snip%] -@include-class[text%] +@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%] diff --git a/collects/scribblings/gui/editor-data-class-class.scrbl b/collects/scribblings/gui/editor-data-class-class.scrbl index aa92ae8511..4b60b8459c 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") @require["common.ss"] -@defclass[editor-data-class% object% ()]{ +@define-class-doc[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 5537dc15c5..2f287ee6b3 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") @require["common.ss"] -@definterface[editor-data-class-list<%> ()]{ +@define-interface-doc[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 8d72adc14a..7f58477bc3 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") @require["common.ss"] -@defclass[editor-data% object% ()]{ +@define-class-doc[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 4bca91bad3..ba199e41d6 100644 --- a/collects/scribblings/gui/editor-intf.scrbl +++ b/collects/scribblings/gui/editor-intf.scrbl @@ -1,7 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] -@definterface[editor<%> ()]{ +@define-interface-doc[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 09560f3763..8aea28de7f 100644 --- a/collects/scribblings/gui/editor-snip-class.scrbl +++ b/collects/scribblings/gui/editor-snip-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["snip-class.scrbl"] -@defclass[editor-snip% snip% ()]{ +@define-class-doc[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 d1ce183a64..44733239df 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") @require["common.ss"] -@definterface[editor-snip-editor-admin<%> ()]{ +@define-interface-doc[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 ada6b585bb..6784ac81fa 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") @require["common.ss"] -@defclass[editor-stream-in-base% object% ()]{ +@define-class-doc[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 dfad9c8217..d4d74d4223 100644 --- a/collects/scribblings/gui/editor-stream-in-bytes-base-class.scrbl +++ b/collects/scribblings/gui/editor-stream-in-bytes-base-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["editor-stream-in-base-class.scrbl"] -@defclass[editor-stream-in-bytes-base% editor-stream-in-base% ()]{ +@define-class-doc[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 88ab0b8f9c..de5e40fc4b 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") @require["common.ss"] -@defclass[editor-stream-in% object% ()]{ +@define-class-doc[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 3b30940708..98f64a031f 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") @require["common.ss"] -@defclass[editor-stream-out-base% object% ()]{ +@define-class-doc[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 cbf881022c..17baf9f6f1 100644 --- a/collects/scribblings/gui/editor-stream-out-bytes-base-class.scrbl +++ b/collects/scribblings/gui/editor-stream-out-bytes-base-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["editor-stream-out-base-class.scrbl"] -@defclass[editor-stream-out-bytes-base% editor-stream-out-base% ()]{ +@define-class-doc[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 eed960e08c..c004c844d6 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") @require["common.ss"] -@defclass[editor-stream-out% object% ()]{ +@define-class-doc[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 4615e1d7b2..1b63f70d65 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") @require["common.ss"] -@defclass[editor-wordbreak-map% object% ()]{ +@define-class-doc[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 54af902870..1a668c6103 100644 --- a/collects/scribblings/gui/event-class.scrbl +++ b/collects/scribblings/gui/event-class.scrbl @@ -1,7 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] -@defclass[event% object% ()]{ +@define-class-doc[event% object% ()]{ An @scheme[event%] object contains information about a control, keyboard, mouse, or scroll event. See also diff --git a/collects/scribblings/gui/font-class.scrbl b/collects/scribblings/gui/font-class.scrbl index b2d0a57888..55a93349ac 100644 --- a/collects/scribblings/gui/font-class.scrbl +++ b/collects/scribblings/gui/font-class.scrbl @@ -1,7 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] -@defclass[font% object% ()]{ +@define-class-doc[font% object% ()]{ A @defterm{font} is an object which determines the appearance of text, primarily when drawing text to a device context. A font is determined diff --git a/collects/scribblings/gui/font-list-class.scrbl b/collects/scribblings/gui/font-list-class.scrbl index 0b362bfc34..b304259743 100644 --- a/collects/scribblings/gui/font-list-class.scrbl +++ b/collects/scribblings/gui/font-list-class.scrbl @@ -1,7 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] -@defclass[font-list% object% ()]{ +@define-class-doc[font-list% object% ()]{ A @scheme[font-list%] object maintains a list of @scheme[font%] objects to avoid repeatedly creating fonts. diff --git a/collects/scribblings/gui/font-name-directory-intf.scrbl b/collects/scribblings/gui/font-name-directory-intf.scrbl index c64b46d704..069525de21 100644 --- a/collects/scribblings/gui/font-name-directory-intf.scrbl +++ b/collects/scribblings/gui/font-name-directory-intf.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require[(lib "bnf.ss" "scribble")] -@definterface[font-name-directory<%> ()]{ +@define-interface-doc[font-name-directory<%> ()]{ There is one @scheme[font-name-directory<%>] object: @scheme[the-font-name-directory]. It implements the mapping from font diff --git a/collects/scribblings/gui/frame-class.scrbl b/collects/scribblings/gui/frame-class.scrbl index 6ff7338c83..cf846e4f5a 100644 --- a/collects/scribblings/gui/frame-class.scrbl +++ b/collects/scribblings/gui/frame-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["top-level-window-intf.scrbl"] -@defclass[frame% object% (top-level-window<%>)]{ +@define-class-doc[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 f4c0c7a05f..9d748dc57b 100644 --- a/collects/scribblings/gui/gauge-class.scrbl +++ b/collects/scribblings/gui/gauge-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["control-intf.scrbl"] -@defclass[gauge% object% (control<%>)]{ +@define-class-doc[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/gl-config-class.scrbl b/collects/scribblings/gui/gl-config-class.scrbl index a8525ca1c8..0667ab2815 100644 --- a/collects/scribblings/gui/gl-config-class.scrbl +++ b/collects/scribblings/gui/gl-config-class.scrbl @@ -1,7 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] -@defclass[gl-config% object% ()]{ +@define-class-doc[gl-config% object% ()]{ A @scheme[gl-config%] object encapsulates configuration information for an OpenGL drawing context. Use a @scheme[gl-config%] object as an diff --git a/collects/scribblings/gui/gl-context-intf.scrbl b/collects/scribblings/gui/gl-context-intf.scrbl index 76f7b79a8a..59986a9279 100644 --- a/collects/scribblings/gui/gl-context-intf.scrbl +++ b/collects/scribblings/gui/gl-context-intf.scrbl @@ -1,7 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] -@definterface[gl-context<%> ()]{ +@define-interface-doc[gl-context<%> ()]{ A @scheme[gl-context<%>] object represents a context for drawing with @as-index{OpenGL} to a specific @scheme[dc<%>] instance. To obtain a diff --git a/collects/scribblings/gui/group-box-panel-class.scrbl b/collects/scribblings/gui/group-box-panel-class.scrbl index d178576f29..c9c957f41a 100644 --- a/collects/scribblings/gui/group-box-panel-class.scrbl +++ b/collects/scribblings/gui/group-box-panel-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["vertical-panel-class.scrbl"] -@defclass[group-box-panel% vertical-panel% ()]{ +@define-class-doc[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 b9d5a06afe..7ae9bc7fac 100644 --- a/collects/scribblings/gui/grow-box-spacer-pane-class.scrbl +++ b/collects/scribblings/gui/grow-box-spacer-pane-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["pane-class.scrbl"] -@defclass[grow-box-spacer-pane% pane% ()]{ +@define-class-doc[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 f779d8d91e..6046a50316 100644 --- a/collects/scribblings/gui/horizontal-pane-class.scrbl +++ b/collects/scribblings/gui/horizontal-pane-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["pane-class.scrbl"] -@defclass[horizontal-pane% pane% ()]{ +@define-class-doc[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 0950215301..06a72a3cbc 100644 --- a/collects/scribblings/gui/horizontal-panel-class.scrbl +++ b/collects/scribblings/gui/horizontal-panel-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["panel-class.scrbl"] -@defclass[horizontal-panel% panel% ()]{ +@define-class-doc[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 7f9c25c4c0..fe22bbdff1 100644 --- a/collects/scribblings/gui/image-snip-class.scrbl +++ b/collects/scribblings/gui/image-snip-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["snip-class.scrbl"] -@defclass[image-snip% snip% ()]{ +@define-class-doc[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 0e33c12ac4..6cc8caec44 100644 --- a/collects/scribblings/gui/key-event-class.scrbl +++ b/collects/scribblings/gui/key-event-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["event-class.scrbl"] -@defclass[key-event% event% ()]{ +@define-class-doc[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 4f0a385768..72d1ce79c9 100644 --- a/collects/scribblings/gui/keymap-class.scrbl +++ b/collects/scribblings/gui/keymap-class.scrbl @@ -1,7 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] -@defclass[keymap% object% ()]{ +@define-class-doc[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 25cee10569..c70cfbc855 100644 --- a/collects/scribblings/gui/labelled-menu-item-intf.scrbl +++ b/collects/scribblings/gui/labelled-menu-item-intf.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["menu-item-intf.scrbl"] -@definterface[labelled-menu-item<%> (menu-item<%>)]{ +@define-interface-doc[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 97adb5f719..fce813098a 100644 --- a/collects/scribblings/gui/list-box-class.scrbl +++ b/collects/scribblings/gui/list-box-class.scrbl @@ -5,7 +5,7 @@ @define[lbnumnote @elem{List box items are indexed from @scheme[0].}] -@defclass[list-box% object% (list-control<%>)]{ +@define-class-doc[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 335b080db0..44deed3c67 100644 --- a/collects/scribblings/gui/list-control-intf.scrbl +++ b/collects/scribblings/gui/list-control-intf.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["control-intf.scrbl"] -@definterface[list-control<%> (control<%>)]{ +@define-interface-doc[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 b43c05d884..2e4bc4fb0b 100644 --- a/collects/scribblings/gui/menu-bar-class.scrbl +++ b/collects/scribblings/gui/menu-bar-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["menu-item-container-intf.scrbl"] -@defclass[menu-bar% object% (menu-item-container<%>)]{ +@define-class-doc[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 139054782a..861e680a7d 100644 --- a/collects/scribblings/gui/menu-class.scrbl +++ b/collects/scribblings/gui/menu-class.scrbl @@ -3,7 +3,7 @@ @require["labelled-menu-item-intf.scrbl"] @require["menu-item-container-intf.scrbl"] -@defclass[menu% object% (menu-item-container<%> labelled-menu-item<%>)]{ +@define-class-doc[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 b5fad9bd87..1e70708578 100644 --- a/collects/scribblings/gui/menu-item-class.scrbl +++ b/collects/scribblings/gui/menu-item-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["selectable-menu-item-intf.scrbl"] -@defclass[menu-item% object% (selectable-menu-item<%>)]{ +@define-class-doc[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 3a663cec0f..b7812aca82 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") @require["common.ss"] -@definterface[menu-item-container<%> ()]{ +@define-interface-doc[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 ceb449dcc4..2d78011abf 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") @require["common.ss"] -@definterface[menu-item<%> ()]{ +@define-interface-doc[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 ec7aae8bfe..12e1dac4ad 100644 --- a/collects/scribblings/gui/message-class.scrbl +++ b/collects/scribblings/gui/message-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["control-intf.scrbl"] -@defclass[message% object% (control<%>)]{ +@define-class-doc[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 0836fd9154..3127a80b33 100644 --- a/collects/scribblings/gui/mouse-event-class.scrbl +++ b/collects/scribblings/gui/mouse-event-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["event-class.scrbl"] -@defclass[mouse-event% event% ()]{ +@define-class-doc[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 af74e017ec..d55c69a7cd 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") @require["common.ss"] -@definterface[mult-color<%> ()]{ +@define-interface-doc[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 339ff8ce6f..f7e76aa654 100644 --- a/collects/scribblings/gui/pane-class.scrbl +++ b/collects/scribblings/gui/pane-class.scrbl @@ -3,7 +3,7 @@ @require["area-container-intf.scrbl"] @require["subarea-intf.scrbl"] -@defclass[pane% object% (area-container<%> subarea<%>)]{ +@define-class-doc[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 34c9933beb..4c758bf531 100644 --- a/collects/scribblings/gui/panel-class.scrbl +++ b/collects/scribblings/gui/panel-class.scrbl @@ -3,7 +3,7 @@ @require["subwindow-intf.scrbl"] @require["area-container-window-intf.scrbl"] -@defclass[panel% object% (area-container-window<%> subwindow<%>)]{ +@define-class-doc[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 2e244ea23c..556834790b 100644 --- a/collects/scribblings/gui/pasteboard-class.scrbl +++ b/collects/scribblings/gui/pasteboard-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["editor-intf.scrbl"] -@defclass[pasteboard% object% (editor<%>)]{ +@define-class-doc[pasteboard% object% (editor<%>)]{ A @scheme[pasteboard%] object is an editor for displaying snips with arbitrary @techlink{location}s. diff --git a/collects/scribblings/gui/pen-class.scrbl b/collects/scribblings/gui/pen-class.scrbl index 3699e884c2..f7ad632082 100644 --- a/collects/scribblings/gui/pen-class.scrbl +++ b/collects/scribblings/gui/pen-class.scrbl @@ -1,7 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] -@defclass[pen% object% ()]{ +@define-class-doc[pen% object% ()]{ A pen is a drawing tool with a color, width, and style. A pen draws lines and outlines, such as the outline of a rectangle. On a diff --git a/collects/scribblings/gui/pen-list-class.scrbl b/collects/scribblings/gui/pen-list-class.scrbl index f7eb602f31..45c9cc96b6 100644 --- a/collects/scribblings/gui/pen-list-class.scrbl +++ b/collects/scribblings/gui/pen-list-class.scrbl @@ -1,7 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] -@defclass[pen-list% object% ()]{ +@define-class-doc[pen-list% object% ()]{ A @scheme[pen-list%] object maintains a list of @scheme[pen%] objects to avoid repeatedly creating pen objects. A @scheme[pen%] diff --git a/collects/scribblings/gui/point-class.scrbl b/collects/scribblings/gui/point-class.scrbl index 10565cdc03..c3ea832cbb 100644 --- a/collects/scribblings/gui/point-class.scrbl +++ b/collects/scribblings/gui/point-class.scrbl @@ -1,7 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] -@defclass[point% object% ()]{ +@define-class-doc[point% object% ()]{ A @scheme[point%] is used for certain drawing commands. It encapsulates two real numbers. diff --git a/collects/scribblings/gui/popup-menu-class.scrbl b/collects/scribblings/gui/popup-menu-class.scrbl index 18af8e54aa..3629136bc6 100644 --- a/collects/scribblings/gui/popup-menu-class.scrbl +++ b/collects/scribblings/gui/popup-menu-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["menu-item-container-intf.scrbl"] -@defclass[popup-menu% object% (menu-item-container<%>)]{ +@define-class-doc[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/post-script-dc-class.scrbl b/collects/scribblings/gui/post-script-dc-class.scrbl index 86ea016af1..b944e27db7 100644 --- a/collects/scribblings/gui/post-script-dc-class.scrbl +++ b/collects/scribblings/gui/post-script-dc-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["dc-intf.scrbl"] -@defclass[post-script-dc% object% (dc<%>)]{ +@define-class-doc[post-script-dc% object% (dc<%>)]{ A @scheme[post-script-dc%] object is a PostScript device context, that can write PostScript files on any platform. See also diff --git a/collects/scribblings/gui/printer-dc-class.scrbl b/collects/scribblings/gui/printer-dc-class.scrbl index b010e44a1b..20a7755c6f 100644 --- a/collects/scribblings/gui/printer-dc-class.scrbl +++ b/collects/scribblings/gui/printer-dc-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["dc-intf.scrbl"] -@defclass[printer-dc% object% (dc<%>)]{ +@define-class-doc[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/ps-setup-class.scrbl b/collects/scribblings/gui/ps-setup-class.scrbl index eaf4462122..fc8dd9c3a3 100644 --- a/collects/scribblings/gui/ps-setup-class.scrbl +++ b/collects/scribblings/gui/ps-setup-class.scrbl @@ -1,7 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] -@defclass[ps-setup% object% ()]{ +@define-class-doc[ps-setup% object% ()]{ A @scheme[ps-setup%] object contains configuration information for producing PostScript files using a @scheme[post-script-dc%] object. diff --git a/collects/scribblings/gui/radio-box-class.scrbl b/collects/scribblings/gui/radio-box-class.scrbl index 8775873f9e..2bd2738fa0 100644 --- a/collects/scribblings/gui/radio-box-class.scrbl +++ b/collects/scribblings/gui/radio-box-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["control-intf.scrbl"] -@defclass[radio-box% object% (control<%>)]{ +@define-class-doc[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 4826edaba6..ded9a28e70 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") @require["common.ss"] -@definterface[readable-snip<%> ()]{ +@define-interface-doc[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/region-class.scrbl b/collects/scribblings/gui/region-class.scrbl index 380330b6d2..49833948f2 100644 --- a/collects/scribblings/gui/region-class.scrbl +++ b/collects/scribblings/gui/region-class.scrbl @@ -1,7 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] -@defclass[region% object% ()]{ +@define-class-doc[region% object% ()]{ A @scheme[region%] object specifies a portion of a drawing area (possibly discontinuous). It is normally used for clipping drawing diff --git a/collects/scribblings/gui/scroll-event-class.scrbl b/collects/scribblings/gui/scroll-event-class.scrbl index f95bd451ef..971635068c 100644 --- a/collects/scribblings/gui/scroll-event-class.scrbl +++ b/collects/scribblings/gui/scroll-event-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["event-class.scrbl"] -@defclass[scroll-event% event% ()]{ +@define-class-doc[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 56336b5abc..3891268423 100644 --- a/collects/scribblings/gui/selectable-menu-item-intf.scrbl +++ b/collects/scribblings/gui/selectable-menu-item-intf.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["labelled-menu-item-intf.scrbl"] -@definterface[selectable-menu-item<%> (labelled-menu-item<%>)]{ +@define-interface-doc[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 3f732ca8c0..a2b4cb8497 100644 --- a/collects/scribblings/gui/separator-menu-item-class.scrbl +++ b/collects/scribblings/gui/separator-menu-item-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["menu-item-intf.scrbl"] -@defclass[separator-menu-item% object% (menu-item<%>)]{ +@define-class-doc[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 3a935187a3..29f9815362 100644 --- a/collects/scribblings/gui/slider-class.scrbl +++ b/collects/scribblings/gui/slider-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["control-intf.scrbl"] -@defclass[slider% object% (control<%>)]{ +@define-class-doc[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 bd9e2b8aa3..0f109cf667 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") @require["common.ss"] -@defclass[snip-admin% object% ()]{ +@define-class-doc[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 cf5010e21d..25223ff147 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") @require["common.ss"] -@defclass[snip-class% object% ()]{ +@define-class-doc[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 92d9019361..c721991de3 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") @require["common.ss"] -@definterface[snip-class-list<%> ()]{ +@define-interface-doc[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 cd248399e4..f37529d39f 100644 --- a/collects/scribblings/gui/snip-class.scrbl +++ b/collects/scribblings/gui/snip-class.scrbl @@ -1,7 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] -@defclass[snip% object% ()]{ +@define-class-doc[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 7305bbfc20..7507480ab4 100644 --- a/collects/scribblings/gui/string-snip-class.scrbl +++ b/collects/scribblings/gui/string-snip-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["snip-class.scrbl"] -@defclass[string-snip% snip% ()]{ +@define-class-doc[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 9568cbeef0..95e10330f3 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") @require["common.ss"] -@defclass[style-delta% object% ()]{ +@define-class-doc[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 eb63aa0699..2cf305c645 100644 --- a/collects/scribblings/gui/style-intf.scrbl +++ b/collects/scribblings/gui/style-intf.scrbl @@ -1,7 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] -@definterface[style<%> ()]{ +@define-interface-doc[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 30a73d1118..287a1344f9 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") @require["common.ss"] -@defclass[style-list% object% ()]{ +@define-class-doc[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 458958246f..5d767623e5 100644 --- a/collects/scribblings/gui/subarea-intf.scrbl +++ b/collects/scribblings/gui/subarea-intf.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["area-intf.scrbl"] -@definterface[subarea<%> (area<%>)]{ +@define-interface-doc[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 e6508632dc..9957b0ea4d 100644 --- a/collects/scribblings/gui/subwindow-intf.scrbl +++ b/collects/scribblings/gui/subwindow-intf.scrbl @@ -3,7 +3,7 @@ @require["window-intf.scrbl"] @require["subarea-intf.scrbl"] -@definterface[subwindow<%> (subarea<%> window<%>)]{ +@define-interface-doc[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 50e83601fa..c276c0ff62 100644 --- a/collects/scribblings/gui/tab-panel-class.scrbl +++ b/collects/scribblings/gui/tab-panel-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["vertical-panel-class.scrbl"] -@defclass[tab-panel% vertical-panel% ()]{ +@define-class-doc[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 2033ea0085..b8d4a557ca 100644 --- a/collects/scribblings/gui/tab-snip-class.scrbl +++ b/collects/scribblings/gui/tab-snip-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["string-snip-class.scrbl"] -@defclass[tab-snip% string-snip% ()]{ +@define-class-doc[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 726560722c..8a35036cc1 100644 --- a/collects/scribblings/gui/text-class.scrbl +++ b/collects/scribblings/gui/text-class.scrbl @@ -3,7 +3,7 @@ @require["editor-intf.scrbl"] -@defclass[text% object% (editor<%>)]{ +@define-class-doc[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 cd40f1eb3e..df079b620b 100644 --- a/collects/scribblings/gui/text-field-class.scrbl +++ b/collects/scribblings/gui/text-field-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["control-intf.scrbl"] -@defclass[text-field% object% (control<%>)]{ +@define-class-doc[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 9109d0fa98..02dc425c0e 100644 --- a/collects/scribblings/gui/timer-class.scrbl +++ b/collects/scribblings/gui/timer-class.scrbl @@ -1,7 +1,7 @@ #reader(lib "defreader.ss" "scribble") @require["common.ss"] -@defclass[timer% object% ()]{ +@define-class-doc[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 63673cd6dc..7f79176de2 100644 --- a/collects/scribblings/gui/top-level-window-intf.scrbl +++ b/collects/scribblings/gui/top-level-window-intf.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["area-container-window-intf.scrbl"] -@definterface[top-level-window<%> (area-container-window<%>)]{ +@define-interface-doc[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 1f05ebb12b..c0023b1c47 100644 --- a/collects/scribblings/gui/vertical-pane-class.scrbl +++ b/collects/scribblings/gui/vertical-pane-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["pane-class.scrbl"] -@defclass[vertical-pane% pane% ()]{ +@define-class-doc[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 5cd7aad1c5..9002878c20 100644 --- a/collects/scribblings/gui/vertical-panel-class.scrbl +++ b/collects/scribblings/gui/vertical-panel-class.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["panel-class.scrbl"] -@defclass[vertical-panel% panel% ()]{ +@define-class-doc[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 585a5e4a88..33317baea3 100644 --- a/collects/scribblings/gui/win-classes.scrbl +++ b/collects/scribblings/gui/win-classes.scrbl @@ -21,54 +21,54 @@ Alphabetical: @local-table-of-contents[] -@include-class[area<%>] -@include-class[area-container<%>] -@include-class[area-container-window<%>] -@include-class[button%] -@include-class[canvas<%>] -@include-class[canvas%] -@include-class[check-box%] -@include-class[checkable-menu-item%] -@include-class[choice%] -@include-class[clipboard<%>] -@include-class[clipboard-client%] -@include-class[combo-field%] -@include-class[control<%>] -@include-class[control-event%] -@include-class[cursor%] -@include-class[dialog%] -@include-class[event%] -@include-class[frame%] -@include-class[gauge%] -@include-class[group-box-panel%] -@include-class[grow-box-spacer-pane%] -@include-class[horizontal-pane%] -@include-class[horizontal-panel%] -@include-class[key-event%] -@include-class[labelled-menu-item<%>] -@include-class[list-box%] -@include-class[list-control<%>] -@include-class[menu%] -@include-class[menu-bar%] -@include-class[menu-item<%>] -@include-class[menu-item%] -@include-class[menu-item-container<%>] -@include-class[message%] -@include-class[mouse-event%] -@include-class[pane%] -@include-class[panel%] -@include-class[popup-menu%] -@include-class[radio-box%] -@include-class[scroll-event%] -@include-class[selectable-menu-item<%>] -@include-class[separator-menu-item%] -@include-class[slider%] -@include-class[subarea<%>] -@include-class[subwindow<%>] -@include-class[tab-panel%] -@include-class[text-field%] -@include-class[timer%] -@include-class[top-level-window<%>] -@include-class[vertical-pane%] -@include-class[vertical-panel%] -@include-class[window<%>] +@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<%>] diff --git a/collects/scribblings/gui/window-intf.scrbl b/collects/scribblings/gui/window-intf.scrbl index 9e2a7317d1..d8e7d11171 100644 --- a/collects/scribblings/gui/window-intf.scrbl +++ b/collects/scribblings/gui/window-intf.scrbl @@ -2,7 +2,7 @@ @require["common.ss"] @require["area-intf.scrbl"] -@definterface[window<%> (area<%>)]{ +@define-interface-doc[window<%> (area<%>)]{ A @scheme[window<%>] object is an @scheme[area<%>] with a graphical representation that can respond to events. diff --git a/collects/scribblings/scribble/manual.scrbl b/collects/scribblings/scribble/manual.scrbl index d08a066bda..37e53114fb 100644 --- a/collects/scribblings/scribble/manual.scrbl +++ b/collects/scribblings/scribble/manual.scrbl @@ -353,7 +353,7 @@ definition.} @defform/subs[(schemegrammar maybe-literals id clause-datum ...+) ([maybe-literals code:blank (code:line #:literals (literal-id ...))])]{ - + Creates a table to define the grammar of @scheme[id]. Each identifier mentioned in a @scheme[clause-datum] is typeset as a non-terminal, except for the identifiers listed as @scheme[literal-id]s, which are @@ -365,6 +365,60 @@ typeset as with @scheme[scheme].} Like @scheme[schemegrammar], but for typesetting multiple productions at once, aligned around the @litchar{=} and @litchar{|}.} +@; ------------------------------------------------------------------------ +@section{Classes and Interfaces} + +@defform[(define-class-doc id super-id (intf-id ...) pre-flow ...)]{ + +Binds @schemeidfont{class-doc-info:}@scheme[id] to documentation for +the class @scheme[id]. If @scheme[super-id] is not @scheme[object%], +then @schemeidfont{class-doc-info:}@scheme[super-id] must be bound to +documentation for the superclass (so that links can be created to +inherited methods, etc.). Similarly, +@schemeidfont{class-doc-info:}@scheme[intf-id] must be bound to +documentation for interfaces implemented by the class. At the same +time, @scheme[id], @scheme[super-id], and the @scheme[int-id]s must +have for-label bindings that are used for hyperlinks in the usual way. + +The decoding of the @scheme[pre-flow] sequence should start with +general documentation about the class, followed by constructor +definition (see @scheme[defconstructor]), and then field and method +definitions (see @scheme[defmethod]). + +A @scheme[define-class-doc] form is a Scheme-level definition. It does +not produce documentation directly. Instead, @scheme[(include-class +id)] or @scheme[(include-class-section id)] should be used later to +produce the documentation.} + +@defform[(include-class id)]{ + +Generates inline documentation based on the information bound to +@schemeidfont{class-doc-info:}@scheme[id]. Constructor and method +specification are indented to visually group them under the class +definition.} + +@defform[(include-class-section id)]{ + +Generates documentation based on the information bound to +@schemeidfont{class-doc-info:}@scheme[id] as a new section. The +@scheme[id] is used as the section title, but the title is not +rendered in HTML output, as the definition box serves as a title. With +the expectation that the section will have its own page, constructor +and method specifications are not indented (unlike the result of +@scheme[include-class]).} + +@defform[(defclass id super-id (intf-id ...) pre-flow ...)]{ + +Combines @scheme[define-class-doc] and @scheme[include-class].} + +@defform[(defconstructor)]{ + +TBD.} + +@defform[(defmethod)]{ + +TBD.} + @; ------------------------------------------------------------------------ @section{Various String Forms} diff --git a/collects/scribblings/scribble/renderer.scrbl b/collects/scribblings/scribble/renderer.scrbl index c06088a9bb..2f49996c68 100644 --- a/collects/scribblings/scribble/renderer.scrbl +++ b/collects/scribblings/scribble/renderer.scrbl @@ -46,6 +46,7 @@ Creates a renderer whose output goes to @scheme[dest-dir]. [dests (listof path-string?)]) collect-info?]{ +Performs the @techlink{collect pass}. } @@ -54,6 +55,7 @@ Creates a renderer whose output goes to @scheme[dest-dir]. [ci collect-info?]) resolve-info?]{ +Performs the @techlink{resolve pass}. } @@ -62,6 +64,7 @@ Creates a renderer whose output goes to @scheme[dest-dir]. [ri resolve-info?]) void?]{ +Produces the final output. } @@ -81,5 +84,3 @@ Adds the deserialized form of @scheme[v] to @scheme[ci]. } } - -@include-class[render%]