package nxm.sys.intr;

import nxm.sys.lib.Intrinsic;
import tools.BuildProps;         /* Used to access build properties. */

/** Displays HELP for a given keyword or query string. HELP can create the help index via the /INDEX
    switch. HELP displays a graphical user interface to query the help index via the /GUI switch.
    Otherwise HELP is an interactive command that users can list the search results and the result
    contents in a NeXtMidas shell.

    @author unknown / J. Czechowski IV / Jay Hallam / Neon Ngo
 */
abstract class HelpGui extends Intrinsic {
  /** deault constructor */
  public HelpGui () {}

  /** Start Interactive HelpGUI (it will stay up even after HELP command FINISHes).
   *  HelpGUI exits when user closes GUI or when Shell exits.
   *
   *  @param sysBuildProps The BuildProps for the SYS Option Tree
   *  @return FINISH
   */
  int runHelpGUI (BuildProps sysBuildProps) {
    M.warning("Help GUI disabled - running without graphical dependencies");
    return FINISH;
  }

  /** Launch the "lite" HelpGUI w/o the MJBrowser (viewer) and exit.
   *
   *  @param sysBuildProps The BuildProps for the SYS Option Tree
   *  @return FINISH
   */
  int runHelpLiteGUI (BuildProps sysBuildProps) {
    M.warning("Help LiteGUI disabled - running without graphical dependencies");
    return FINISH;
  }
}
