PyQt5中Plain Text Edit的常用方法和常用信号

1. 简介

QPlainTextEdit是PyQt5中的一个用于显示和编辑纯文本的组件，相比于QTextEdit，它更适用于大型文本的显示和编辑，因为它不支持富文本和HTML格式，所以在渲染大量文本时通常更高效。

QPlainTextEdit的特点：

1. 纯文本编辑：QPlainTextEdit用于纯文本的编辑和显示，不支持富文本和HTML格式，因此更适合用于纯文本文档的编辑和显示。
2. 高效渲染：相对于QTextEdit，QPlainTextEdit在显示大量文本时通常更高效，因为它不需要处理富文本和HTML格式。
3. 支持大型文本：由于它的高效性，QPlainTextEdit适用于显示和编辑大型文本文档，如日志文件、源代码等。
4. 定制化：尽管不支持富文本和HTML格式，但你仍然可以通过设置字体、颜色、样式等属性来定制QPlainTextEdit的外观和行为。

1.1 常用方法：

• setPlainText(text: str): 设置纯文本内容。

  plainTextEdit.setPlainText("Hello, PyQt5!")
  

• toPlainText() -> str: 获取纯文本内容。

  text = plainTextEdit.toPlainText()
  

• clear(): 清除文本内容。

  plainTextEdit.clear()
  

• insertPlainText(text: str): 在光标位置插入纯文本。

  plainTextEdit.insertPlainText("Inserted Text")
  

• selectAll(): 选择所有文本。

  plainTextEdit.selectAll()
  

1.2 常用信号：

• cursorPositionChanged(cursor: QTextCursor): 当光标位置发生变化时发射，传递当前光标的QTextCursor对象。

  plainTextEdit.cursorPositionChanged.connect(handleCursorPositionChanged)
  

• textChanged(): 当文本内容发生改变时发射。

  plainTextEdit.textChanged.connect(handleTextChanged)
  

• copyAvailable(available: bool): 当有文本可复制时发射，传递一个布尔值指示是否可以复制。

  plainTextEdit.copyAvailable.connect(handleCopyAvailable)
  

• redoAvailable(available: bool): 当可以执行重做操作时发射，传递一个布尔值指示是否可以重做。

  plainTextEdit.redoAvailable.connect(handleRedoAvailable)
  

• undoAvailable(available: bool): 当可以执行撤销操作时发射，传递一个布尔值指示是否可以撤销。

  plainTextEdit.undoAvailable.connect(handleUndoAvailable)
  

QPlainTextEdit与QTextEdit的不同之处在于它专注于显示和编辑纯文本，因此在处理大量纯文本时可能更高效。

2. Plain Text Edit常用方法使用案例

我们用下面一个例子演示使用QPlainTextEdit的常用方法

import sys
from PyQt5.QtWidgets import QApplication, QPlainTextEdit, QVBoxLayout, QWidget, QPushButton, QLabel, QLineEdit, QHBoxLayout

class PlainTextEditExample(QWidget):
    def __init__(self):
        super().__init__()
        self.initUI()

    def initUI(self):
        # 设置窗口标题和大小
        self.setWindowTitle("Plain Text Edit Example")
        self.resize(400, 300)

        # 创建 QPlainTextEdit 实例
        self.plainTextEdit = QPlainTextEdit(self)

        # 创建按钮用于演示一些常用方法
        self.button1 = QPushButton("Insert Text", self)
        self.button1.clicked.connect(self.insert_text)

        self.button2 = QPushButton("Clear Text", self)
        self.button2.clicked.connect(self.clear_text)

        self.button3 = QPushButton("Get Text", self)
        self.button3.clicked.connect(self.get_text)

        # 垂直布局
        layout = QVBoxLayout()
        layout.addWidget(self.plainTextEdit)
        layout.addWidget(self.button1)
        layout.addWidget(self.button2)
        layout.addWidget(self.button3)

        # 创建标签和行编辑框
        self.label = QLabel(self)
        self.label.setText("The content is: ")
        self.line = QLineEdit(self)

        # 水平布局
        h_layout = QHBoxLayout()
        h_layout.addWidget(self.label)
        h_layout.addWidget(self.line)

        # 将水平布局添加到垂直布局中
        layout.addLayout(h_layout)

        # 设置窗口布局
        self.setLayout(layout)

    def insert_text(self):
        # 在当前光标位置插入文本
        self.plainTextEdit.insertPlainText("Hello, PyQt5!\n")

    def clear_text(self):
        # 清除所有文本内容
        self.plainTextEdit.clear()

    def get_text(self):
        # 获取当前文本内容并显示在行编辑框中
        text = self.plainTextEdit.toPlainText()
        self.line.setText(text)


if __name__ == "__main__":
    # 创建应用程序对象
    app = QApplication(sys.argv)
    # 创建 PlainTextEditExample 实例
    ex = PlainTextEditExample()
    # 显示窗口
    ex.show()
    # 运行应用程序
    sys.exit(app.exec_())

这个示例创建了一个简单的PyQt5应用程序，包含一个QPlainTextEdit实例和几个按钮，演示了常用的一些操作。每个按钮连接了相应的槽函数，实现了以下功能：

1. Insert Text按钮：点击按钮会在文本编辑器中插入文本“Hello, PyQt5!”。
2. Clear Text按钮：点击按钮会清除文本编辑器中的所有内容。
3. Get Text按钮：点击按钮会获取当前文本编辑器中的文本内容。

运行结果如下

3. Plain Text Edit常用信号使用案例

我们用下面一个例子演示使用QPlainTextEdit的常用信号

import sys
from PyQt5.QtWidgets import QApplication, QPlainTextEdit, QVBoxLayout, QWidget, QLabel

class PlainTextEditExample(QWidget):
    def __init__(self):
        super().__init__()
        self.initUI()

    def initUI(self):
        self.setWindowTitle("Plain Text Edit Signals Example")
        self.resize(400, 300)

        # 创建 QPlainTextEdit 实例
        self.plainTextEdit = QPlainTextEdit(self)

        # 创建用于显示信号的标签
        self.label = QLabel(self)
        self.label.setText("No signal emitted yet.")

        # 垂直布局
        layout = QVBoxLayout()
        layout.addWidget(self.plainTextEdit)
        layout.addWidget(self.label)
        self.setLayout(layout)

        # 将信号与槽函数连接
        self.plainTextEdit.cursorPositionChanged.connect(self.on_cursor_position_changed)
        self.plainTextEdit.textChanged.connect(self.on_text_changed)

    def on_cursor_position_changed(self):
        # 光标位置变化时触发此槽函数
        cursor_pos = self.plainTextEdit.textCursor().position()
        self.label.setText(f"Cursor position changed. Current position: {cursor_pos}")

    def on_text_changed(self):
        # 文本内容变化时触发此槽函数
        text = self.plainTextEdit.toPlainText()
        self.label.setText(f"Text changed. New text: {text}")

if __name__ == "__main__":
    app = QApplication(sys.argv)
    ex = PlainTextEditExample()
    ex.show()
    sys.exit(app.exec_())

这个示例创建了一个简单的PyQt5应用程序，包含一个QPlainTextEdit实例和一个标签，用于显示信号的信息。连接了两个常用的信号：

1. cursorPositionChanged信号：当文本编辑器中的光标位置发生变化时触发，连接了on_cursor_position_changed槽函数，该槽函数会在标签中显示当前光标位置的信息。
2. textChanged信号：当文本编辑器中的文本内容发生变化时触发，连接了on_text_changed槽函数，该槽函数会在标签中显示新的文本内容。

运行结果如下