71 lines
1.7 KiB
Text
71 lines
1.7 KiB
Text
|
class:: HelpBrowser
|
||
|
|
categories:: HelpSystem, GUI>Interfaces
|
||
|
|
related:: Classes/SCDoc
|
||
|
|
summary:: Browse the SuperCollider help documentation
|
||
|
|
|
||
|
|
description::
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
classmethods::
|
||
|
|
private:: getOldWrapUrl, initClass
|
||
|
|
|
||
|
|
method:: instance
|
||
|
|
The singleton HelpBrowser instance.
|
||
|
|
|
||
|
|
method:: new
|
||
|
|
Create a new HelpBrowser instance with given home URL.
|
||
|
|
|
||
|
|
method:: defaultHomeUrl
|
||
|
|
Get or set the default home URL.
|
||
|
|
|
||
|
|
method:: openNewWindows
|
||
|
|
Get or set the default for "open in new windows" toggle.
|
||
|
|
|
||
|
|
method:: goTo
|
||
|
|
Go to url with singleton instance or a new window, depending on the code::openNewWindows:: setting.
|
||
|
|
|
||
|
|
method:: openHelpFor
|
||
|
|
Open the relevant help page for given text in the singleton HelpBrowser instance.
|
||
|
|
|
||
|
|
method:: openSearchPage
|
||
|
|
Open the help search page with given text in the singleton HelpBrowser instance.
|
||
|
|
|
||
|
|
method:: openBrowsePage
|
||
|
|
Open the category browser page in the singleton HelpBrowser instance.
|
||
|
|
|
||
|
|
argument:: category
|
||
|
|
An optional String to start at specified category, like "UGens>Filters"
|
||
|
|
|
||
|
|
method:: openHelpForMethod
|
||
|
|
Open help for specified method.
|
||
|
|
argument:: method
|
||
|
|
a link::Classes/Method::
|
||
|
|
|
||
|
|
instancemethods::
|
||
|
|
private:: init, openTextFile, startAnim, stopAnim
|
||
|
|
|
||
|
|
method:: homeUrl
|
||
|
|
Get or set the home URL.
|
||
|
|
|
||
|
|
method:: window
|
||
|
|
The GUI window for this HelpBrowser.
|
||
|
|
discussion::
|
||
|
|
Mainly useful for when you need to show the browser:
|
||
|
|
code::
|
||
|
|
HelpBrowser.instance.window.front;
|
||
|
|
::
|
||
|
|
|
||
|
|
method:: goTo
|
||
|
|
Go to specific URL. If the URL points to a file under link::Classes/SCDoc#*helpTargetDir:: it will be rendered on demand if needed.
|
||
|
|
|
||
|
|
method:: goHome
|
||
|
|
Go to the home URL.
|
||
|
|
|
||
|
|
method:: goBack
|
||
|
|
Go back.
|
||
|
|
|
||
|
|
method:: goForward
|
||
|
|
Go forward.
|
||
|
|
|