Launch help programs. More...

#include "us_help.h"

Inheritance diagram for US_Help:

Collaboration diagram for US_Help:

Public Member Functions
	US_Help (QObject *=0)
	Simple constructor. More...

void	show_help (const QString &)
	Show help page in Qt assistant window cusomized for US3. More...

void	show_URL (const QString &)
	Show URL page in the configured browser for US3. More...

void	show_html_file (const QString &)
	Show HTML file in the configured browser for US3. More...

Detailed Description

Launch help programs.

Provides functions to launch a web browser for external links or Qt Assistant for local help files.

Definition at line 16 of file us_help.h.

Constructor & Destructor Documentation

US_Help::US_Help ( QObject * parent = 0 )

Simple constructor.

Parameters

parent A pointer to the parent QObject. This normally can be left as NULL.

Definition at line 5 of file us_help.cpp.

void US_Help::openBrowser ( const QString & location )

private

Definition at line 77 of file us_help.cpp.

void US_Help::show_help ( const QString & helpFile )

Show help page in Qt assistant window cusomized for US3.

Parameters

helpFile Name of help page to be shown. For example, "us_config.html". Optionally prepended with "manual/"

Definition at line 8 of file us_help.cpp.

void US_Help::show_html_file ( const QString & location )

Show HTML file in the configured browser for US3.

Parameters

location HTML file to open in the configured browser

Definition at line 71 of file us_help.cpp.

void US_Help::show_URL ( const QString & location )

Show URL page in the configured browser for US3.

Parameters

location URL to open in the configured browser

Definition at line 65 of file us_help.cpp.

QProcess* US_Help::assistant

private

Definition at line 46 of file us_help.h.

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