Qt应用开发(基础篇)——高级纯文本窗口 QPlainTextEdit

一、前言

QPlainTextEdit类继承于QAbstractScrollArea，QAbstractScrollArea继承于QFrame，是Qt用来显示和编辑纯文本的窗口。

滚屏区域基类https://blog.csdn.net/u014491932/article/details/132245486?spm=1001.2014.3001.5501框架类QFramehttps://blog.csdn.net/u014491932/article/details/132188655?spm=1001.2014.3001.5501

QPlainTextEdit是纯文本的高级查看器/编辑器，它经过优化，可以处理大型文档并快速响应用户输入。QPlainTextEdit使用与QTextEdit非常相同的技术和概念，但针对纯文本处理进行了优化。QPlainTextEdit适用于段落和字符，实际应用中显示串口监控信息、网络传输信息、文本文件读取编辑等情景下使用。

二、QPlainTextEdit类

1、backgroundVisible

该属性表示确定调色板背景是否在文档区域之外可见。

bool backgroundVisible() const
void setBackgroundVisible(bool visible)

如果设置为true，则纯文本编辑器将在文本文档未覆盖的视口区域上绘制调色板背景。该特性使用户可以直观地区分使用调色板的基本色绘制的文档区域和未被任何文档覆盖的空白区域。

2、blockCount

此属性保存文档中文本块的数量(回车换行之后算单独一块)。默认情况下，在空文档中，此属性的值为1。

int blockCount() const

3、centerOnScroll

此属性用于确定光标是否应该在屏幕上居中。

bool centerOnScroll() const
void setCenterOnScroll(bool enabled)

设置为true，则纯文本编辑器将垂直滚动文档，使光标在视窗中心可见，允许文本编辑滚动到文档末尾以下。下图中我们光标往下到底部的时候，继续往下屏幕会居中。

设置为false，则纯文本编辑将滚动尽可能小的量，以确保光标可见。

4、cursorWidth

该属性表示光标的宽度，默认宽度为1个像素。

int cursorWidth() const
void setCursorWidth(int width)

5、documentTitle

该属性表示文档的标题，没有实际的效果。

QString documentTitle() const
void setDocumentTitle(const QString &title)

6、lineWrapMode

该属性表示自动换行策略，默认QPlainTextEdit::WidgetWidth。

QPlainTextEdit::LineWrapMode lineWrapMode() const
void setLineWrapMode(QPlainTextEdit::LineWrapMode mode)

QPlainTextEdit::LineWrapMode 描述
NoWrap 不换行
WidgetWidth 文字被包装在文本编辑的右边缘，换行发生在空白处，保持整个单词完整

QPlainTextEdit::LineWrapMode	描述
NoWrap	不换行
WidgetWidth	文字被包装在文本编辑的右边缘，换行发生在空白处，保持整个单词完整

7、wordWrapMode

该属性表示单词间换行策略，默认QTextOption::WrapAtWordBoundaryOrAnywhere。

QTextOption::WrapMode wordWrapMode() const
void setWordWrapMode(QTextOption::WrapMode policy)

QTextOption::WrapMode 描述
NoWrap 不换行
WordWrap 文本在单词边界处换行
ManualWrap 不换行
WrapAnywhere 文本可以在一行中的任何点换行，即使它出现在单词的中间。
WrapAtWordBoundaryOrAnywhere 优先在字边界处换行;否则，它将出现在行上的适当点上，甚至在单词的中间。

QTextOption::WrapMode	描述
NoWrap	不换行
WordWrap	文本在单词边界处换行
ManualWrap	不换行
WrapAnywhere	文本可以在一行中的任何点换行，即使它出现在单词的中间。
WrapAtWordBoundaryOrAnywhere	优先在字边界处换行;否则，它将出现在行上的适当点上，甚至在单词的中间。

8、maximumBlockCount

该属性表示文档块的最大个数，默认为0。当超出最大限制的时候，会从开头删除块。如果设置的是负数或者零，表示不限制。设置此属性会禁用撤消重做历史记录。

int maximumBlockCount() const
void setMaximumBlockCount(int maximum)

9、overwriteMode

该属性保存用户输入的文本是否会覆盖现有文本。

和许多文本编辑器一样，纯文本编辑器小部件可以配置为使用用户输入的新文本插入或覆盖现有文本。如果此属性为true，现有文本将被新文本逐字符覆盖;否则，将在光标位置插入文本，取代现有文本。

