Legacy Document

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

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

/ Creating Buttons

<Dimmable Button Data>

You can use the <Dimmable Button Data> command to specify that a dimmable navigation button should be active on a particular panel.

<Dimmable Button Data> buttonName, sequenceName

buttonName

A string specifying the navigation button's name.

sequenceName

The name of the sequence to launch when the user clicks the button defined by the buttonName parameter.

DESCRIPTION

The <Dimmable Button Data> command makes the navigation button specified by the buttonName parameter active. The navigation button is active only for a panel definition that includes this command.

You must first define the navigation button using the <Define Nav Button> command and specify the constant DIMMABLE in the buttonEvent parameter. You then associate the navigation button with a sequence using the <Default Nav Button Set> or <Seq Nav Button Set> commands.

EXAMPLES

#example that uses the Huh? button. 
# The Huh? button is defined in the Standard Setup file as:
# <Define Nav Button> "Huh?", 1101, 1111, 1121, DIMMABLE

<Define Panel> "Panel 2"
#the Huh? button should be active on this panel, 
# so use the <Dimmable Button Data> command
# (when this navigation button is active and the user clicks 
# this button, Apple Guide launches a new sequence in a new window)
   <Dimmable Button Data> "Huh?", "Name of sequence to launch"
<End Panel>
<Define Sequence> "Sequence with Huh? button"
   #use this nav button set for this sequence
   <Seq Nav Button Set> "Huh? Only"
   <Panel> "Panel 1"    #Huh? button inactive
   <Panel> "Panel 2"    #Huh? button active
   <Panel> "Panel 3"    #Huh? button inactive
<End Sequence>
#example of a navigation button that uses the DIMMABLE constant
# (this kind of navigation button is inactive by default)
<Define Nav Button>  "Why?", "upWhyPict", "downWhyPict", \xAC
                     "dimmedWhyPict", DIMMABLE, \xAC
                     "b&wUpWhyPict", "b&wDownWhyPict", \xAC
                     "b&wDimmedWhyPict"
#define a nav button set that uses the Why? button and
# specify the Why? button as the middle navigation button
<Define Nav Button Set> "Why Nav Button Set", \xAC
                        "GoStart", "Why?"
<Define Sequence> "Sequence with Why? button"
   <Seq Nav Button Set> "Why Nav Button Set"
   <Define Panel> "Panel 2"
      #the Why? button should be active on this panel, 
      # so use the <Dimmable Button Data> command
      # (when this navigation button is active and the user clicks 
      # this button, Apple Guide launches the specified sequence 
      # in a new window)
      <Dimmable Button Data> "Why?", "sequence name to launch"
   <End Panel>
<End Sequence>

SEE ALSO

For information on creating other buttons, such as standard buttons, radio buttons, or checkboxes, see "Creating Buttons" beginning on page 10-57.