SuperCollider CLASSES

HelpBrowser

Browse the SuperCollider help documentation
Inherits from: Object

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.

Class Methods

*instance

The singleton HelpBrowser instance.

*new (aHomeUrl, newWin)

Create a new HelpBrowser instance with given home URL.

*defaultHomeUrl

*defaultHomeUrl = value

Get or set the default home URL.

*openNewWindows

*openNewWindows = value

Get or set the default for "open in new windows" toggle.

*goTo (url)

Go to url with singleton instance or a new window, depending on the openNewWindows setting.

*openHelpFor (text)

Open the relevant help page for given text in the singleton HelpBrowser instance.

*openSearchPage (text)

Open the help search page with given text in the singleton HelpBrowser instance.

*openBrowsePage (category)

Open the category browser page in the singleton HelpBrowser instance.

Arguments:

category

An optional String to start at specified category, like "UGens>Filters"

*openHelpForMethod (method)

Open help for specified method.

Arguments:

method

a Method

Inherited class methods

Undocumented class methods

*front

*goHome

Instance Methods

-homeUrl

-homeUrl = value

Get or set the home URL.

-window

The GUI window for this HelpBrowser.

Discussion:

Mainly useful for when you need to show the browser:

HelpBrowser.instance.window.front;

-goTo (urlString, brokenAction)

Go to specific URL. If the URL points to a file under SCDoc: *helpTargetDir it will be rendered on demand if needed.

-goHome

Go to the home URL.

-goBack

Go back.

-goForward

Go forward.

Inherited instance methods

Undocumented instance methods

-cmdPeriod

-redirectTextFile (url)