大多数编辑器都是按下键盘的Insert键，开启此模式，软件实现可以响应按键事件，检测按下Insert按键的时候，切换此状态即可。

bool overwriteMode() const
void setOverwriteMode(bool overwrite)

10、placeholderText

该属性表示当文档内容为空的时候显示占位符提示文本。

QString placeholderText() const
void setPlaceholderText(const QString &placeholderText)

11、plainText

该属性表示当前文本内容，重新设置会覆盖之前的内容，撤销/重做历史将被重置，如果光标不在开头，那么文本格式也会被重置。

QString toPlainText() const
void setPlainText(const QString &text)

12、readOnly

该属性表示内容是否可只读，默认false。

bool isReadOnly() const
void setReadOnly(bool ro)

13、tabChangesFocus

该属性表示用户按下Tab键是否缩进，默认fasle。

bool tabChangesFocus() const
void setTabChangesFocus(bool b)

14、tabStopDistance

该属性表示以像素为单位保存制表位距离，默认情况下，此属性的值为80。这个属性在Qt 5.10中被引入。

qreal tabStopDistance() const
void setTabStopDistance(qreal distance)

15、textInteractionFlags

该属性表示显示文本如何与用户输入交互策略，readOnly属性会影响这个策略。

Qt::TextInteractionFlags textInteractionFlags() const
void setTextInteractionFlags(Qt::TextInteractionFlags flags)

Qt::TextInteractionFlag 描述
NoTextInteraction 不与文本做交互
TextSelectableByMouse 可以用鼠标选择文本，并使用上下文菜单或标准键盘快捷键将文本复制到剪贴板
TextSelectableByKeyboard 可以用键盘上的光标键选择文本。显示一个文本光标。
LinksAccessibleByMouse 链接可以用鼠标突出显示和激活。
LinksAccessibleByKeyboard 链接可以使用tab键聚焦，并使用enter键激活。
TextEditable 文本是完全可编辑的。
TextEditorInteraction TextSelectableByMouse+TextSelectableByKeyboard+TextEditable
TextBrowserInteraction TextSelectableByMouse+LinksAccessibleByMouse+LinksAccessibleByKeyboard

Qt::TextInteractionFlag	描述
NoTextInteraction	不与文本做交互
TextSelectableByMouse	可以用鼠标选择文本，并使用上下文菜单或标准键盘快捷键将文本复制到剪贴板
TextSelectableByKeyboard	可以用键盘上的光标键选择文本。显示一个文本光标。
LinksAccessibleByMouse	链接可以用鼠标突出显示和激活。
LinksAccessibleByKeyboard	链接可以使用tab键聚焦，并使用enter键激活。
TextEditable	文本是完全可编辑的。
TextEditorInteraction	TextSelectableByMouse+TextSelectableByKeyboard+TextEditable
TextBrowserInteraction	TextSelectableByMouse+LinksAccessibleByMouse+LinksAccessibleByKeyboard

16、undoRedoEnabled

该属性表示是否开启撤销和重做，默认开启。

bool isUndoRedoEnabled() const
void setUndoRedoEnabled(bool enable)

17、公共函数

1）anchorAt

返回位置pos处锚的引用，如果该点不存在锚，则返回一个空字符串。

QString anchorAt(const QPoint &pos) const

当我们需要在文档上打开一个链接，逻辑是鼠标在链接处按下并且在此链接上释放，可以通过鼠标按下和释放事件去检测鼠标事件触发。但我们如何去判断是否在同一个链接上触发的事件，这时候就需要用到anchorAt去检测某pos处的锚。

#ifndef PLAINTEXTEDIT_H
#define PLAINTEXTEDIT_H

#include <QPlainTextEdit>
#include <QMouseEvent>

class PlainTextEdit : public QPlainTextEdit
{
    Q_OBJECT

private:
    QString clickedAnchorStr;

public:
    explicit PlainTextEdit(QWidget *parent = 0) : QPlainTextEdit(parent)
    {
    }

    void mousePressEvent(QMouseEvent *e)
    {
        clickedAnchorStr = (e->button() & Qt::LeftButton) ? anchorAt(e->pos()) :
                                                         QString();
        QPlainTextEdit::mousePressEvent(e);
    }

