DzHelpMgr Class Reference
[Manager Objects]

Class that maintains the all the online help documentation for DAZ Studio. More...

Inheritance diagram for DzHelpMgr:

QObject Object List of all members.

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)

Detailed Description

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

Use DzApp::getHelpMgr() to access.

See DAZ Studio Help Generator for information on how to populate the Help Manager.


Member Function Documentation

String DzHelpMgr::getDescription ( String  label  ) 

Parameters:
label The label of the help item
Returns:
The description for the help item named label.

String DzHelpMgr::getHelpCollection ( Number  which  ) 

Parameters:
which The index of the collection to retrieve information for
Returns:
The name of the help collection at the given index.

String DzHelpMgr::getHelpString ( String  label  ) 

Parameters:
label The label of the help item
Returns:
The help string text, named label.

String DzHelpMgr::getHomePage ( Number  which  ) 

Parameters:
which The index of the collection to retrieve information for
Returns:
The path of the html document used as the "home" page of the help collection at the given index.

String DzHelpMgr::getHomePage ( String  collection  ) 

Parameters:
collection The name of the help collection
Returns:
The path of the html document used by collection, as the "home" page.

String DzHelpMgr::getNavPage ( Number  which  ) 

Parameters:
which The index of the collection to retrieve information for
Returns:
The path of the html document used for navigation of the help collection at the given index.

String DzHelpMgr::getNavPage ( String  collection  ) 

Parameters:
collection The name of the help collection
Returns:
The path of the html document used by collection, for navigation.

Number DzHelpMgr::getNumHelpCollections (  ) 

Returns:
The number of help collections.

String DzHelpMgr::getStatusTip ( String  label  ) 

Parameters:
label The label of the help item
Returns:
The status tip text, named label.

String DzHelpMgr::getToolTip ( String  label  ) 

Parameters:
label The label of the help item
Returns:
The tool tip text, named 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.

Parameters:
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.

Parameters:
widget The widget to set the help text for. The name of the widget is used to look up its help text.


Generated on Thu Sep 24 12:21:12 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.