QT--富文本处理

x33g5p2x  于2022-03-18 转载在 其他  
字(10.3k)|赞(0)|评价(0)|浏览(586)

什么是富文本?

word 上的字体可以更改,变换颜色等的是rich text 富文本
而window记事本那种是纯文本(plain text)
关于它的帮助可以看助手 Rich Text Processing 关键字查找

富文本 文档结构

QT对富文本的处理只有只读编辑二种方式
对于文档的读取和编辑要使用二种不同的接口
文档的光标主要基于QTextCursor类,而文档的框架主要基于QTextDocument类

一个富文本文档的结构分为几种元素来表示,分别是框架(QTextFrame)文本块(QTextBlock)表格(QTextTable)列表(QTextList)
每种元素的格式又使用相应的 format类来表示,分别是框架格式(QTextFrameFormat)文本块格式(QTextBlockFormat),表格格式(QTextTableFormat)列表格式(QTextListFormat),这些格式一般在编辑文档时使用,所以常和QTextCursor类配合使用。

QTextEdit类就是一个富文本编辑器,所以在构造QTexrEdit类的对象时就已经构建了一个QTextDocument类对象和一个QTextCursor类对象,只须调用它们进行相应的操作即可

一个空的文档包含了一个根框架(Root frame),这个根框架又包含了一个空的文本块(Block)。
框架将一个文档分为多个部分,在根框架里可以再添加文本块、子框架和表格等,一个文档的结构如图所示

下面实际写下:
新建Qt Widget项目,名称myrichtext ,基类QMainWindow

打开ui界面,拖入一个Text Edit 部件。然后到mainwindow.cpp中
先添加头文件#include <QTextFrame>
再在MainWindow构造函数中添加如下代码

  1. QTextDocument *document = ui->textEdit->document(); // 获取文档对象
  2. QTextFrame *rootFrame = document->rootFrame(); // 获取根框架
  3. QTextFrameFormat format; // 创建框架格式
  4. format.setBorderBrush(Qt::red); // 边界颜色
  5. format.setBorder(3); // 边界宽度
  6. rootFrame->setFrameFormat(format); // 框架使用格式

在构造函数中创建文档对象获取了编辑器文档内容,创建了根框架,并且设置好了框架的格式

现在运行程序

这里还可以使用setHeight()和setWidth()函数来固定高度和宽度

下面继续添加代码,使用光标类对象,在根框中再添加一个子框架:

  1. QTextFrameFormat frameFormat;
  2. frameFormat.setBackground(Qt::lightGray); // 设置背景颜色
  3. frameFormat.setMargin(10); // 设置边距
  4. frameFormat.setPadding(5); // 设置填衬
  5. frameFormat.setBorder(2);
  6. frameFormat.setBorderStyle(QTextFrameFormat::BorderStyle_Dotted); // 设置边框样式
  7. QTextCursor cursor = ui->textEdit->textCursor(); // 获取光标
  8. cursor.insertFrame(frameFormat); // 在光标处插入框架

这里又建立了一个框架格式,然后获取了光标,在光标处插入框架

这里为框架格式设置了边白,它分为边界内与本身内容间的空白,即填衬(Padding) ,和边界外与其他内容间的空白,即边距(Margin)。框架边界的样式有实线,点线等。框架格式的属性如图5-10所示。现在可以运行程序查看效果。

文本块

文本块QTextBlock类为文本文档QTextDocument提供了一个文本片段(QText-Fragment)的容器。

下面通过例子理解它:

继续在前面的项目中添加代码。在mainwindow.h文件中添加私有槽的声明:

  1. private slots:
  2. void showTextFrame(); //遍历文档框架

然后再mainwinodw…cpp构造函数中实现槽

  1. #include <QDebug>
  1. QAction *action_textFrame = new QAction(tr("框架"), this);
  2. connect(action_textFrameA,&QAction::triggered,this,&MainWindow::showTextFrame);
  3. ui->mainToolBar->addAction(action_textFrame); // 在工具栏添加动作

这里新建一个工具栏动作,触发信号后实现showTextFrame函数

下面实现槽函数的功能

  1. void MainWindow::showTextFrame() // 遍历框架
  2. {
  3. QTextDocument *document = ui->textEdit->document();
  4. QTextFrame *frame = document->rootFrame();
  5. QTextFrame::iterator it; // 建立QTextFrame类的迭代器
  6. for (it = frame->begin(); !(it.atEnd()); ++it) {
  7. QTextFrame *childFrame = it.currentFrame(); // 获取当前框架的指针
  8. QTextBlock childBlock = it.currentBlock(); // 获取当前文本块
  9. if (childFrame)
  10. qDebug() << "frame";
  11. else if (childBlock.isValid())
  12. qDebug() << "block:" << childBlock.text();
  13. }
  14. }

