TmRoot(3Tm)

NAME
     TmRoot - the toplevel widget ``.''

SYNOPSIS
     xtAppInitialize

DESCRIPTION
     This is the command that creates the root widget ``.''


OPTIONS
     The function xtAppInitialize has these options
          -class class
          -fallbackResources resources
               These are in a tcl list, as in
                    {
                               {*list.visibleItemCount: 10}
                               {*quit.labelString: Quit}
                    }
          -options options
               These set the application options. The options  is  a  list  of
               option  values.  Each option value consists of the command line
               option  (such  as  -helpFile),  the  resource  name  (such   as
               helpFile)  and  the  type  of  command line argument supported.
               Possible values for this are
                    noArg
                    sepArg
                    stickyArg
                    resArg
                    skipArg
                    skipLine
               For example,
                    -options {
                         {-helpFile helpFile sepArg}
                         {-showHelp showHelp isArg}
                        }


METHODS
     The methods supported for this widget include all the commands for the
     TmCore and TmTopLevelShell widget.  In addition, these methods are also
     available to the ``.'' widget
          addInput
          removeInput
          addTimer
          removeTimer
          getAppResources
          mainLoop
          processEvent

     addInput file mode command
          This method adds the tcl command as an input handler for the file,
          according to the mode specified. This can be `r' for read, `w' for
          write or `x' for exception. Whenever the file is ready for the
          requested operation the tcl function is called to handle it.  The
          command returns an XID which is an identifier for the input handler.

     removeInput inputID
          This method removes the file handler added by addInput. It takes as
          argument the identifier returned from ``addInput''.

     addTimer interval command
          This method adds the tcl command to an Xt timer.  The interval is in
          milliseconds.  The command returns an XID which is an identifier for
          the input handler.

     removeTimer timerID
          This method removes the timer added by addTimer. It takes as
          argument the identifier returned from ``addTimer''.  Note that if an
          attempt is made to remove a timer that has gone off, Xt has
          unspecified behaviour.

     getAppResources resources
          This extracts the application resources as set in the resource
          database.  The resources argument is a list of resource sets. Each
          one consists of the resource name, its class, the default value and
          the name of a tcl variable to store the value in.  For example,
               {
                   {helpFile HelpFile "" tcl_helpFile }
                   {showHelp ShowHelp 0 tcl_show}
               }

     mainLoop
          This starts the Xt event processing loop

     processEvent
          This processes the next event,  along  with  any  timers  and  input
          handlers.  It is supplied here for use in modal dialogs.


CALLBACK SUBSTITUTIONS
     No additional substitutions are supported for this class.

BUGS
     None known.

AUTHOR
     Jan Newmarch, University of Canberra