# `HelpPanel`

digraph inheritancee91e3ba398 { bgcolor=transparent; rankdir=UD; ratio=compress; size="8.0, 12.0"; "HelpPanel" [URL="#taurus.qt.qtgui.help.HelpPanel",color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded,target="_top",tooltip="Simple widget to display application help system. Usage::"]; "QWidget" -> "HelpPanel" [arrowsize=0.5,style="setlinewidth(0.5)"]; "QObject" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded,tooltip="QObject(parent: QObject|None = None)"]; "wrapper" -> "QObject" [arrowsize=0.5,style="setlinewidth(0.5)"]; "QPaintDevice" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded,tooltip="QPaintDevice()"]; "simplewrapper" -> "QPaintDevice" [arrowsize=0.5,style="setlinewidth(0.5)"]; "QWidget" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded,tooltip="QWidget(parent: QWidget|None = None, flags: Qt.WindowFlags|Qt.WindowType = Qt.WindowFlags())"]; "QObject" -> "QWidget" [arrowsize=0.5,style="setlinewidth(0.5)"]; "QPaintDevice" -> "QWidget" [arrowsize=0.5,style="setlinewidth(0.5)"]; "simplewrapper" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded]; "wrapper" [color=dodgerblue1,fillcolor=white,fontcolor=black,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.5,shape=box,style=rounded]; "simplewrapper" -> "wrapper" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

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)