在这个函数中获取了文档的根框架,然后使用它的迭代器iterator(遍历器)来遍历根框架中的所有子框架和文本块。

在循环语句中先使用QTextFrame类的 begin()函数使iterator指向根框架最开始的元素,然后使用iterator的 atEnd()函数判断是否已经到达了根框架的最后一个元素。

这里如果出现子框架,则输出一个框架的提示;如果出现文本块,则输出文本块提示和文本块的内容。

现在运行程序,然后在编辑器中输入一些内容,按下工具栏中的“框架”动作,查看一下输出栏中的信息,如图

只输出了根框架的文本块。

下面使用其他方法来遍历全部文本块

下面再mainwindow.h文件中继续添加私有槽private slots声明:

  1. void showTextBlock(); //遍历所有文本块

然后与上面相同,先建立动作

  1. QAction *action_textBlock = new QAction(tr("文本块"), this);
  2. connect(action_textBlock, &QAction::triggered, this, &MainWindow::showTextBlock);
  3. ui->mainToolBar->addAction(action_textBlock);

添加槽函数showTextBlock

  1. void MainWindow::showTextBlock() // 遍历文本块
  2. {
  3. QTextDocument *document = ui->textEdit->document();
  4. QTextBlock block = document->firstBlock(); // 获取文档的第一个文本块
  5. for (int i = 0; i < document->blockCount(); i++) {
  6. qDebug() << tr("文本块%1,文本块首行行号为:%2,长度为:%3,内容为:")
  7. .arg(i).arg(block.firstLineNumber()).arg(block.length())
  8. << block.text();
  9. block = block.next(); // 获取下一个文本块
  10. }
  11. }

这里使用QTextDocument类的firstBlock()函数来获取文档的第一个文本块,而blockCount()函数可以获取文档中所有文本块的个数,这样便可以使用循环语句来遍历所有文本块。

每一个文本块都输出了编号、第一行行号、长度和内容,然后使用QTextBlocknext()函数来获取下一个文本块。

这里需要说明的是, tr()函数中使用“%1”等位置标记,然后在后面使用arg()添加变量作为参数,这样这些参数就会代替前面字符串中的“%1”显示出来。字符串中有几个“%”号,后面就应该有几个arg()与其对应。

arg()是 QString类中的函数,因为 tr()函数返回QString类对象,所以这里可以这样使用。

现在运行程序,然后在编辑器中添加一些内容,按下“文本块”动作查看效果。
可以看到,行号是从0开始标记的,而且如果不使用回车换行,那么它即便在编辑器中显示在了第二行,其实还是在一个文本块里。
文本块的长度是从1开始计算的,就是说,就算什么都不写,那么文本块的长度也是1,所以长度会比实际字符数多1

下面试试如何更改文本块文字格式

在mainwindow.h文件中添加私有槽声明

  1. void setTextFont(bool checked); //设置字体格式

然后在mainwindow.cpp构造函数中创建动作

  1. QAction *action_font = new QAction(tr("字体"), this);
  2. action_font->setCheckable(true); // 设置动作可以被选中
  3. connect(action_font, &QAction::toggled, this, &MainWindow::setTextFont);
  4. ui->mainToolBar->addAction(action_font);

实现槽函数

  1. void MainWindow::setTextFont(bool checked) // 设置字体格式
  2. {
  3. if(checked){ // 如果处于选中状态
  4. QTextCursor cursor = ui->textEdit->textCursor();
  5. QTextBlockFormat blockFormat; // 文本块格式
  6. blockFormat.setAlignment(Qt::AlignCenter); // 水平居中
  7. cursor.insertBlock(blockFormat); // 使用文本块格式
  8. QTextCharFormat charFormat; // 字符格式
  9. charFormat.setBackground(Qt::lightGray); // 背景色
  10. charFormat.setForeground(Qt::blue); // 字体颜色
  11. // 使用宋体,12号,加粗,倾斜
  12. charFormat.setFont(QFont(tr("宋体"), 12, QFont::Bold, true));
  13. charFormat.setFontUnderline(true); // 使用下划线
  14. cursor.setCharFormat(charFormat); // 使用字符格式
  15. cursor.insertText(tr("测试字体")); // 插入文本
  16. }
  17. else{/*恢复默认的字体格式*/} // 如果处于非选中状态,可以进行其他操作
  18. }

这里先获得了编辑器的光标,然后为其添加了文本块格式和字符格式。文本块格式主要设置对齐方式,缩进等格式,字符格式主要设置字体、颜色、下划线等格式。最后使用光标插人了一个测试文字。

