Legacy Document

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

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

/ Creating Buttons

<Define Nav Button Set>

You can use the <Define Nav Button Set> command to specify a set of up to three navigation buttons that can appear together in the navigation bar of each panel in a sequence.

<Define Nav Button Set> navButtonSetName
                        [, leftNavButton] [, midNavButton]
                        [, rightNavButton]

navButtonSetName

A string specifying the name of this navigation button set. This name must be unique from all other navigation button sets that you define.

leftNavButton

A string specifying the name of the navigation button to place in the left position of the navigation bar. This parameter is required if you provide the midNavButton parameter.

midNavButton

A string specifying the name of the navigation button to place in the middle position of the navigation bar. This parameter is required if you provide the rightNavButton parameter.

rightNavButton

A string specifying the name of the navigation button to place in the right position of the navigation bar (but to the left of the navigation arrows). This parameter is optional.

DESCRIPTION

The <Define Nav Button Set> command defines a set of navigation buttons and specifies their placement in the navigation bar. A navigation button can be placed in the left, middle, or right positions of the navigation bar. You use the <Define Nav Button> command to define the navigation buttons that you specify in the leftNavButton, midNavButton, and rightNavButton parameters.

To associate this navigation button set with a specific sequence, use the <Default Nav Button Set> or <Seq Nav Button Set> commands.

Note that any navigation buttons that you define using a <Define Nav Button Set> command appear to the left of the navigation arrows. Apple Guide always displays the navigation arrows on each panel. For each panel, Apple Guide makes the right navigation arrow active or inactive according to whether the user can navigate to a following panel. Apple Guide makes the left navigation arrow active or inactive according to whether the user can navigate to a previous panel. Apple Guide also displays the panel number (as it appears in a sequence) between the left and right navigation arrows.

Because the navigation bar is a fixed height and because navigation buttons should use the Apple Guide font, the navigation buttons you define (in <Define Nav Button> commands) should have a height of 18 pixels. The navigation bar has a fixed width and height, and the navigation arrows always appear on the right; therefore you should size and design your buttons to fit within this area.

The file Standard Setup is provided with Guide Maker. This file contains descriptions of the Huh? and GoStart navigation buttons, and defines three navigation button sets:

• "Standard Nav Bar". A navigation set that specifies the GoStart and Huh? navigation buttons as buttons in the navigation bar.
• "GoStart Only". A navigation set that specifies only the GoStart navigation button as a button in the navigation bar.
• "Huh? Only". A navigation set that specifies only the Huh? navigation button as a button in the navigation bar.

The Standard Setup file also defines the "Standard Nav Bar" button set as the default navigation button set. If you include the Standard Setup file in your build file, you can automatically use these two navigation buttons or any of the three navigation button sets as needed in your source files.

EXAMPLES

# The Huh? button is defined in the Standard Setup file as:
#<Define Nav Button> "Huh?", 1101, 1111, 1121, DIMMABLE
# The GoStart button is defined in the Standard Setup file as:
#<Define Nav Button> "GoStart", 1103, 1113, 1123, GoStart()
#define another nav button specific to this guide file
<Define Nav Button> "Another Nav Button", 2210, 2220, \xAC
                    2230, DoNav()
#define a navigation button set with three nav buttons
<Define Nav Button Set> "My Nav Bar", \xAC
                        "GoStart", "Huh?", "Another Nav Button"

SEE ALSO

For information on the <Define Nav Button>, <Default Nav Button Set>, and <Seq Nav Button Set> commands, see page 10-71, page 10-32, and page 10-43, respectively.