HelpViewer Class Reference

#include <Workspace/Application/Help/helpviewer.h>

Inherits WebView.

Public Slots
void	home ()

Signals
void	backwardAvailable (bool enabled)
void	copyAvailable (bool enabled)
void	forwardAvailable (bool enabled)
void	highlighted (const QString &)
void	sourceChanged (const QUrl &)
void	titleChanged (HelpViewer *viewer)

Public Member Functions
	HelpViewer (HelpWindow &helpWindow, QWidget *parent=nullptr)
void	copy ()
QString	documentTitle () const
bool	isBackwardAvailable () const
bool	isForwardAvailable () const
void	setSource (const QUrl &url)
void	showHelp (const QMap< QString, QUrl > &links, const QString &keyword="")
void	showHelp (const QString &keyword)
void	showHelp (const QUrl &url)
void	showHelp (const QUrl &url, const QString &keyword)
QUrl	source () const
void	zoomIn (qreal range=1)
void	zoomOut (qreal range=1)
void	zoomReset ()

Protected Member Functions
void	mouseReleaseEvent (QMouseEvent *e) override
void	wheelEvent (QWheelEvent *e) override

Constructor & Destructor Documentation

HelpViewer()

HelpViewer	(	HelpWindow &	helpWindow,
		QWidget *	parent = nullptr
	)

Member Function Documentation

backwardAvailable

void backwardAvailable ( bool  enabled )

signal

copy()

void copy ( )

inline

copyAvailable

void copyAvailable ( bool  enabled )

signal

documentTitle()

QString documentTitle ( ) const

inline

forwardAvailable

void forwardAvailable ( bool  enabled )

signal

highlighted

void highlighted ( const QString &  )

signal

home

void home ( )

slot

isBackwardAvailable()

bool isBackwardAvailable ( ) const

inline

isForwardAvailable()

bool isForwardAvailable ( ) const

inline

mouseReleaseEvent()

void mouseReleaseEvent ( QMouseEvent *  e )

overrideprotected

setSource()

void setSource

(

const QUrl &

url

)

showHelp() [1/4]

void showHelp	(	const QMap< QString, QUrl > &	links,
		const QString &	keyword = ""
	)

showHelp() [2/4]

void showHelp

(

const QString &

keyword

)

showHelp() [3/4]

void showHelp

(

const QUrl &

url

)

showHelp() [4/4]

void showHelp	(	const QUrl &	url,
		const QString &	keyword
	)

source()

QUrl source ( ) const

inline

sourceChanged

void sourceChanged ( const QUrl &  )

signal

titleChanged

void titleChanged ( HelpViewer *  viewer )

signal

wheelEvent()

void wheelEvent ( QWheelEvent *  e )

overrideprotected

zoomIn()

void zoomIn

(

qreal

range = 1

)

zoomOut()

void zoomOut

(

qreal

range = 1

)

zoomReset()

void zoomReset

(

)