eric6.WebBrowser.QtHelp.QtHelpDocumentationDialog

Module implementing a dialog to manage the QtHelp documentation database.

Global Attributes

None

Classes

QtHelpDocumentationDialog Class implementing a dialog to manage the QtHelp documentation database.

Functions

None


QtHelpDocumentationDialog

Class implementing a dialog to manage the QtHelp documentation database.

Derived from

QDialog, Ui_QtHelpDocumentationDialog

Class Attributes

None

Class Methods

None

Methods

QtHelpDocumentationDialog Constructor
__registerDocumentations Private method to register a given list of documentations.
getTabsToClose Public method to get the list of tabs to close.
hasChanges Public slot to test the dialog for changes.
on_addButton_clicked Private slot to add QtHelp documents to the help database.
on_addPluginButton_clicked Private slot to add QtHelp documents provided by plug-ins to the help database.
on_documentsList_itemSelectionChanged Private slot handling a change of the documents selection.
on_managePluginButton_clicked Private slot to manage the QtHelp documents provided by plug-ins.
on_removeButton_clicked Private slot to remove a document from the help database.

Static Methods

None

QtHelpDocumentationDialog (Constructor)

QtHelpDocumentationDialog(engine, parent)

Constructor

engine
reference to the help engine (QHelpEngine)
parent
reference to the parent widget (QWidget)

QtHelpDocumentationDialog.__registerDocumentations

__registerDocumentations(fileNames)

Private method to register a given list of documentations.

fileNames (list of str)
list of documentation files to be registered

QtHelpDocumentationDialog.getTabsToClose

getTabsToClose()

Public method to get the list of tabs to close.

Returns:
list of tab ids to be closed (list of integers)

QtHelpDocumentationDialog.hasChanges

hasChanges()

Public slot to test the dialog for changes.

Returns:
flag indicating presence of changes

QtHelpDocumentationDialog.on_addButton_clicked

on_addButton_clicked()

Private slot to add QtHelp documents to the help database.

QtHelpDocumentationDialog.on_addPluginButton_clicked

on_addPluginButton_clicked()

Private slot to add QtHelp documents provided by plug-ins to the help database.

QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged

on_documentsList_itemSelectionChanged()

Private slot handling a change of the documents selection.

QtHelpDocumentationDialog.on_managePluginButton_clicked

on_managePluginButton_clicked()

Private slot to manage the QtHelp documents provided by plug-ins.

QtHelpDocumentationDialog.on_removeButton_clicked

on_removeButton_clicked()

Private slot to remove a document from the help database.

Up