Legacy Document

Inside Macintosh: Apple Guide Complete / Part 4 - Scripting Guide Files

Chapter 10 - Guide Script Command Reference / Guide Script Command Descriptions

/ Specifying Events

<On Panel Hide>

You can use the <On Panel Hide> command to define an event function that Apple Guide executes when hiding a panel.

<On Panel Hide> eventFunction [, firstOrAlways]

eventFunction

An event function or event list.

firstOrAlways

A constant that indicates whether Apple Guide should execute the event function only when it first hides the panel (FIRST) or both when it first hides the panel and whenever the panel is minimized (ALWAYS). This parameter is optional. If you omit this parameter, Apple Guide uses ALWAYS as the default.

DESCRIPTION

The <On Panel Hide> command defines an event function or event list for a panel. Apple Guide executes the event function, based on the firstOrAlways parameter, when Apple Guide hides the panel to which it is attached. Hiding a panel refers to Apple Guide either closing the panel or minimizing the panel. Event functions are usually used to send an Apple event to a target application, requesting it to perform some action.

You can use multiple <On Panel Hide> commands per panel. Apple Guide executes event functions in the order in which the <On Panel Hide> command appears in your panel definition.

EXAMPLES

<Define Panel> "Example Panel"
   #play a sound the first time Apple Guide hides the panel
   <On Panel Hide> PlaySound(1000), FIRST
<End Panel>

SEE ALSO

For information on the <Define Event> and <Define Event List> commands, see page 10-178 and page 10-181, respectively. Guide Maker's built-in event functions are described next.