HelpSource/Classes/HelpBrowser.schelp

   1 class:: HelpBrowser
   2 categories:: HelpSystem, GUI>Interfaces
   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 private:: getOldWrapUrl, initClass
  12
  13 method:: instance
  14 The singleton HelpBrowser instance.
  15
  16 method:: new
  17 Create a new HelpBrowser instance with given home URL.
  18
  19 method:: defaultHomeUrl
  20 Get or set the default home URL.
  21
  22 method:: openNewWindows
  23 Get or set the default for "open in new windows" toggle.
  24
  25 method:: goTo
  26 Go to url with singleton instance or a new window, depending on the code::openNewWindows:: setting.
  27
  28 method:: openHelpFor
  29 Open the relevant help page for given text in the singleton HelpBrowser instance.
  30
  31 method:: openSearchPage
  32 Open the help search page with given text in the singleton HelpBrowser instance.
  33
  34 method:: openBrowsePage
  35 Open the category browser page in the singleton HelpBrowser instance.
  36
  37 argument:: category
  38 An optional String to start at specified category, like "UGens>Filters"
  39
  40 method:: openHelpForMethod
  41 Open help for specified method.
  42 argument:: method
  43 a link::Classes/Method::
  44
  45 instancemethods::
  46 private:: init, openTextFile, startAnim, stopAnim
  47
  48 method:: homeUrl
  49 Get or set the home URL.
  50
  51 method:: window
  52 The GUI window for this HelpBrowser.
  53 discussion::
  54 Mainly useful for when you need to show the browser:
  55 code::
  56 HelpBrowser.instance.window.front;
  57 ::
  58
  59 method:: goTo
  60 Go to specific URL. If the URL points to a file under link::Classes/SCDoc#*helpTargetDir:: it will be rendered on demand if needed.
  61
  62 method:: goHome
  63 Go to the home URL.
  64
  65 method:: goBack
  66 Go back.
  67
  68 method:: goForward
  69 Go forward.
  70