HelpPanel

class HelpPanel(collection_file=None, parent=None)

Simple widget to display application help system. Usage:

from taurus.external.qt import Qt
from taurus.qt.qtgui.help import HelpPanel

app = Qt.QApplication([])
help_panel = HelpPanel()

help_panel.setCollectionFile("help_file.qhc")
help_panel.show()
app.exec_()

Import from taurus.qt.qtgui.help as:

from taurus.qt.qtgui.help import HelpPanel

collectionFile

This property holds the current collection file name

Access functions:

• HelpPanel.getCollectionFile()

• HelpPanel.setCollectionFile()

• HelpPanel.resetCollectionFile()

getCollectionFile()

Returns the name of the current collection file or empty string if no collection file is active

Returns:

the name of the current collection file

Return type:

str

classmethod getQtDesignerPluginInfo()

resetCollectionFile()

Resets the collection file

setCollectionFile(collection_file)

Displays the help from the specified collection file

Parameters:

collection_file (str) – the collection file name (.qhc)