Qtilities::Plugins::Help Namespace Reference

Namespace containing all classes related to the Help Plugin. More...

Namespaces
namespace	Constants
	Namespace containing all constants related to the Help Plugin.

Classes
class	Browser
	A very simple browser wrapper around QWebView used to display help pages. More...
struct	BrowserData
	The BrowserData struct stores private data used by the Browser class. More...
class	ContentWidgetFactory
	The ContentWidgetFactory class makes a QHelpContentWidget widget for the HELP_MANAGER available as a side viewer widget. More...
class	HelpMode
	An implementation of Qtilities::CoreGui::Interfaces::IMode which make a GUI frontend for the HELP_MANAGER available as a mode in an application. More...
struct	HelpModeData
	The HelpModeData class stores private data used by the HelpMode class. More...
class	HelpPlugin
	A help plugin for a Qtilities application. More...
class	HelpPluginConfig
	The HelpPluginConfig class provides a ready to use configuration widget for the help plugin. More...
struct	HelpPluginData
	The HelpPluginData struct stores private data used by the HelpPlugin class. More...
class	IndexWidgetFactory
	The IndexWidgetFactory class makes a QHelpIndexWidget widget for the HELP_MANAGER available as a side viewer widget. More...
class	SearchWidgetFactory
	The SearchWidgetFactory class makes a QHelpSearchQueryWidget and QHelpSearchResultsWidget available for the HELP_MANAGER available as a side viewer widget. More...

---

Detailed Description

Namespace containing all classes related to the Help Plugin.

This plugin provides a help mode in the Qtilities main window which allows Qt Assistant help files to be shown.

Help Plugin Showing GUI Frontend For The Help Manager

In addition, it adds a configuration page for the help system to the user.

Help Configuration Page

The help plugin works through the help engine provided by the HELP_MANAGER (See Qtilities::CoreGui::QtilitiesApplication::helpManager() for more information).

This plugin was introduced in Qtilities v1.1.