# `taurus.qt.qtgui.help`

This package contains a collection of taurus Qt widgets that provide a way to browse through the application help system

Classes

class AboutDialog(parent=None)

  Simple dialog to display typical About <application> dialog. It will create a Dialog with the title being Dialog + <app name> and a default text combining the application name and version, organization name and domain.

  This behaviour can be changed by setting the dialog window title (`setWindowTitle()`) and content (`setText()`, `setHtml()`)

  Example usage:

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

      app = Qt.QApplication([])
      app.setApplicationName("Example GUI")
      app.setApplicationVersion("1.2.3")
      app.setOrganizationName("Taurus")
      app.setOrganizationDomain("http://www.taurus-scada.org/")
      about_dialog = AboutDialog()
      pixmap = Qt.QIcon.fromTheme("folder-open").pixmap(64, 64)
      about_dialog.setPixmap(pixmap)
      about_dialog.exec_()

  (more info)

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_()

  (more info)

class Widgets

  (more info)

Functions

Assistant(collection_file, auto_create=True, parent=None)

  The `Assistant()` will create a subprocess displaying the help system for the given QtHelp collection file (.qhc). Example usage:

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

      app = Qt.QApplication([])
      qas = Assistant("my_app_help.qhc")
      qas.start()
      app.exec_()