BALL::VIEW::HelpViewer Class Reference
[Modular Widgets]

DockWidget to show online help texts e.g. More...

#include <helpViewer.h>

Inheritance diagram for BALL::VIEW::HelpViewer:

[legend]

List of all members.

Public Slots
virtual void	showHelp ()
	Show default page.
void	enterWhatsThisMode ()
void	exitWhatsThisMode ()
bool	eventFilter (QObject *obj, QEvent *e)
	Event filter for the whats this mode.
Public Member Functions
	HelpViewer (QWidget *parent, const char *name=0)
virtual void	initializeWidget (MainControl &main_control)
	Setup the menu entry.
virtual void	onNotify (Message *message)
	Handles messages sent by other registered ConnectionObject objects.
virtual void	showHelp (const String &URL)
virtual void	showHelp (const String &URL, String entry)
void	setDefaultPage (const String &url)
const String &	getDefaultPage () const
void	setProject (const String &project)
String	getProject () const
void	setBaseDirectory (const String &dir)
const String &	getBaseDirectory () const
virtual void	registerForHelpSystem (const QObject *object, const String &docu_entry)
	Register a widget for showing its documentation.
void	unregisterForHelpSystem (const QObject *object)
	Unregister a widget for showing its documentation.
bool	showHelpFor (const QObject *object)
	Show the documentation entry for a given widget.
bool	showDocumentationForObject ()
	Show documentation for object under cursor.
bool	hasHelpFor (const QObject *object) const
	Check wheter we have a documentation entry for a given object.
String	getHelpEntryFor (const QObject *object) const
	Get help entry for widget.
void	setWhatsThisEnabled (bool state)
bool	isWhatsThisEnabled () const
void	showDocumentationFor (const String &classname, const String &member)
Protected Member Functions
void	collectClasses_ ()
Protected Attributes
String	project_
String	default_page_
String	base_dir_
MyTextBrowser *	browser_
bool	whats_this_mode_
bool	ignore_event_
bool	whats_this_
QAction *	whats_action_
HashMap< const QObject *, String >	docu_entries_
StringHashMap< String >	classes_to_files_

---

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.

---

Member Function Documentation

virtual void BALL::VIEW::HelpViewer::onNotify

(

Message *

message

)

[virtual]

Handles messages sent by other registered ConnectionObject objects.

Filters for SceneMessage and sets the Camera appropriate or updates the visualization.

Parameters:

message

the pointer to the message that should be processed

See also:

ConnectionObject

Message

Reimplemented from BALL::VIEW::ConnectionObject.