Inheritance diagram for DzHelpMgr:
Methods | |
String | getDescription (String label) |
String | getHelpCollection (Number which) |
String | getHelpString (String label) |
String | getHomePage (Number which) |
String | getHomePage (String collection) |
String | getNavPage (Number which) |
String | getNavPage (String collection) |
Number | getNumHelpCollections () |
String | getStatusTip (String label) |
String | getToolTip (String label) |
void | setOnlineHelp (DzAction action) |
void | setOnlineHelp (Widget widget) |
Use DzApp::getHelpMgr() to access.
See DAZ Studio Help Generator for information on how to populate the Help Manager.
label | The label of the help item |
label
.
which | The index of the collection to retrieve information for |
label | The label of the help item |
label
.
which | The index of the collection to retrieve information for |
collection | The name of the help collection |
collection
, as the "home" page.
which | The index of the collection to retrieve information for |
collection | The name of the help collection |
collection
, for navigation. Number DzHelpMgr::getNumHelpCollections | ( | ) |
label | The label of the help item |
label
.
label | The label of the help item |
label
. void DzHelpMgr::setOnlineHelp | ( | DzAction | action | ) |
Checks the help items loaded from the current help documents to find a set of help text with a name matching the action's class name. If a matching set of data is found, it will be used to set the Tool Tip and What's This text for the action.
action | The action to set the help text for. The class name of the action is used to look up its help text. |
void DzHelpMgr::setOnlineHelp | ( | Widget | widget | ) |
Checks the help items loaded from the current help documents to find a set of help text with a name matching the widget's. If a matching set of data is found, it will be used to set the Tool Tip and What's This text for the widget.
widget | The widget to set the help text for. The name of the widget is used to look up its help text. |