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

 -- Command: string ID/K, COMMAND/K, PORT/K, HELP/K, NODE/K, ATTRS/K/M,
          CONTENT/K/F
     String gadget objects are created with this command.  String and
     popasl 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 string 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 string gadget has been previously created, then the
          current string gadget content will be returned in RESULT (if
          OPTIONS RESULTS is specified in the script).

        * COMMAND [I..] - if given, the command will be executed
          whenever a string is entered (i.e. a carriage return is hit
          while the gadget is active).  For a complete description of
          this option see Command-Port Options. Note that the string
          gadget content (see the CONTENT 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 string 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
          string gadget and presses the help button on the keyboard
          then the guide file will be displayed at the node location.

        * CONTENT [ISG] - the contents of the string gadget is given by
          this argument.

        * 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
          
          String_Accept =                   0x8042e3e1 /* V4  isg STRPTR */
          String_AdvanceOnCR =              0x804226de /* V11 isg BOOL */
          String_BufferPos =                0x80428b6c /* V4  .sg LONG */
          String_Contents =                 0x80428ffd /* V4  isg STRPTR */
          String_DisplayPos =               0x8042ccbf /* V4  .sg LONG */
          String_Format =                   0x80427484 /* V4  i.g LONG */
          String_Integer =                  0x80426e8a /* V4  isg ULONG */
          String_MaxLen =                   0x80424984 /* V4  i.g LONG */
          String_Reject =                   0x8042179c /* V4  isg STRPTR */
          String_Secret =                   0x80428769 /* V4  i.g BOOL */
          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_String.doc,
                MUI_Area.doc and MUI:Developer/C/Include/libraries/mui.h

     Example use of this command:

          window ID MAIN TITLE '"ShowIcon"'
              group HORIZ
                  button '"parent"' WEIGHT 0 COMMAND '"showicon /"'
                  string ID STRG COMMAND '"dirlist ID LIST PATH %s"' PORT SHOW
              endgroup
              .
              .
              .
              popasl ID 104 HELP '"this is an example popasl gadget"'
          endwindow
          
          string ID STRG
          say result