【Qt】解决设置QPlainTextEdit控件的Tab为4个空格

前言

PyQt5 是一个用于创建跨平台桌面应用程序的 Python 绑定集合，它提供了对 Qt 应用程序框架的访问。用于开发具有图形用户界面（GUI）的应用程序，以及非GUI程序。PyQt5 使得 Python 开发者可以使用 Qt 的丰富功能来构建应用程序。QPlainTextEdit 是 Qt 框架中的一个纯文本编辑器控件，它提供了一个高级的文本编辑和显示功能，专门用于处理纯文本数据。

使用QPlainTextEdit可作为文本显示控件，支持显示与编辑的功能，但是在编辑过程中遇到问题是，当键入Tab时，或者使用制表符(\t)显示文本内容时会发现，QPlainTextEdit控件中对于Tab或者制表符默认为8个空格键，而我们期望的是4个空格键。

接下来，我将展示三种不同的方法来应对前述问题：

（1）自定义Tab的宽度

QPlainTextEdit控件中包含两个对Tab属性进行设置的函数，分别是setTabStopWidth和setTabStopDistance方法，这两个方法都是设置Tab字符的宽度，单位是像素，两个函数共两个不同点：

1、setTabStopWidth方法参数是整型，setTabStopDistance方法参数为浮点型。

2、setTabStopWidth方法已经过时，建议使用setTabStopDistance函数替代。

官方文档中对此两个方法的说明如下：

      下面示例函数将设置QPlainTextEdit控件的Tab字符设置为40pix。

from PyQt5.QtWidgets import QApplication, QMainWindow
from untitled import Ui_MainWindow
import sys


class MainUi(QMainWindow, Ui_MainWindow):
    def __init__(self):
        super(MainUi, self).__init__()
        self.setupUi(self)
        # self.plainTextEdit.setTabStopWidth(40)
        self.plainTextEdit.setTabStopDistance(40)
        self.plainTextEdit.setPlainText("\t1\t2\t3\t4\t5\t6\t")


if __name__ == '__main__':
    app = QApplication(sys.argv)
    ui = MainUi()
    ui.show()
    sys.exit(app.exec_())

下面是程序运行后，我们可以看到Tab键使得字符之间间隔约40pix。

缺点：此方案缺点是Tab字符宽度完全为用户自定义，QPlainTextEdit控件中文本字体大小不同，Tab字符宽度是不同的，因此此方案缺乏灵活性。

（2）自动设置Tab宽度

方法（1）中的缺陷就是忽略了Tab字符的宽度应该与QPlainTextEdit中文本字体大小相一致。因此本方法在方法（1）的基础上通过获取控件中文本字体的大小，并计算4个空格的宽度进行赋值。

from PyQt5.QtWidgets import QApplication, QMainWindow
from PyQt5.QtGui import QFont, QFontMetrics
from untitled import Ui_MainWindow
import sys


class MainUi(QMainWindow, Ui_MainWindow):
    def __init__(self):
        super(MainUi, self).__init__()
        self.setupUi(self)

        self.setFont(QFont("Arial", 10))  # 设置字体和大小
        # self.plainTextEdit.setTabStopWidth(40)
        # self.plainTextEdit.setTabStopDistance(40)
        self.plainTextEdit.setTabStopDistance(4 * self.spaceWidth())
        self.plainTextEdit.setPlainText("\t1\t2\t3\t4\t5\t6\t")
        print(self.spaceWidth())

    def spaceWidth(self):
        font_metrics = QFontMetrics(self.font())
        return font_metrics.width(' ')  # 获取单个空格的宽度


if __name__ == '__main__':
    app = QApplication(sys.argv)
    ui = MainUi()
    ui.show()
    sys.exit(app.exec_())

缺点：此方法虽然可以使Tab根据控件中文本字体大小自动计算Tab字符宽度，缺点就是我们想要的Tab为4个空格，而实际确是1个字符。

（3）自定义QPlainTextEdit控件

此方法我认为是解决Tab为4个空格最彻底的方法，虽然较上面两种方法复杂，但是效果很好。

第一步：重写QPlainTextEdit控件的keyPressEvent方法。当检测到Tab事件时替换成4个空格：

第二步：重写QPlainTextEdit控件的setPlainText方法，利用python字符串的expandtabs方法，将python字符串中\t换成指定数量的空格。

class MyPlainTextEdit(QPlainTextEdit):
    def __init__(self, parent=None):
        super(MyPlainTextEdit, self).__init__(parent)

    def keyPressEvent(self, event):
        if event.key() == Qt.Key_Tab:
            # 插入4个空格
            cursor = self.textCursor()
            cursor.insertText('    ')
            self.setTextCursor(cursor)
        else:
            super(MyPlainTextEdit, self).keyPressEvent(event)

    def setPlainText(self, text: str) -> None:
        super(MyPlainTextEdit, self).setPlainText(text.expandtabs(4))


class MainUi(QMainWindow, Ui_MainWindow):
    def __init__(self):
        super(MainUi, self).__init__()
        self.setupUi(self)
        self.setWindowTitle('')
        self.plainTextEdit = MyPlainTextEdit()
        layout = QVBoxLayout()
        layout.addWidget(self.plainTextEdit)
        self.frame.setLayout(layout)
        self.plainTextEdit.setPlainText("\t1\t2\t3\t4\t5\t6\t")


if __name__ == '__main__':
    app = QApplication(sys.argv)
    ui = MainUi()
    ui.show()
    sys.exit(app.exec_())

 此方法完美解决Tab和制表符替换成4个空格符。