设置字体格式运行效果

表格、列表与图片

下面看一下怎样在编辑器中插入表格和图片。

在mianwindow.h文件中添加槽 声明

  1. void showTextFrame(); // 遍历文档框架
  2. void showTextBlock(); // 遍历所有文本块
  3. void setTextFont(bool checked); // 设置字体格式

然后到mainwindow.cpp文件的构造函数中继续添加

  1. void insertTable(); // 插入表格
  2. void insertList(); // 插入列表
  3. void insertImage(); // 插入图片

然后到mainwindow.cpp构造函数中继续添加动作

  1. QAction *action_textTable = new QAction(tr("表格"),this);
  2. QAction *action_textList = new QAction(tr("列表"),this);
  3. QAction *action_textImage = new QAction(tr("图片"),this);
  4. connect(action_textTable, &QAction::triggered, this, &MainWindow::insertTable);
  5. connect(action_textList, &QAction::triggered, this, &MainWindow::insertList);
  6. connect(action_textImage, &QAction::triggered, this, &MainWindow::insertImage);
  7. ui->mainToolBar->addAction(action_textTable);
  8. ui->mainToolBar->addAction(action_textList);
  9. ui->mainToolBar->addAction(action_textImage);

三个动作,添加到工具栏中,下面定义槽函数

  1. void MainWindow::insertTable() // 插入表格
  2. {
  3. QTextCursor cursor = ui->textEdit->textCursor();
  4. QTextTableFormat format; // 表格格式
  5. format.setCellSpacing(2); // 表格外边白
  6. format.setCellPadding(10); // 表格内边白
  7. cursor.insertTable(2, 2, format); // 插入2行2列表格
  8. }
  9. void MainWindow::insertList() // 插入列表
  10. {
  11. QTextListFormat format; // 列表格式
  12. format.setStyle(QTextListFormat::ListDecimal); // 数字编号
  13. ui->textEdit->textCursor().insertList(format);
  14. }
  15. void MainWindow::insertImage() // 插入图片
  16. {
  17. QTextImageFormat format; // 图片格式
  18. format.setName("../myrichtext/logo.png"); // 图片路径
  19. ui->textEdit->textCursor().insertImage(format);
  20. }

表格和列表的遍历可以用QTextFrame::iterator来遍历
可以通过Rich Document Structure 关键字查看

查找功能

QTextEdit类提供了很多方便的函数,比如常用的复制粘贴等等
下面主要介绍比较难的查找功能 find()

在前面的代码中,在mainwindow.h中添加类的前置声明

  1. class QLineEdit;
  2. class QDialog;

然后添加私有对象指针

  1. private:
  2. QLineEdit *lineEdit;
  3. QDialog *findDialog;

在添加私有槽声明private slots

  1. void textFind(); // 查找文本
  2. void findNext(); // 查找下一个

在mainwindow.cpp构造函数中实现动作创建

先添加头文件:

  1. #include <QDebug>
  2. #include <QLineEdit>
  3. #include <QDialog>
  4. #include <QPushButton>
  5. #include <QVBoxLayout>
  1. QAction *action_textFind = new QAction(tr("查找"), this);
  2. connect(action_textFind, &QAction::triggered, this, &MainWindow::textFind);
  3. ui->mainToolBar->addAction(action_textFind);

在实现QLineEdit行编辑器和QDialog对话框创建界面

  1. findDialog = new QDialog(this); // 创建对话框
  2. lineEdit = new QLineEdit(findDialog); // 创建行编辑器
  3. QPushButton *btn = new QPushButton(findDialog); // 创建按钮
  4. btn->setText(tr("查找下一个"));
  5. connect(btn, &QPushButton::clicked, this, &MainWindow::findNext); // 按钮按下,findnext
  6. QVBoxLayout *layout = new QVBoxLayout; // 创建垂直布局管理器
  7. layout->addWidget(lineEdit); // 添加部件
  8. layout->addWidget(btn);
  9. findDialog->setLayout(layout); // 在对话框中使用布局管理器

实现槽函数

  1. void MainWindow::textFind() // 查找文本
  2. {
  3. findDialog->show();
  4. }
  5. void MainWindow::findNext() // 查找下一个
  6. {
  7. QString string = lineEdit->text();
  8. // 使用查找函数查找指定字符串,查找方式为向后查找
  9. bool isfind = ui->textEdit->find(string, QTextDocument::FindBackward);
  10. if(isfind){ // 如果查找成功,输出字符串所在行和列的编号
  11. qDebug() << tr("行号:%1 列号:%2")
  12. .arg(ui->textEdit->textCursor().blockNumber())
  13. .arg(ui->textEdit->textCursor().columnNumber());
  14. }
  15. }

