org.blueberry.ui.qt.help

Provides access to Qt Help information from inside the Workbench. More...

Collaboration diagram for org.blueberry.ui.qt.help:

Modules
	Internal
	This subcategory includes the internal classes of the org.blueberry.ui.qt.help plugin. Other plugins must not rely on these classes. They contain implementation details and their interface may change at any time. We mean it.

Detailed Description

Provides access to Qt Help information from inside the Workbench.

This plug-in collects all Qt QCH files (*.qch) from plug-ins in the RESOLVED state and registers them internally. The plug-in can be configured using the CTK Config Admin service and it listens to certain event topics on the CTK Event Admin.

The following configuration properties for the service PID "org.blueberry.services.help" are supported:

• homePage A QString property containing the a qthelp url pointing to the applications home page.

The plug-in subscribes to the following event topics:

• org/blueberry/help/CONTEXTHELP_REQUESTED signals a request for showing context sensitive help. If no properties are attached to the event, a qthelp url is constructed using the currently active part ID from the workbench. If the url is invalid, the home page is shown instead.
  
  Supported event properties are:
  • url Show the given url