有没有办法在pyqt5中显示帮助选项卡？

Question

我正在 pyqt5 中为我的拼贴项目编写代码，我需要在其中制作一个帮助选项卡。 我计划在内容方面提供帮助，因为大多数软件都如下图所示（onlyoffice 的帮助）。 有什么方法可以轻松写出来吗？

Answer 1

这种在标题栏中显示多个“选项卡”的界面的问题在于，使用 Qt 不容易实现，您应该手动实现整个标题栏，这并不容易。

如果您正在寻找更简单的解决方案，我建议您使用 QTabWidget，如果只有一个选项卡，则不显示选项卡栏。 如果您还没有使用带有可关闭选项卡的选项卡式界面，您可以将选项卡小部件设置为允许可关闭选项卡并覆盖默认方法，以便在不需要时隐藏关闭按钮。

class TabWidget(QtWidgets.QTabWidget):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.setDocumentMode(True)
        self.setTabsClosable(True)
        self.tabCloseRequested.connect(self.removeTab)
        self.tabBar().hide()

    def addTab(self, *args, **kwargs):
        self.insertTab(-1, *args, **kwargs)

    def insertTab(self, *args, **kwargs):
        super().insertTab(*args)
        closable = kwargs.get('closable', False)
        if not closable:
            index = args[0]
            if index < 0:
                index = self.count() - 1
            for side in QtWidgets.QTabBar.LeftSide, QtWidgets.QTabBar.RightSide:
                widget = self.tabBar().tabButton(index, side)
                if isinstance(widget, QtWidgets.QAbstractButton):
                    self.tabBar().setTabButton(index, side, None)
                    break
        self.tabBar().setVisible(self.count() > 1)

    def removeTab(self, index):
        super().removeTab(index)
        self.tabBar().setVisible(self.count() > 1)


class MainWindow(QtWidgets.QMainWindow):
    def __init__(self):
        super().__init__()
        self.tabWidget = TabWidget()
        self.setCentralWidget(self.tabWidget)

        self.main = QtWidgets.QWidget()
        self.tabWidget.addTab(self.main, 'My program')
        layout = QtWidgets.QGridLayout(self.main)

        someButton = QtWidgets.QPushButton('Some button')
        layout.addWidget(someButton, 0, 0)

        layout.addWidget(QtWidgets.QLabel('Some label'), 0, 1)

        helpButton = QtWidgets.QPushButton('Show help!')
        layout.addWidget(helpButton, 0, 2)

        textEdit = QtWidgets.QTextEdit()
        layout.addWidget(textEdit, 1, 0, 1, 3)

        self.helpTab = QtWidgets.QTextBrowser()
        self.helpTab.setHtml('Hello, this is <b>help</b>!')

        helpButton.clicked.connect(self.showHelp)

    def showHelp(self):
        for i in range(self.tabWidget.count()):
            if self.tabWidget.widget(i) == self.helpTab:
                break
        else:
            self.tabWidget.addTab(self.helpTab, 'Help!', closable=True)
        self.tabWidget.setCurrentWidget(self.helpTab)
        self.tabWidget.tabBar().show()

现在，由于您还需要一些基于上下文的帮助，您可以通过whatsThis()功能进行破解。 当窗口处于“这是什么模式”并且用户单击小部件时，“这是什么”功能允许在覆盖的小窗口中显示一些基于上下文的帮助。 我们可以使用事件过滤器来检测用户何时单击小部件并使用whatsThis()属性作为显示相关帮助的上下文。

在下面的示例中，我使用了一个填充 QTextBrowser 的简单字典，但您显然可以使用对本地文档文件甚至Qt 帮助框架的访问。

请注意，为了使用这种方法，我必须在所有子小部件上安装一个事件过滤器，这是因为如果小部件实际上具有whatsThis()属性集，Qt 能够对“这是什么”事件做出反应。 诀窍是在窗口进入what's this 模式时为所有子小部件设置一个whatsThis属性，并在每个小部件上安装一个专门的事件过滤器，然后在剩下这个模式时立即卸载事件过滤器。

NoWhatsThisText = '__NoWhatsThis'
NoWhatsThisValue = 'There is no help for this object'
HelpData = {
    NoWhatsThisText: NoWhatsThisValue, 
    'someButton': 'Do something with the button', 
    'helpButton': 'Click the button to show this help', 
    'textEdit': 'Type <b>some text</b> to <i>read</i> it', 
    'mainWindow': 'A main window is cool!', 
}

class WhatsThisWatcher(QtCore.QObject):
    whatsThis = QtCore.pyqtSignal(str)
    def eventFilter(self, source, event):
        if event.type() == QtCore.QEvent.WhatsThis:
            whatsThis = source.whatsThis()
            while whatsThis == NoWhatsThisText:
                if not source.parent():
                    break
                source = source.parent()
                whatsThis = source.whatsThis()
            self.whatsThis.emit(whatsThis)
            event.accept()
            return True
        return super().eventFilter(source, event)


class MainWindow(QtWidgets.QMainWindow):
    def __init__(self):
        # ...

        whatsThisAction = self.menuBar().addAction('What\'s this?')
        whatsThisAction.triggered.connect(
            QtWidgets.QWhatsThis.enterWhatsThisMode)

        self.watchedWhatsThis = []
        self.whatsThisWatcher = WhatsThisWatcher()
        self.whatsThisWatcher.whatsThis.connect(self.showHelp)
        self.installEventFilter(self.whatsThisWatcher)

        someButton.setWhatsThis('someButton')
        helpButton.setWhatsThis('helpButton')
        textEdit.setWhatsThis('textEdit')
        self.setWhatsThis('mainWindow')

    def showHelp(self, context=''):
        # ...
        if context:
            self.helpTab.setHtml(HelpData.get(context, NoWhatsThisValue))
        if QtWidgets.QWhatsThis.inWhatsThisMode():
            QtWidgets.QWhatsThis.leaveWhatsThisMode()