probeTrigger
probeTrigger(
w_window
s_action
[ w_source ]
)
=> t / nil
Description
The probe trigger is called when the Design Editor has installed a new design in a window, whether an existing one or a new one. It is also called when the window is closed. This trigger allows the probing mechanism to keep its data structures consistent without requiring each application to call it separately.
Arguments
|
w_window
|
The window being operated on.
|
|
s_action
|
When a new window is created, and a design is installed, the probe trigger is called after the installation is complete with s_action == ’install. When a window is closed, the probe trigger is called with s_action ’close before any other actions are taken to dismantle the window. When an existing window is having its design changed, the probe trigger will be called twice. First, when the Design Editor calls deClearStack, the probe trigger will be called with s_action == ’close before any other action is taken. Then, after the new design is installed, it will be called again with s_action == ’install after the installation is complete, just as with the creation of a new window. For s_action == ’install or ’close, the third argument w_source is nil, and should be ignored.
|
|
w_source
|
If deCopy is used to make a copy of a window, the probe trigger is called with s_action == ’copy. In this case, the third argument, w_source, is not nil and is the source window of the copy. Thus the probe trigger can copy the probe context to the new window rather than creating a new context.
The probe trigger is responsible for setting and maintaining the probe context. Routines exist for setting and retrieving this context, which is otherwise opaque to the Design Editor.
|
Values Returned
|
t
|
The execution of the function succeeded.
|
|
nil
|
The execution of the function failed.
|
Return to top
