Skip to content

Commit

Permalink
move the docs for the set-modified and set-filename methods
Browse files Browse the repository at this point in the history
so they link to the super methods properly

(there is no export of drracket:unit:definitions-text% so that can't
work as a conduit to track the supers)

related to racket/gui#185
  • Loading branch information
rfindler committed Jun 14, 2020
1 parent 15e3a9a commit 5d6b658
Showing 1 changed file with 25 additions and 31 deletions.
56 changes: 25 additions & 31 deletions drracket/scribblings/tools/unit.scrbl
Original file line number Diff line number Diff line change
Expand Up @@ -823,34 +823,7 @@ that the button is not referenced by this frame and thus can be gc'd.

}


@defclass[drracket:unit:definitions-text%
(drracket:rep:drs-bindings-keymap-mixin
(drracket:unit:program-editor-mixin (racket:text-mixin text:info%)))
(drracket:unit:definitions-text<%>)]{

@defconstructor[()]{
Passes all arguments to @racket[super-init].
}

@defmethod[#:mode override
(set-filename)
void?]{

Calls
@method[drracket:unit:frame% update-save-message].
}

@defmethod[#:mode override
(set-modified)
void?]{

Calls
@method[drracket:unit:frame% update-save-button].
}}


@definterface[drracket:unit:definitions-text<%> ()]{
@definterface[drracket:unit:definitions-text<%> (editor<%>)]{

This interface is implemented by the definitions text.

Expand Down Expand Up @@ -943,9 +916,27 @@ changed, which affects newly created windows.
See also
@method[drracket:unit:definitions-text<%> after-set-next-settings] and
@method[drracket:unit:definitions-text<%> get-next-settings].
}

@defmethod[#:mode override
(set-filename [filename (or/c path-string? #f)]
[temporary? any/c #f])
void?]{

}}
The class that is the result of
@racket[(get-drracket:unit:definitions-text%)]
overrides this method and calls
@method[drracket:unit:frame% update-save-message].
}

@defmethod[#:mode override
(set-modified [modified? any/c])
void?]{
The class that is the result of
@racket[(get-drracket:unit:definitions-text%)]
overrides this method and calls
@method[drracket:unit:frame% update-save-button].
}}


@defclass[drracket:unit:definitions-canvas% editor-canvas% ()]{
Expand All @@ -955,9 +946,12 @@ Initializes the visibility of the save button.
}

@defproc[(drracket:unit:get-definitions-text%)
(implementation?/c drracket:unit:definitions-text<%>)]{
(and/c (instanceof/c racket:text<%>)
(instanceof/c text:info%)
(implementation?/c drracket:unit:definitions-text<%>))]{
Returns the class used to implement the definitions text
in the DrRacket frame.
in the DrRacket frame. Its result mixes in
@racket[drracket:unit:program-editor-mixin].
}

@(tools-include "unit")

0 comments on commit 5d6b658

Please sign in to comment.