User Tools

Site Tools


DzHelpMgr

Class that maintains the all the inline help documentation for DAZ Studio.

More...

Inherits :

Methods

Detailed Description

Use DzApp::getHelpMgr() to access.

See daz_studio_help_generator for information on how to populate the Help Manager.

Methods


void : browseToIdentifier( String identifier )

Opens the help browser at the given identifier.


void : browseToKeyword( String keyword )

Opens the help browser at the given keyword.


void : browseToPage( String page )

Opens the given page in the help browser.


void : browseToUrl( String urlString )

Opens the help browser at the given url.


Array : findFilterAttributes( String name )

Parameter(s):

  • name - The name of the help filter to get the attributes of.

Return Value:

  • The list of attributes for the help filter help keyword, or an empty list if the filter is not found.

String : findIdentifierUrl( String id )

TODO: Add description.


String : findKeywordUrl( String keyword )

Parameter(s):

  • keyword - The keyword to find the associated url for.

Return Value:

  • The url associated with the help keyword, or an empty url if the keyword is not found.

String : getDescription( String label )

Parameter(s):

  • label - The label of the help item

Return Value:

  • The description for the help item named label.

Array : getFilterAttributes( Number which )

Parameter(s):

  • which - The index of the help filter attributes to return.

Return Value:

  • The list of attributes for the help filter at the given index.

String : getFilterName( Number which )

Parameter(s):

  • which - The index of the help filter to return.

Return Value:

  • The name of the help filter at the given index.

String : getGroup( String label )

Parameter(s):

  • label - The label of the help item

Return Value:

  • The group for the help item named label.

DzHelpContentsItem : getHelpContents()

Return Value:

  • The root help contents item. The root contents item is usually not displayed, rather it serves to hold all the top-level help contents items.

String : getHelpString( String label )

Parameter(s):

  • label - The label of the help item

Return Value:

  • The help string text, named label.

String : getIdentifier( Number which )

Parameter(s):

  • which - The index of the help identifier to return.

Return Value:

  • The help identifier at the given index.

String : getIdentifierUrl( Number which )

Parameter(s):

  • which - The index of the help identifier url to return.

Return Value:

  • The url associated with the help identifier at the given index.

String : getKeyword( Number which )

Parameter(s):

  • which - The index of the help keyword to return.

Return Value:

  • The help keyword at the given index.

String : getKeywordUrl( Number which )

Parameter(s):

  • which - The index of the help keyword url to return.

Return Value:

  • The url associated with the help keyword at the given index.

Number : getNumFilters()

Return Value:

  • The number of help filters.

Number : getNumIdentifiers()

Return Value:

  • The number of help identifiers.

Number : getNumKeywords()

Return Value:

  • The number of help keywords.

String : getStatusTip( String label )

Parameter(s):

  • label - The label of the help item

Return Value:

  • The status tip text, named label.

String : getToolTip( String label )

Parameter(s):

  • label - The label of the help item

Return Value:

  • The tool tip text, named label.