HelpSource/Classes/HelpBrowser.schelp

   1 class:: HelpBrowser
   2 categories:: HelpSystem, GUI
   3 related:: Classes/SCDoc
   4 summary:: Browse the SuperCollider help documentation
   5
   6 description::
   7
   8 HelpBrowser is the GUI help browser that lets you browse the documentation of SuperCollider. It is coupled with SCDoc to allow on-the-fly rendering of HTML help files.
   9
  10 classmethods::
  11
  12 method:: instance
  13 The singleton HelpBrowser instance.
  14
  15 method:: new
  16 Create a new HelpBrowser instance with given home URL.
  17
  18 method:: defaultHomeUrl
  19 Get or set the default home URL.
  20
  21 method:: openNewWindows
  22 Get or set the default for "open in new windows" toggle.
  23
  24 method:: goTo
  25 Go to url with singleton instance or a new window, depending on the code::openNewWindows:: setting.
  26
  27 method:: openHelpFor
  28 Open the relevant help page for given text in the singleton HelpBrowser instance.
  29
  30 method:: openSearch
  31 Open the help search page with given text in the singleton HelpBrowser instance.
  32
  33 method:: openBrowser
  34 Open the category browser page in the singleton HelpBrowser instance.
  35
  36 instancemethods::
  37 private:: init, openTextFile, startAnim, stopAnim
  38
  39 method:: homeUrl
  40 Get or set the home URL.
  41
  42 method:: window
  43 The GUI window for this HelpBrowser.
  44 discussion::
  45 Mainly useful for when you need to show the browser:
  46 code::
  47 HelpBrowser.instance.window.front;
  48 ::
  49
  50 method:: goTo
  51 Go to specific URL. If the URL points to a file under link::Classes/SCDoc#*helpTargetDir:: it will be rendered on demand if needed.
  52
  53 method:: goHome
  54 Go to the home URL.
  55
  56 method:: goBack
  57 Go back.
  58
  59 method:: goForward
  60 Go forward.
  61