Mercurial Repositories > eric / file comparison
comparison: UI/CodeDocumentationViewer.py
UI/CodeDocumentationViewer.py
- changeset 5925
- 0174aece0923
- parent 5924
- 85e126ab4ca5
- child 5959
- 4c716b02e10d
equal
deleted
inserted
replaced
| 5924:85e126ab4ca5 | 5925:0174aece0923 |
|---|---|
| 209 self.__startingUp = True | 209 self.__startingUp = True |
| 210 | 210 |
| 211 self.__lastDocumentation = None | 211 self.__lastDocumentation = None |
| 212 self.__requestingEditor = None | 212 self.__requestingEditor = None |
| 213 | 213 |
| 214 self.__noDocumentationString = self.tr("No documentation available") | |
| 215 self.__disabledString = self.tr( | |
| 216 "No source code documentation provider has been registered or" | |
| 217 " this function has been disabled.") | |
| 218 | 214 |
| 219 def __setupUi(self): | 215 def __setupUi(self): |
| 220 """ | 216 """ |
| 221 Private method to generate the UI layout. | 217 Private method to generate the UI layout. |
| 222 """ | 218 """ |
| 311 index = 0 | 307 index = 0 |
| 312 provider = self.__disabledProvider | 308 provider = self.__disabledProvider |
| 313 self.providerComboBox.setCurrentIndex(index) | 309 self.providerComboBox.setCurrentIndex(index) |
| 314 self.__selectedProvider = provider | 310 self.__selectedProvider = provider |
| 315 if index == 0: | 311 if index == 0: |
| 316 self.documentationReady(self.__disabledString, isWarning=True) | 312 self.__showDisabledMessage() |
| 317 | 313 |
| 318 # TODO: document this hook in the plug-in document | 314 # TODO: document this hook in the plug-in document |
| 319 def registerProvider(self, providerName, providerDisplay, provider, | 315 def registerProvider(self, providerName, providerDisplay, provider, |
| 320 supported): | 316 supported): |
| 321 """ | 317 """ |
| 438 if not isWarning and not isDocWarning: | 434 if not isWarning and not isDocWarning: |
| 439 self.__lastDocumentation = documentationInfo | 435 self.__lastDocumentation = documentationInfo |
| 440 | 436 |
| 441 if not documentationInfo: | 437 if not documentationInfo: |
| 442 if self.__selectedProvider == self.__disabledProvider: | 438 if self.__selectedProvider == self.__disabledProvider: |
| 443 self.documentationReady(self.__disabledString, | 439 self.__showDisabledMessage() |
| 444 isWarning=True) | |
| 445 else: | 440 else: |
| 446 self.documentationReady(self.__noDocumentationString, | 441 self.documentationReady(self.tr("No documentation available"), |
| 447 isDocWarning=True) | 442 isDocWarning=True) |
| 448 else: | 443 else: |
| 449 if self.__showMarkdown: | 444 if self.__showMarkdown: |
| 450 if isWarning: | 445 if isWarning: |
| 451 html = prepareDocumentationViewerHtmlWarningDocument( | 446 html = prepareDocumentationViewerHtmlWarningDocument( |
| 489 | 484 |
| 490 fullText = "".join([title, definition, note, docString]) | 485 fullText = "".join([title, definition, note, docString]) |
| 491 | 486 |
| 492 self.__plainTextViewer.setText(fullText) | 487 self.__plainTextViewer.setText(fullText) |
| 493 | 488 |
| 489 def __showDisabledMessage(self): | |
| 490 """ | |
| 491 Private method to show a message giving the reason for being disabled. | |
| 492 """ | |
| 493 if len(self.__providers) == 0: | |
| 494 self.documentationReady( | |
| 495 self.tr("No source code documentation provider has been" | |
| 496 " registered. This function has been disabled."), | |
| 497 isWarning=True) | |
| 498 else: | |
| 499 self.documentationReady( | |
| 500 self.tr("This function has been disabled."), | |
| 501 isWarning=True) | |
| 502 | |
| 494 def __setHtml(self, html): | 503 def __setHtml(self, html): |
| 495 """ | 504 """ |
| 496 Private slot to set the prepared HTML text. | 505 Private slot to set the prepared HTML text. |
| 497 | 506 |
| 498 @param html prepared HTML text | 507 @param html prepared HTML text |
| 523 self.__richTextViewer.clear() | 532 self.__richTextViewer.clear() |
| 524 self.objectLineEdit.clear() | 533 self.objectLineEdit.clear() |
| 525 | 534 |
| 526 provider = self.providerComboBox.itemData(index) | 535 provider = self.providerComboBox.itemData(index) |
| 527 if provider == self.__disabledProvider: | 536 if provider == self.__disabledProvider: |
| 528 self.documentationReady(self.__disabledString, isWarning=True) | 537 self.__showDisabledMessage() |
| 529 else: | 538 else: |
| 530 self.__lastDocumentation = None | 539 self.__lastDocumentation = None |
| 531 | 540 |
| 532 Preferences.setDocuViewer("Provider", provider) | 541 Preferences.setDocuViewer("Provider", provider) |
| 533 self.__selectedProvider = provider | 542 self.__selectedProvider = provider |
