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

clarify docs on is-enabled?' and is-shown?'

Browse Source
This commit is contained in:
Matthew Flatt 2012-01-07 18:28:18 -07:00
parent fd019a3478
commit 9389947f6f
1 changed files with 35 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
collects/scribblings/gui/window-intf.scrbl
View File

@ -261,26 +261,27 @@ Indicates whether the window currently has the keyboard focus. See
} }
@defmethod[(is-enabled?) @defmethod[(is-enabled?)
boolean?]{ boolean?]{
Returns @racket[#t] if the window is enabled when all of its ancestors Indicates whether the window is currently enabled or not. The result is
are enabled, @racket[#f] otherwise. @racket[#t] if this window is enabled when its ancestors are enabled, or
@racket[#f] if this window remains disable when its ancestors are
} enabled. (That is, the result of this method is affected only by calls
to @method[window<%> enable] for @this-obj[], not by the enable state of
parent windows.)}
@defmethod[(is-shown?) @defmethod[(is-shown?)
boolean?]{ boolean?]{
Indicates whether the window is currently shown or not (when Indicates whether the window is currently shown or not. The result is
all of its ancestors are also shown). @racket[#t] if this window is shown when its ancestors are shown, or
@racket[#f] if this window remains hidden when its ancestors are
The result is @racket[#t] if this window is shown when its ancestors are shown. (That is, the result of this method is affected only by calls
shown, or @racket[#f] if this window remains hidden when its ancestors to @method[window<%> show] for @this-obj[], not by the visibility of
are shown. parent windows.)}
}
@defmethod[(on-drop-file [pathname path?]) @defmethod[(on-drop-file [pathname path?])
@ -430,18 +431,28 @@ Returns @racket[#f].
[on? boolean?]) [on? boolean?])
void?]{ void?]{
@methspec{
Called when this window or a child window receives or loses the keyboard focus. Called when this window or a child window receives or loses the keyboard focus.
This method is called after the @method[window<%> on-focus] method of @racket[receiver]. This method is called after the @method[window<%> on-focus] method of @racket[receiver].
The The
@method[window<%> on-subwindow-focus] method of the receiver's top-level window is called first (see @method[window<%> on-subwindow-focus] method of the receiver's top-level window is called first (see
@method[area<%> get-top-level-window]), then the @method[area<%> get-top-level-window]), then the
@method[window<%> on-subwindow-focus] method is called for the next child in the path to the receiver, and @method[window<%> on-subwindow-focus] method is called for the next child in the path to the receiver, and
so on.} so on.
}
@methimpl{
Does nothing.
}}
@defmethod[(on-superwindow-enable [enabled? any/c]) @defmethod[(on-superwindow-enable [enabled? any/c])
void?]{ void?]{
@methspec{
Called via the event queue whenever the enable state of a window has Called via the event queue whenever the enable state of a window has
changed, either through a call to the window's changed, either through a call to the window's
@method[window<%> enable] method, or through the enabling/disabling of one of the window's @method[window<%> enable] method, or through the enabling/disabling of one of the window's
@ -462,10 +473,16 @@ If the enable state of a window's ancestor changes while the window is
enable event is immediately queued. enable event is immediately queued.
} }
@methimpl{
Does nothing.
}}
@defmethod[(on-superwindow-show [shown? any/c]) @defmethod[(on-superwindow-show [shown? any/c])
void?]{ void?]{
@methspec{
Called via the event queue whenever the visibility of a window has Called via the event queue whenever the visibility of a window has
changed, either through a call to the window's changed, either through a call to the window's
@method[window<%> show], through the showing/hiding of one of the window's ancestors, or @method[window<%> show], through the showing/hiding of one of the window's ancestors, or
@ -481,6 +498,11 @@ This method is not called when the window is initially created; it is
dispatched, then the dispatch is canceled. dispatched, then the dispatch is canceled.
} }
@methimpl{
Does nothing.
}}
@defmethod[(popup-menu [menu (is-a?/c popup-menu%)] @defmethod[(popup-menu [menu (is-a?/c popup-menu%)]
[x (integer-in 0 10000)] [x (integer-in 0 10000)]