HelpBrowser Class Reference

Help browser for the application. More...

#include <helpbrowser.h>

List of all members.

Public Member Functions

HelpBrowser (const QString &path, const QString &page, QWidget *parent=0)

Static Public Member Functions

static void showPage (const QString &page)

Detailed Description

Help browser for the application.

Class containing the help browser for the application. The actual help files are regular html files, and are located in the doc folder. This widget is heavily influenced by an example in the book "C++ Gui Programming with Qt4" by Jasmine Blanchette and Mark Summerfield. We saw no reason to implement it any other way.

Definition at line 42 of file helpbrowser.h.

Constructor & Destructor Documentation

HelpBrowser::HelpBrowser	(	const QString &	path,
		const QString &	page,
		QWidget *	parent = `0`
	)

Constructor.

Parameters:

	path	Location of the files to be displayed.
	page	The starting page to be displayed.
	parent	The parent widget.

Definition at line 29 of file helpbrowser.cpp.

Member Function Documentation

void HelpBrowser::showPage ( const QString & page ) [static]

Opens a new browser with the supplied page as starting page.

Parameters:

page

The starting page of the new browser.

Definition at line 70 of file helpbrowser.cpp.

The documentation for this class was generated from the following files:


Public Member Functions
	HelpBrowser (const QString &path, const QString &page, QWidget *parent=0)
Static Public Member Functions
static void	showPage (const QString &page)