有什么方法可以在pyqt5中显示帮助标签吗?

时间:2020-11-06 10:11:29

标签: python pyqt5

我正在pyqt5中为拼贴项目编写代码,我需要在其中创建一个帮助标签。我正计划像大多数软件一样在内容上提供帮助,如下图所示(onlyoffice的帮助)。有什么办法可以轻松编写它?

enter image description here

1 个答案:

答案 0 :(得分:1)

这种界面的问题在于,它在标题栏中显示了多个“选项卡”,这是因为Qt很难做到这一点,您应该手动实现整个标题栏,而不是 / em>简单。

如果您正在寻找一种更简单的解决方案,我建议您使用一个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()功能来 hack 。当窗口处于“这是什么模式”并且用户单击窗口小部件时,“这是什么”功能允许在一个小的覆盖窗口中显示一些基于上下文的帮助。我们可以使用事件过滤器来检测用户何时单击窗口小部件,并将whatsThis()属性用作显示相关帮助的上下文。

在下面的示例中,我使用的是填充QTextBrowser的简单字典,但是显然您可以使用对本地文档文件甚至Qt Help framework的访问。

请注意,为了使用这种方法,我必须在 all 子窗口小部件上安装事件过滤器,这是因为如果窗口小部件实际上< em>具有一个whatsThis()属性集。诀窍是,当窗口进入此模式时,为 all 所有子窗口小部件设置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()