[Contents] [Index] [Help] [Browse <] [Browse >]

 -- Command: cycle ID/K, COMMAND/K, PORT/K, HELP/K, NODE/K, ATTRS/K/M,
          LABEL=LABELS/K/F
     Cycle gadget objects are created with this command.  Cycle and
     radio gadgets are essentially identical with the only difference
     being the base object class to create each type of object.  All
     options are identical for these objects.

        * ID [I..] - an id can be assigned to a gadget for later
          reference. The id can be any combination of up to 5
          characters.  If the id is given without any other arguments,
          and the gadget has been previously created, then the
          currently selected label will be returned in RESULT (if
          OPTIONS RESULTS is specified in the script).

        * COMMAND [I..] - if given, the command will be executed
          whenever the gadget is selected.  For a complete description
          of this option see Command-Port Options.  Note that the
          gadget active label (see the LABELS argument description)
          will be used to replace a `%s' contained in the command
          string.

        * PORT [I..] - a specific host port may be specified by this
          argument. For a complete description of this option see
          Command-Port Options.

        * HELP [I..] - with this argument help text may be defined
          which will be displayed as balloon help whenever the pointer
          is over the associated gadget.  Of course, this is dependant
          on whether the user set up balloon help in the MUI preference
          settings.

        * NODE [I..] - this argument is used to specify a node in the
          guide file given in the command line argument HELP for
          `MUIRexx'.  If the user positions the mouse pointer over the
          gadget and presses the help button on the keyboard then the
          guide file will be displayed at the node location.

        * LABELS [ISG] - a series of strings (separated by commas) may
          be specified by this argument.  These strings are used as the
          labels for the gadget object.  The currently displayed label
          may be retrieved by issuing the gadget command with an
          existing ID.  Also, the selected label may be set by issuing
          the gadget command with an existing ID and label.  Note that
          the labels may contain any of the special formatting
          sequences (see MUI Format Sequences).

        * ATTRS [ISG] - with this option any MUIA attribute TAGs may be
          set or retrieved (see Attribute TAGs).

     Some useful TAGs for use with this command are:

          TAG_Name =                        TAG_id          Flags Type
          
          Cycle_Active =                    0x80421788 /* V4  isg LONG */
          Radio_Active =                    0x80429b41 /* V4  isg LONG */
          ControlChar =                     0x8042120b /* V4  isg char */
          CycleChain =                      0x80421ce7 /* V11 isg LONG */
          Disabled =                        0x80423661 /* V4  isg BOOL */
          FixHeight =                       0x8042a92b /* V4  i.. LONG */
          FixHeightTxt =                    0x804276f2 /* V4  i.. STRPTR */
          FixWidth =                        0x8042a3f1 /* V4  i.. LONG */
          FixWidthTxt =                     0x8042d044 /* V4  i.. STRPTR */
          HorizDisappear =                  0x80429615 /* V11 isg LONG */
          HorizWeight =                     0x80426db9 /* V4  isg WORD */
          MaxHeight =                       0x804293e4 /* V11 i.. LONG */
          MaxWidth =                        0x8042f112 /* V11 i.. LONG */
          Selected =                        0x8042654b /* V4  isg BOOL */
          ShowMe =                          0x80429ba8 /* V4  isg BOOL */
          VertDisappear =                   0x8042d12f /* V11 isg LONG */
          VertWeight =                      0x804298d0 /* V4  isg WORD */
          Weight =                          0x80421d1f /* V4  i.. WORD */
          
          Note: Consult MUI:Developer/Autodocs/MUI_Cycle.doc, MUI_Radio.doc,
                MUI_Area.doc and MUI:Developer/C/Include/libraries/mui.h

     Example use of this command:

          window ID PAGE TITLE '"Character Definition"'
              group HORIZ
                  group
                      label SINGLE 'Name:'
                      label SINGLE 'Sex:'
                  endgroup
                  group
                      string ID NAME CONTENT 'Frodo'
                      cycle ID SEX LABELS 'male,female'
                  endgroup
              endgroup
              space 2
              group REGISTER LABELS 'Race,Class,Armor,Level'
                  group FRAME
                      radio ID RACE LABELS 'Human,Elf,Dwarf,Hobbit,Gnome'
                  endgroup
                  .
                  .
                  .
          endwindow
          
          cycle ID SEX
          say result
          radio ID RACE
          say result