# 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
__hasChangedFilters | Private method to determine, if there are filter changes.
__initDocumentsTab | Private method to initialize the documents tab.
__initFiltersTab | Private method to initialize the filters tab.
__registerDocumentations | Private method to register a given list of documentations.
__removeAttributes | Private method to remove attributes from the Qt Help database.
getTabsToClose | Public method to get the list of tabs to close.
hasDocumentationChanges | Public slot to test the dialog for changes of configured QtHelp documents.
on_addDocumentsButton_clicked | Private slot to add QtHelp documents to the help database.
on_addFilterButton_clicked | Private slot to add a new filter.
on_addPluginButton_clicked | Private slot to add QtHelp documents provided by plug-ins to the help database.
on_applyFilterChangesButton_clicked | Private slot to apply the filter changes.
on_attributesList_itemChanged | Private slot to handle a change of an attribute.
on_attributesList_itemSelectionChanged | Private slot handling the selection of attributes.
on_documentsList_itemSelectionChanged | Private slot handling a change of the documents selection.
on_filtersList_currentItemChanged | Private slot to update the attributes depending on the current filter.
on_filtersList_itemSelectionChanged | Private slot handling a change of selected filters.
on_managePluginButton_clicked | Private slot to manage the QtHelp documents provided by plug-ins.
on_removeAttributesButton_clicked | Private slot to remove the selected filter attributes.
on_removeDocumentsButton_clicked | Private slot to remove a document from the help database.
on_removeFiltersButton_clicked | Private slot to remove the selected filters.
on_resetFilterChangesButton_clicked | Private slot to forget the filter changes and reset the tab.
on_tabWidget_currentChanged | Private slot handling a change of the current tab.
on_unusedAttributesButton_clicked | Private slot to select all unused attributes.

### Static Methods

None

#### QtHelpDocumentationDialog (Constructor)

QtHelpDocumentationDialog(engine, parent)

Constructor

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

#### QtHelpDocumentationDialog.__hasChangedFilters

__hasChangedFilters()

Private method to determine, if there are filter changes.

Returns:
  flag indicating the presence of filter changes

Return Type:
  bool

#### QtHelpDocumentationDialog.__initDocumentsTab

__initDocumentsTab()

Private method to initialize the documents tab.

#### QtHelpDocumentationDialog.__initFiltersTab

__initFiltersTab()

Private method to initialize the filters tab.

#### 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.__removeAttributes

__removeAttributes()

Private method to remove attributes from the Qt Help database.

#### QtHelpDocumentationDialog.getTabsToClose

getTabsToClose()

Public method to get the list of tabs to close.

Returns:
  list of tab ids to be closed

Return Type:
  list of int

#### QtHelpDocumentationDialog.hasDocumentationChanges

hasDocumentationChanges()

Public slot to test the dialog for changes of configured QtHelp documents.

Returns:
  flag indicating presence of changes

Return Type:
  bool

#### QtHelpDocumentationDialog.on_addDocumentsButton_clicked

on_addDocumentsButton_clicked()

Private slot to add QtHelp documents to the help database.

#### QtHelpDocumentationDialog.on_addFilterButton_clicked

on_addFilterButton_clicked()

Private slot to add a new filter.

#### QtHelpDocumentationDialog.on_addPluginButton_clicked

on_addPluginButton_clicked()

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

#### QtHelpDocumentationDialog.on_applyFilterChangesButton_clicked

on_applyFilterChangesButton_clicked()

Private slot to apply the filter changes.

#### QtHelpDocumentationDialog.on_attributesList_itemChanged

on_attributesList_itemChanged(item, column)

Private slot to handle a change of an attribute.

item
  reference to the changed item (QTreeWidgetItem)
column
  column containing the change (integer)

#### QtHelpDocumentationDialog.on_attributesList_itemSelectionChanged

on_attributesList_itemSelectionChanged()

Private slot handling the selection of attributes.

#### QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged

on_documentsList_itemSelectionChanged()

Private slot handling a change of the documents selection.

#### QtHelpDocumentationDialog.on_filtersList_currentItemChanged

on_filtersList_currentItemChanged(current, previous)

Private slot to update the attributes depending on the current filter.

current
  reference to the current item (QListWidgetitem)
previous
  reference to the previous current item (QListWidgetItem)

#### QtHelpDocumentationDialog.on_filtersList_itemSelectionChanged

on_filtersList_itemSelectionChanged()

Private slot handling a change of selected filters.

#### QtHelpDocumentationDialog.on_managePluginButton_clicked

on_managePluginButton_clicked()

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

#### QtHelpDocumentationDialog.on_removeAttributesButton_clicked

on_removeAttributesButton_clicked()

Private slot to remove the selected filter attributes.

#### QtHelpDocumentationDialog.on_removeDocumentsButton_clicked

on_removeDocumentsButton_clicked()

Private slot to remove a document from the help database.

#### QtHelpDocumentationDialog.on_removeFiltersButton_clicked

on_removeFiltersButton_clicked()

Private slot to remove the selected filters.

#### QtHelpDocumentationDialog.on_resetFilterChangesButton_clicked

on_resetFilterChangesButton_clicked()

Private slot to forget the filter changes and reset the tab.

#### QtHelpDocumentationDialog.on_tabWidget_currentChanged

on_tabWidget_currentChanged(index)

Private slot handling a change of the current tab.

index (int)
  index of the current tab

#### QtHelpDocumentationDialog.on_unusedAttributesButton_clicked

on_unusedAttributesButton_clicked()

Private slot to select all unused attributes.

Up