hou.HelpBrowser
class
Class representing a help browser pane tab. Provides methods for controlling the help browser.
Inheritence: hou.PaneTab >
Methods
Methods inherited from hou.PaneTab: isCurrentTab, setIsCurrentTab, name, setName, clone, isFloating, isPin, setPin, pane, linkGroup, close, type, setLinkGroup, setType
displayData(self, data, base_uri="")-
Loads the contents of a string directly into the help browser, either in plain text or html format.
If the data begins with
<html>, the browser will treat it as html; otherwise it will treat it as ascii text. Use base_uri to specify the base URI when loading data into the browser, which is used to resolve relative links from html data.Raises HOM_ObjectWasDeleted if the help browser pane tab was deleted, and raises HOM_Error if data is not given.
displayHelp(self, node_type)-
Loads the help for the specified node type.
Raises HOM_ObjectWasDeleted if the help browser pane tab was deleted.
displayHelpPath(self, help_path)homePage(self)→str-
Returns the home page URL of this help browser.
Raises HOM_ObjectWasDeleted if the help browser pane tab was deleted.
setHomePage(self, home_page)-
Sets the home page for this help browser to the specified URL.
Raises HOM_ObjectWasDeleted if the help browser pane tab was deleted, and raises HOM_Error if home_page is not given.
setUrl(self, url)-
Loads the specified URL.
Raises HOM_ObjectWasDeleted if the help browser pane tab was deleted, and raises HOM_Error if url is not given.
showUI(self, show)-
Shows or hides the help browser’s navigation controls.
Raises HOM_ObjectWasDeleted if the help browser pane tab was deleted.
url(self)→str-
Return the current URL of this help browser.
Raises HOM_ObjectWasDeleted if the help browser pane tab was deleted.