HelpWindow Class Reference

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

Inherits QMainWindow.

Public Slots
void	destroy ()
void	showHelp (const QMap< QString, QUrl > &links, const QString &keyword="")
void	showHelp (const QString &keyword)
void	showHelp (const QUrl &url)
void	viewerTitleChanged (HelpViewer *viewer)

Public Member Functions
HelpViewer &	addTab ()
HelpViewer &	addTab (const QUrl &url)
QHelpEngine *	getHelpEngine ()
void	setDeleteOnClose (bool b)
void	showTab (HelpViewer &helpPage)

Static Public Member Functions
static HelpWindow &	getInstance ()
static void	setHelpParent (QWidget *parent)

Protected Member Functions
void	closeEvent (QCloseEvent *event) override
virtual QWebEngineView *	createWindow (QWebEnginePage::WebWindowType type)

Member Function Documentation

addTab() [1/2]

HelpViewer & addTab

(

)

addTab() [2/2]

HelpViewer & addTab

(

const QUrl &

url

)

closeEvent()

void closeEvent ( QCloseEvent *  event )

overrideprotected

createWindow()

QWebEngineView * createWindow ( QWebEnginePage::WebWindowType  type )

protectedvirtual

destroy

void destroy ( )

slot

getHelpEngine()

QHelpEngine * getHelpEngine

(

)

getInstance()

HelpWindow & getInstance ( )

static

Returns

The help window singleton. Its visibility state is left unmodified, so callers should take steps to ensure that the help window is shown if that is required.

Note

This function must only be called from the main GUI thread.

setDeleteOnClose()

void setDeleteOnClose

(

bool

b

)

setHelpParent()

void setHelpParent ( QWidget *  parent )

static

Parameters

parent

The parent to use for the help window when it is created.

showHelp [1/3]

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

slot

showHelp [2/3]

void showHelp ( const QString &  keyword )

slot

showHelp [3/3]

void showHelp ( const QUrl &  url )

slot

showTab()

void showTab

(

HelpViewer &

helpPage

)

viewerTitleChanged

void viewerTitleChanged ( HelpViewer *  viewer )

slot