Module implementing a widget to show some source code information provided by plug-ins.
None |
CodeDocumentationViewer | Class implementing a widget to show some source code information provided by plug-ins. |
DocumentationViewerWidget | Class implementing a rich text documentation viewer. |
None |
Class implementing a widget to show some source code information provided by plug-ins.
None |
None |
CodeDocumentationViewer | Constructor |
__selectProvider | Private method to select a provider programmatically. |
__setupUi | Private method to generate the UI layout. |
__showDisabledMessage | Private method to show a message giving the reason for being disabled. |
__unregisterTimerTimeout | Private slot handling the timeout signal of the unregister timer. |
documentationReady | Public method to provide the documentation info to the viewer. |
finalizeSetup | Public method to finalize the setup of the documentation viewer. |
getProviders | Public method to get a list of providers and their visible strings. |
isEnabled | Public method to check, if the code documentation viewer is enabled. |
isSupportedLanguage | Public method to check, if the given language is supported by the selected provider. |
on_providerComboBox_currentIndexChanged | Private slot to handle the selection of a provider. |
preferencesChanged | Public slot to handle a change of preferences. |
registerProvider | Public method register a source docu provider. |
showInfo | Public method to request code documentation data from a provider. |
shutdown | Public method to perform shutdown actions. |
unregisterProvider | Public method register a source docu provider. |
None |
Constructor
Private method to select a provider programmatically.
Private method to generate the UI layout.
Private method to show a message giving the reason for being disabled.
Private slot handling the timeout signal of the unregister timer.
Public method to provide the documentation info to the viewer.
If documentationInfo is a dictionary, it should contain these (optional) keys and data:
name: the name of the inspected object argspec: its arguments specification note: A phrase describing the type of object (function or method) and the module it belongs to. docstring: its documentation string typ: its type information
Public method to finalize the setup of the documentation viewer.
Public method to get a list of providers and their visible strings.
Public method to check, if the code documentation viewer is enabled.
Public method to check, if the given language is supported by the selected provider.
Private slot to handle the selection of a provider.
Public slot to handle a change of preferences.
Public method register a source docu provider.
Public method to request code documentation data from a provider.
Public method to perform shutdown actions.
Public method register a source docu provider.
Class implementing a rich text documentation viewer.
EmpytDocument_Dark |
EmpytDocument_Light |
None |
DocumentationViewerWidget | Constructor |
__showLink | Private slot to show the hovered link in a tooltip. |
clear | Public method to clear the shown contents. |
setHtml | Public method to set the HTML text of the widget. |
None |
Constructor
Private slot to show the hovered link in a tooltip.
Public method to clear the shown contents.
Public method to set the HTML text of the widget.