BALL::VIEW::HelpViewer Class Reference
[Modular Widgets]
#include <BALL/VIEW/WIDGETS/helpViewer.h>
List of all members.
Detailed Description
DockWidget to show online help texts e.g. the BALLView documentation The documentation for BALLView was written in the HTML format, such that it either be used online from the project's website or inside the program itself. To obtain help for individual elements in the graphical user interface a special mode was added. In the "Help" menu the entry "Whats this?" will switch into this mode and transform the mouse cursor into a question mark. While the "Whats this?" mode is active a left mouse click on any widget will open the corresponding help entry in the documentation. (If no help entry for that widget exists nothing will happen.) To leave the "Whats this?" mode just press the right mouse button or press the "Escape" key. As an alternative for this approach the "F1" key will popup the documentation for the current widget under the mouse cursor.
To show a specific help page, just call ModularWidget::showHelp(String) or send a ShowHelpMessage. Per default the HelpViewer looks for index.html in $BALL_DATA_PATH/../doc/BALLView . You can change this behavior by using setDefaultDir() and setDefaultPage(). Links to pages on the WWW wont work! QWidgets and menu entries can be registered with a link into the HTML documentation. See registerWidgetForHelpSystem. The implemention for opening the documentation per "Whats this?" menu entry and the hotkey "F1" is also done here.
Constructor & Destructor Documentation
| BALL::VIEW::HelpViewer::HelpViewer |
( |
QWidget * |
parent, |
|
|
const char * |
name = 0 | |
|
) |
| | |
| virtual BALL::VIEW::HelpViewer::~HelpViewer |
( |
|
) |
[virtual] |
Member Function Documentation
| void BALL::VIEW::HelpViewer::collectClasses_ |
( |
|
) |
[protected] |
| void BALL::VIEW::HelpViewer::enterWhatsThisMode |
( |
|
) |
[slot] |
Event filter for the whats this mode.
| void BALL::VIEW::HelpViewer::exitWhatsThisMode |
( |
|
) |
[slot] |
| const String& BALL::VIEW::HelpViewer::getBaseDirectory |
( |
|
) |
const |
| const String& BALL::VIEW::HelpViewer::getDefaultPage |
( |
|
) |
const |
| String BALL::VIEW::HelpViewer::getHelpEntryFor |
( |
const QObject * |
object |
) |
const |
Get help entry for widget.
| String BALL::VIEW::HelpViewer::getProject |
( |
|
) |
const [inline] |
| bool BALL::VIEW::HelpViewer::hasHelpFor |
( |
const QObject * |
object |
) |
const |
Check wheter we have a documentation entry for a given object.
| virtual void BALL::VIEW::HelpViewer::initializeWidget |
( |
MainControl & |
main_control |
) |
[virtual] |
| bool BALL::VIEW::HelpViewer::isWhatsThisEnabled |
( |
|
) |
const [inline] |
| virtual void BALL::VIEW::HelpViewer::onNotify |
( |
Message * |
message |
) |
[virtual] |
| virtual void BALL::VIEW::HelpViewer::registerForHelpSystem |
( |
const QObject * |
object, |
|
|
const String & |
docu_entry | |
|
) |
| | [virtual] |
| void BALL::VIEW::HelpViewer::setBaseDirectory |
( |
const String & |
dir |
) |
|
| void BALL::VIEW::HelpViewer::setDefaultPage |
( |
const String & |
url |
) |
|
| void BALL::VIEW::HelpViewer::setProject |
( |
const String & |
project |
) |
[inline] |
| void BALL::VIEW::HelpViewer::setWhatsThisEnabled |
( |
bool |
state |
) |
[inline] |
| void BALL::VIEW::HelpViewer::showDocumentationFor |
( |
const String & |
classname, |
|
|
const String & |
member | |
|
) |
| | |
| bool BALL::VIEW::HelpViewer::showDocumentationForObject |
( |
|
) |
|
Show documentation for object under cursor.
| virtual void BALL::VIEW::HelpViewer::showHelp |
( |
|
) |
[virtual, slot] |
| virtual void BALL::VIEW::HelpViewer::showHelp |
( |
const String & |
URL, |
|
|
String |
entry | |
|
) |
| | [virtual] |
| virtual void BALL::VIEW::HelpViewer::showHelp |
( |
const String & |
URL |
) |
[virtual] |
| bool BALL::VIEW::HelpViewer::showHelpFor |
( |
const QObject * |
object |
) |
|
Show the documentation entry for a given widget.
| void BALL::VIEW::HelpViewer::unregisterForHelpSystem |
( |
const QObject * |
object |
) |
|
Unregister a widget for showing its documentation.
Member Data Documentation
