suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Eventspace doc fixes and improvements

Browse Source 
In particular, using a shut down eventspace actually returns
the exn:fail exception instead of exn:misc, which does not
exist. Example:
  #(struct:exn:fail start in timer%: current eventspace is shutdown:
    #<eventspace> #<continuation-mark-set>)
This commit is contained in:
Asumu Takikawa 2013-08-02 15:32:42 -04:00
parent ac20e7fc0d
commit 26b7c98356
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
pkgs/gui-pkgs/gui-doc/scribblings/gui/eventspace-funcs.scrbl
View File

@ -5,7 +5,7 @@
@defproc[(make-eventspace) @defproc[(make-eventspace)
eventspace?]{ eventspace?]{
Creates and returns a new eventspace value. The new eventspace is Creates and returns a new @tech{eventspace} value. The new eventspace is
created as a child of the current eventspace. The eventspace is used created as a child of the current eventspace. The eventspace is used
by making it the current eventspace with the by making it the current eventspace with the
@racket[current-eventspace] parameter. @racket[current-eventspace] parameter.
@ -57,7 +57,9 @@ Produces a synchronizable event (see @racket[sync]) that is ready when
a GUI event (mouse or keyboard action, update event, timer, queued a GUI event (mouse or keyboard action, update event, timer, queued
callback, etc.) is ready for dispatch in @racket[e]. That is, the callback, etc.) is ready for dispatch in @racket[e]. That is, the
result event is ready when @racket[(yield)] for the eventspace result event is ready when @racket[(yield)] for the eventspace
@racket[e] would dispatch a GUI event.} @racket[e] would dispatch a GUI event. The synchronization result is
the eventspace @racket[e] itself.
}
@defproc[(check-for-break) @defproc[(check-for-break)
@ -219,10 +221,10 @@ Blocks for at least the specified number of seconds, handling events
Returns @racket[#t] if the given eventspace has been shut down by its Returns @racket[#t] if the given eventspace has been shut down by its
custodian, @racket[#f] otherwise. Attempting to create a new window, custodian, @racket[#f] otherwise. Attempting to create a new window,
timer, or explicitly queued event in a shut-down eventspace raises timer, or explicitly queued event in a shut-down eventspace raises
the @racket[exn:misc] exception. the @racket[exn:fail] exception.
Attempting to use certain methods of windows and timers in a shut-down Attempting to use certain methods of windows and timers in a shut-down
eventspace also raises the @racket[exn:misc] exception, but the eventspace also raises the @racket[exn:fail] exception, but the
@xmethod[area<%> get-top-level-window] and @xmethod[area<%> get-top-level-window] and
@xmethod[top-level-window<%> get-eventspace] methods work even after the area's eventspace is shut down. @xmethod[top-level-window<%> get-eventspace] methods work even after the area's eventspace is shut down.