这里使用了find函数进行查找。选项QTextDocument::FindBackward表示向后查找,默认向前查找;还有FindWholeWords,FindCaseSensitively

其实find函数只是为了方便使用,更多的查找功能可以使用QTextDocument类的find函数。

语法高亮与html

使用QSyntaxHighlighter类,创建子类,实现highlightBlock函数,使用时候直接将QTextDocument类对象指针作为父部件指针,这样就可以自动调用highlightBlock()函数。

首先在项目中添加新文件,模板选择C++ Class,相当于.h文件,命名mysyntaxhighlighter.h

  1. #ifndef MYSYNTAXHIGHLIGHTER_H
  2. #define MYSYNTAXHIGHLIGHTER_H
  3. #include <QSyntaxHighlighter>
  4. class MySyntaxHighlighter : public QSyntaxHighlighter
  5. {
  6. Q_OBJECT
  7. public:
  8. explicit MySyntaxHighlighter(QTextDocument *parent = 0);
  9. protected:
  10. void highlightBlock(const QString &text); //必须重新实现该函数
  11. };
  12. #endif // MYSYNTAXHIGHLIGHTER_H

现在到mysyntaxhighlighter.cpp文件中,先更改构造函数为:

  1. #include "mysyntaxhighlighter.h"
  2. MySyntaxHighlighter::MySyntaxHighlighter(QTextDocument *parent) :
  3. QSyntaxHighlighter(parent)
  4. {
  5. }

然后添加highlightBlock()函数定义:

  1. void MySyntaxHighlighter::highlightBlock(const QString &text) // 高亮文本块
  2. {
  3. QTextCharFormat myFormat; // 字符格式
  4. myFormat.setFontWeight(QFont::Bold);
  5. myFormat.setForeground(Qt::green);
  6. QString pattern = "\\bchar\\b"; // 要匹配的字符,这里是“char”单词
  7. QRegExp expression(pattern); // 创建正则表达式
  8. int index = text.indexOf(expression); // 从位置0开始匹配字符串
  9. // 如果匹配成功,那么返回值为字符串的起始位置,它大于或等于0
  10. while (index >= 0) {
  11. int length = expression.matchedLength(); // 要匹配字符串的长度
  12. setFormat(index, length, myFormat); // 对要匹配的字符串设置格式
  13. index = text.indexOf(expression, index + length); // 继续匹配
  14. }
  15. }

这里主要使用了正则表达式和QString类indexOf()函数来进行字符串匹配,如果匹配成功,则使用QSyntaxHighlighter类setFormat()函数来设置字符格式。

下面来使用这个类
在 mainwindow.h 文件中添加类的前置声明:

class MySyntaxHighlighter;

然后再添加私有对象指针:
MySyntaxHighlighter * highlighter;

到mainwindow.cpp文件中添加头文件:#include"mysyntaxhighlighter.h"
然后在构造函数的最后添加一行代码:
highlighter = new MySyntaxHighlighter(ui->textEdit->document());

这里创建了MySyntaxHighlighter类的对象,并且使用编辑器的文档对象指针作其参数

现在运行运行程序,输入“char”查看一下效果。

只有char时候高亮,匹配表达式

关于语法高亮,可以查看Syntax Highlighter Example示例程序。
在富文本处理中还提供了对 HTML子集的支持,可以在QLabel或者QTextEdit添加文本时使用HTML标签或者CSS属性,具体内容可以在帮助中通过Supported HTMIL Subset关键字查看,下面举一个最简单的例子。

在 mainwindow.cpp文件中的构造函数最后添加下面一行代码:

  1. ui->textEdit->append(tr("<h1 ><font color = red>使用HTLM </font ></h1>"));

使用HTLM

这里往编辑器中添加了文本,并且使用了HTMI标签,运行程序查看效果。

前面讲到了在编辑器中使用语法高亮,那么读者可能会想到在编辑代码时另一个非常有用的功能,就是自动补全。

Qt中提供了QCompleter类来实现自动补全,这个类在第3章介绍行编辑器时已经介绍过了,可以使用它来实现编辑器中的自动补全功能。这个可以参考示例程序Custom Completer。
富文本处理的内容就讲到这里,其涉及的东西很多,要学好这些内容就要多动手去编写程序。帮助文档的Advanced RichText
Processing里还提供了一个处理大文档的方法,需要的读者可以进行参考。对于这部分内容,可以查看Text
Edit程序,这个例子是一个综合的富文本编辑器。

相关文章