Module implementing an embedded viewer for QtHelp and local HTML files.
WEBENGINE_AVAILABLE |
HelpViewerWidget | Class implementing an embedded viewer for QtHelp and local HTML files. |
None |
Class implementing an embedded viewer for QtHelp and local HTML files.
EmpytDocument_Dark |
EmpytDocument_Light |
MaxHistoryItems |
emptyDocument | Class method to get the HTML code for an empty page. |
HelpViewerWidget | Constructor |
__activateCurrentPage | Private slot to activate the current page. |
__addNavigationButton | Private method to create and add a navigation button. |
__addNewPage | Private slot to add a new empty page. |
__backward | Private slot to move one page backward. |
__checkActionButtons | Private slot to set the enabled state of the action buttons. |
__clearHistory | Private slot to clear the history of the current viewer. |
__configureHelpDocumentation | Private slot to open the Help Documentation configuration page. |
__currentFilterChanged | Private slot handling a change of the active QtHelp filter. |
__currentPageChanged | Private slot handling the selection of another page. |
__docsInstalled | Private slot handling the end of documentation installation. |
__filterQtHelpDocumentation | Private slot to filter the QtHelp documentation. |
__forward | Private slot to move one page foreward. |
__getQtHelpCollectionFileName | Private method to determine the name of the QtHelp collection file. |
__helpTopicSelected | Private slot handling the selection of a new help topic. |
__indexingFinished | Private slot handling the end of the indexing process. |
__indexingStarted | Private slot handling the start of the indexing process. |
__initActionsMenu | Private method to initialize the actions menu. |
__initFilterWidget | Private method to initialize the filter selection widget. |
__initHelpEngine | Private method to initialize the QtHelp related stuff. |
__initIndexingProgress | Private method to initialize the help documents indexing progress widget. |
__initQWebEngine | Private method to initialize global QWebEngine related objects. |
__initQWebEngineSettings | Private method to set the global web settings. |
__lookForNewDocumentation | Private slot to look for new documentation to be loaded into the help database. |
__manageQtHelpDocuments | Private slot to manage the QtHelp documentation database. |
__navigationMenuActionTriggered | Private slot to go to the selected page. |
__newViewer | Private method to create a new help viewer. |
__openFile | Private slot to open a local help file (*.html). |
__populateHelpSelector | Private method to populate the help selection combo box. |
__populateNavigationStack | Private method to populate the stack of navigation widgets. |
__reload | Private slot to reload the current page. |
__removeOldDocumentation | Private slot to remove non-existing documentation from the help engine. |
__searchWidgetClosed | Private slot to handle the closing of the search widget. |
__selectNavigationWidget | Private slot to select the navigation widget. |
__setupFilterCombo | Private slot to setup the filter combo box. |
__showBackMenu | Private slot showing the backward navigation menu. |
__showForwardMenu | Private slot showing the forward navigation menu. |
__showInstallationError | Private slot to show installation errors. |
__warning | Private slot handling warnings of the help engine. |
__zoomIn | Private slot to zoom in. |
__zoomOut | Private slot to zoom out. |
__zoomReset | Private slot to reset the zoom level. |
activate | Public method to activate the widget and search for a given word. |
addPage | Public method to add a new help page with the given URL. |
bookmarkPage | Public method to bookmark a page with the given data. |
closeAllPages | Public slot to close all pages. |
closeCurrentPage | Public slot to close the current page. |
closeOtherPages | Public slot to close all other pages. |
currentViewer | Public method to get the active viewer. |
openPagesCount | Public method to get the count of open pages. |
openUrl | Public slot to load a URL in the current page. |
openUrlNewBackgroundPage | Public slot to load a URL in a new background page. |
openUrlNewPage | Public slot to load a URL in a new page. |
searchNext | Public slot to find the next occurrence of the current search term. |
searchPrev | Public slot to find the previous occurrence of the current search term. |
searchQtHelp | Public slot to search for a given search expression. |
showHideSearch | Public slot to show or hide the search widget. |
shutdown | Public method to perform shut down actions. |
webProfile | Public method to get a reference to the global web profile object. |
webSettings | Public method to get the web settings of the current profile. |
None |
Class method to get the HTML code for an empty page.
Constructor
Private slot to activate the current page.
Private method to create and add a navigation button.
Private slot to add a new empty page.
Private slot to move one page backward.
Private slot to set the enabled state of the action buttons.
Private slot to clear the history of the current viewer.
Private slot to open the Help Documentation configuration page.
Private slot handling a change of the active QtHelp filter.
Private slot handling the selection of another page.
Private slot handling the end of documentation installation.
Private slot to filter the QtHelp documentation.
Private slot to move one page foreward.
Private method to determine the name of the QtHelp collection file.
Private slot handling the selection of a new help topic.
Private slot handling the end of the indexing process.
Private slot handling the start of the indexing process.
Private method to initialize the actions menu.
Private method to initialize the filter selection widget.
Private method to initialize the QtHelp related stuff.
Private method to initialize the help documents indexing progress widget.
Private method to initialize global QWebEngine related objects.
Private method to set the global web settings.
Private slot to look for new documentation to be loaded into the help database.
Private slot to manage the QtHelp documentation database.
Private slot to go to the selected page.
Private method to create a new help viewer.
Private slot to open a local help file (*.html).
Private method to populate the help selection combo box.
Private method to populate the stack of navigation widgets.
Private slot to reload the current page.
Private slot to remove non-existing documentation from the help engine.
Private slot to handle the closing of the search widget.
Private slot to select the navigation widget.
Private slot to setup the filter combo box.
Private slot showing the backward navigation menu.
Private slot showing the forward navigation menu.
Private slot to show installation errors.
Private slot handling warnings of the help engine.
Private slot to zoom in.
Private slot to zoom out.
Private slot to reset the zoom level.
Public method to activate the widget and search for a given word.
Public method to add a new help page with the given URL.
Public method to bookmark a page with the given data.
Public slot to close all pages.
Public slot to close the current page.
Public slot to close all other pages.
Public method to get the active viewer.
Public method to get the count of open pages.
Public slot to load a URL in the current page.
Public slot to load a URL in a new background page.
Public slot to load a URL in a new page.
Public slot to find the next occurrence of the current search term.
Public slot to find the previous occurrence of the current search term.
Public slot to search for a given search expression.
Public slot to show or hide the search widget.
Public method to perform shut down actions.
Public method to get a reference to the global web profile object.
Public method to get the web settings of the current profile.