eric: comparison UI/CodeDocumentationViewer.py

-:7ab2293917f8
+:e44c04a89dbc
 from E5Gui.E5ToolButton import E5ToolButton
 import Preferences
 import UI.PixmapCache
+from .CodeDocumentationViewerTemplate import \
+prepareDocumentationViewerHtmlDocument, \
+prepareDocumentationViewerHtmlWarningDocument
+from .data import codeDocumentationViewer_rc    # __IGNORE_WARNING__
 class PlainTextDocumentationViewer(QWidget):
 """
 Class implementing the plain text documentation viewer.
 """
 self.__verticalLayout.setContentsMargins(0, 0, 0, 0)
 self.__contents = QTextEdit(self)
 self.__contents.setTabChangesFocus(True)
 self.__contents.setReadOnly(True)
+self.__contents.setLineWrapMode(QTextEdit.NoWrap)
 self.__contents.setObjectName("contents")
 self.__verticalLayout.addWidget(self.__contents)
 self.__searchWidget = E5TextEditSearchWidget(self)
 self.__searchWidget.setFocusPolicy(Qt.WheelFocus)
 self.__verticalLayout = QVBoxLayout(self)
 self.__verticalLayout.setObjectName("verticalLayout")
 self.__verticalLayout.setContentsMargins(0, 0, 0, 0)
 try:
-from PyQt5.QtWebEngineWidgets import QWebEngineView
+from PyQt5.QtWebEngineWidgets import QWebEngineView, \
+QWebEngineSettings
 self.__contents = QWebEngineView(self)
 self.__contents.page().linkHovered.connect(self.__showLink)
+try:
+self.__contents.settings().setAttribute(
+QWebEngineSettings.FocusOnNavigationEnabled, False)
+except AttributeError:
+# pre Qt 5.8
+pass
 self.__usesWebKit = False
 except ImportError:
 from PyQt5.QtWebKitWidgets import QWebPage, QWebView
 self.__contents = QWebView(self)
 self.__contents.page().setLinkDelegationPolicy(
 Public method to set the HTML text of the widget.
 @param html HTML text to be shown
 @type str
 """
+self.__contents.setEnabled(False)
 self.__contents.setHtml(html)
+self.__contents.setEnabled(True)
 def clear(self):
 """
 Public method to clear the shown contents.
 """
 self.__shuttingDown = False
 self.__startingUp = True
 self.__lastDocumentation = None
+self.__requestingEditor = None
 self.__noDocumentationString = self.tr("No documentation available")
 self.__disabledString = self.tr(
 "No source code documentation provider has been registered or"
 " this function has been disabled.")
 self.__plainTextViewer.clear()
 self.__richTextViewer.clear()
 self.__providers[self.__selectedProvider][0](editor)
 # TODO: document this hook in the plug-in document
-def documentationReady(self, documentationInfo):
+def documentationReady(self, documentationInfo, isWarning=False):
 """
 Public method to provide the documentation info to the viewer.
 If documentationInfo is a dictionary, it should contains these keys
 and data:
 the module it belongs to.
 docstring: its documentation string
 @param documentationInfo dictionary containing the source docu data
 @type dict or str
+@param isWarning flag indicating a warning page
+@type bool
 """
 self.__ui.activateCodeDocumentationViewer(switchFocus=False)
 self.__lastDocumentation = documentationInfo
 if documentationInfo is not None:
 if not documentationInfo:
 if self.__selectedProvider == self.__disabledProvider:
-fullText = self.__disabledString
+self.documentationReady(self.__disabledString,
+isWarning=True)
 else:
-fullText = self.__noDocumentationString
+self.documentationReady(self.__noDocumentationString,
-elif isinstance(documentationInfo, str):
+isWarning=True)
+return
+if self.__showMarkdown:
+if isWarning:
+html = prepareDocumentationViewerHtmlWarningDocument(
+documentationInfo)
+elif isinstance(documentationInfo, dict):
+html = prepareDocumentationViewerHtmlDocument(
+documentationInfo)
+else:
+html = ""
+if html:
+self.__setHtml(html)
+return
+if isinstance(documentationInfo, str):
 fullText = documentationInfo
 elif isinstance(documentationInfo, dict):
-# format the text with markdown syntax
 name = documentationInfo["name"]
 if name:
 title = "".join([name, "\n",
 "=" * len(name), "\n\n"])
 else:
 title = ""
 if documentationInfo["argspec"]:
-if self.__showMarkdown:
+definition = self.tr("Definition: {0}{1}\n").format(
-definition = self.tr(
+name, documentationInfo["argspec"])
-"**Definition**: {0}{1}\n",
-"string with markdown syntax").format(
-name, documentationInfo["argspec"])
-else:
-definition = self.tr(
-"Definition: {0}{1}\n",
-"string as plain text").format(
-name, documentationInfo["argspec"])
 else:
 definition = ''
 if documentationInfo["note"]:
-if self.__showMarkdown:
+note = self.tr("Info: {0}\n\n----\n\n").format(
-note = self.tr(
+documentationInfo["note"])
-"**Info**: {0}\n\n----\n\n",
-"string with markdown syntax").format(
-documentationInfo["note"])
-else:
-note = self.tr(
-"Info: {0}\n\n----\n\n",
-"string as plain text").format(
-documentationInfo["note"])
 else:
 note = ""
 if documentationInfo["docstring"] is None:
 docString = ""
 self.__richTextViewer.clear()
 self.objectLineEdit.clear()
 provider = self.providerComboBox.itemData(index)
 if provider == self.__disabledProvider:
-self.documentationReady(self.__disabledString)
+self.documentationReady(self.__disabledString, isWarning=True)
 else:
 self.__lastDocumentation = None
 Preferences.setDocuViewer("Provider", provider)
 self.__selectedProvider = provider

Mercurial Repositories > eric / file comparison

comparison: UI/CodeDocumentationViewer.py

UI/CodeDocumentationViewer.py