    void mouseReleaseEvent(QMouseEvent *e)
    {
        if (e->button() & Qt::LeftButton && !clickedAnchor.isEmpty() &&
            anchorAt(e->pos()) == clickedAnchorStr)
        {
            emit linkActivated(clickedAnchor);
        }

        QPlainTextEdit::mouseReleaseEvent(e);
    }

signals:
    void linkActivated(QString);
};

2）canPaste

返回是否可以粘贴。

bool canPaste() const

3）createStandardContextMenu

当用户鼠标右击的时候创建和显示一个menu菜单栏小窗口，一般在contextMenuEvent事件中触发。

QMenu *createStandardContextMenu()
QMenu *createStandardContextMenu(const QPoint &position)

 void MyQPlainTextEdit::contextMenuEvent(QContextMenuEvent *event)
 {
     QMenu *menu = createStandardContextMenu();
     menu->addAction(tr("My Menu Item"));
     //...
     menu->exec(event->globalPos());
     delete menu;
 }

4）currentCharFormat

返回当前使用的的字符格式。

QTextCharFormat currentCharFormat() const

5）setCurrentCharFormat

设置当前使用的字符格式QTextCharFormat。

void setCurrentCharFormat(const QTextCharFormat &format)

6）cursorForPosition

返回某坐标下的文本光标QTextCursor(包含关于光标在文本中的位置和它所做的任何选择的信息)，经典用法用来判断是否越界。

QTextCursor cursorForPosition(const QPoint &pos) const

7）cursorRect

返回一个包含文本光标的QRect矩形，经典用法用来判断是否越界。

QRect cursorRect(const QTextCursor &cursor) const
QRect cursorRect() const

8）document

返回文档类QTextDocument。

QTextDocument *document() const

9）setDocument

设置一个文档类QTextDocument，使它成为编辑器的文档。

void setDocument(QTextDocument *document)

10）ensureCursorVisible

通过滚动文档让光标可见。

void ensureCursorVisible()

11）setExtraSelections

void setExtraSelections(const QList<QTextEdit::ExtraSelection> &selections)

此函数允许用给定的颜色临时标记文档中的某些区域，指定为选择。例如，在编程编辑器中，用给定的背景颜色标记整行文本以指示断点的存在。

12）extraSelections

返回设置的额外选择项。

QList<QTextEdit::ExtraSelection> extraSelections() const

13）find

多个方法查找字符、表达式、正则表达式是否存在。

bool find(const QString &exp, QTextDocument::FindFlags options = QTextDocument::FindFlags())
bool find(const QRegExp &exp, QTextDocument::FindFlags options = QTextDocument::FindFlags())
bool find(const QRegularExpression &exp, QTextDocument::FindFlags options = QTextDocument::FindFlags())

14）loadResource

加载由给定类型和名称指定的资源。这个函数是QTextDocument::loadResource()的扩展。

QVariant loadResource(int type, const QUrl &name)

15）moveCursor

通过执行给定的操作移动光标。

 void moveCursor(QTextCursor::MoveOperation operation, QTextCursor::MoveMode mode = QTextCursor::MoveAnchor)

16）print

这相当于直接调用文档上的print方法，只不过该函数还支持QPrinter::Selection作为打印范围。

void print(QPagedPaintDevice *printer) const

17）toPlainText

纯文本形式返回字符串。

QString toPlainText() const

17、公共槽

 void appendHtml(const QString &html)        //尾部加入html格式文本
 void appendPlainText(const QString &text)   //尾部添加纯文本
 void centerCursor()                         //居中光标
 void clear()                                //清除
 void copy()                                 //复制
 void cut()                                  //剪切
 void insertPlainText(const QString &text)   //插入纯文本
 void paste()                                //粘贴
 void redo()                                 //重做
 void selectAll()                            //选择全部
 void setPlainText(const QString &text)      //清空之前的文本，并设置纯文本
 void undo()                                 //撤销
 void zoomIn(int range = 1)                  //缩小
 void zoomOut(int range = 1                  //放大

18、信号

//文本块数量改变触发
void blockCountChanged(int newBlockCount)

//可复制触发
void copyAvailable(bool yes)

//光标位置改变触发
void cursorPositionChanged()

//修改状态发生更改时，触发此信号
void modificationChanged(bool changed)

//可重做触发
void redoAvailable(bool available)

//选择内容改变触发
void selectionChanged()

//文本内容改变触发
void textChanged()

//可撤销触发
void undoAvailable(bool available)

//文档更新触发，rect表示新视口区域，dy表示滚动像素量
void updateRequest(const QRect &rect, int dy)