Legacy Document

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

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

/ Creating Coachmarks

<Define Object Coach>

You can use the <Define Object Coach> command to define a coachmark for an object, based on a rectangle that your application returns for the named object.

<Define Object Coach> coachMarkName, targetApp [, coachStyle]
                     [, objectName]

coachMarkName

A text string specifying the name of this object coach.

targetApp

A four-character sequence specifying the signature of the target application.

coachStyle

A value indicating the coach style to use for the item. You specify how Apple Guide should draw the coachmark for the item using a constant or red arrow specifier:

Constant

REDCIRCLE, REDUNDERLINE, or GREENX

Red arrow specifier
RedArrow(start, end)
Use the RedArrow function to draw a red arrow beginning at a location specified by start and ending at a location specified by end. The values for start and end are integers 1 through 8, where each value indicates a general location in a rectangle:

Location	Value
Top left	1
Top center	2
Top right	3
Middle right	4
Bottom right	5
Bottom center	6
Bottom left	7
Middle left	8

These values indicate the eight possible points for the start and end of the arrow.

The coachStyle parameter is optional. If you omit this parameter, Apple Guide uses REDCIRCLE as the default.

objectName

The object associated with this coachmark.

DESCRIPTION

The <Define Object Coach> command defines an object coach. You associate an object coach with a particular panel using the <Coach Mark> command. When Apple Guide opens a panel that includes a <Coach Mark> command naming a defined object coach, Apple Guide sends an Apple event to your application, requesting it to return a rectangle for the named object. Once your application returns a rectangle for the object, Apple Guide draws the coachmark.

EXAMPLES

#define an object coach 
<Define Object Coach> "InfoButtonCoach", 'WAVE', 
                      REDCIRCLE, "infoBox"
<Define Panel> "the info button"
   <Coach Mark> "InfoButtonCoach"
<End Panel> 

SEE ALSO

For information on the <Coach Mark> command, see page 10-118.