【Qt】QTextEdit/QPlainTextEdit 实现 Tab 键多行缩进与反缩进

【Qt】QTextEdit/QPlainTextEdit 实现 Tab 键多行缩进与反缩进

I - 主要原理

由于 QTextEdit 和 QPlainTextEdit ，都无法实现多行选中缩进与反缩进，选中多行后，按下缩进或反缩进，选中文本都会清空，并替换为(反)缩进或空格。因此会造成使用很不方便和低效的问题。

需要实现一个类继承自 QTextEdit 或 QPlainTextEdit 类并重写其 keyPressEvent 接口，处理 Tab 按键

II - 代码实现

2.1 - 自定义类

自定义类 TextEdit，视使用目的继承 QTextEdit 或 QPlainTextEdit，

#include <QTextEdit>
// 或 #include <QPlainTextEdit>class TextEdit : public QTextEdit
// 或 class TextEdit : public QPlainTextEdit
{Q_OBJECT
public:explicit TextEdit(QWidget* parent = nullptr);protected:void keyPressEvent(QKeyEvent *e) override; // 键盘事件// 添加 override 编译时检查是否重写父类函数，防止敲错
private:// 根据是否保留制表符，设置为 \t 或空格QString m_indentation = "\t"; // 或 "    "
}

2.2 - 实现 Tab 缩进

需要包含头文件

#include <QTextCursor> // 获取光标实例
#include <QTextBlock> // 文本块

void TextEdit::keyPressEvent(QKeyEvent* e)
{// 判断 Tab 按键 以及排除 Shift, Ctrl, Alt 等控制按键的情况，因为通常通过 Shift + Tab 实现反缩进if (Qt::Key_Tab && Qt::NoModifier == e->modifiers()){// 获取光标实例QTextCursor cursor = textCursor();// 在无选中的情况下仅插入一个缩进，并返回if (!cursor.hasSelection()){insertPlainText(m_indentation);return;}  // 记录光标选中内容的开始和结束位置 spos(start position), epos(end position)int spos = cursor.anchor();int epos = cursor.position();// 在由下向上选中时，交换开始和结束位置if(spos > epos){int hold = spos;spos = epos;epos = hold;}// 获取开始文本块序号cursor.setPosition(spos, QTextCursor::MoveAnchor);int sblock = curs.block().blockNumber();// 获取结束文本块序号cursor.setPosition(epos, QTextCursor::MoveAnchor);int eblock = curs.block().blockNumber();// 开始处理文本缩进cursor.setPosition(spos, QTextCursor::MoveAnchor);// QTextCursor 在编辑文本块时需要调用此方法cursor.beginEditBlock();// 依次遍历所选中的文本块，并在起始处插入缩进for(int i = 0; i <= (eblock - sblock); ++i){cursor.movePosition(QTextCursor::StartOfBlock, QTextCursor::MoveAnchor);cursor.insertText(m_indentation);cursor.movePosition(QTextCursor::NextBlock, QTextCursor::MoveAnchor);}// 编辑文本块结束cursor.endEditBlock();// 将光标的选择设置为跨越所有涉及的行，也就是说保留之前内容的选中状态，并加入缩进为选中内容。// 将光标移动至开始位置cursor.setPosition(spos, QTextCursor::MoveAnchor);cursor.movePosition(QTextCursor::StartOfBlock, QTextCursor::MoveAnchor);while(cursor.block().blockNumber() < eblock){// 使用 QTextCursor::KeepAnchor 为选中文本cursor.movePosition(QTextCursor::NextBlock, QTextCursor::KeepAnchor);}// 移动至最后一个文本块结束位置cursor.movePosition(QTextCursor::EndOfBlock, QTextCursor::KeepAnchor);// 编辑器设置此光标，结束！setTextCursor(curs);} // end if
}

2.3 - 实现反缩进

反缩进的实现较缩进难实现，需要知道待反缩进的每一个文本行开头有多少个缩进位置，以及不足时如何处理。

int TextEditor::GetIndentationSpaces(const QString& blockText)
{int indentationSpaceCount = 0;// 遍历此文本块的每一个字符，检查是否包含空格或制表符for (int i = 0; i < blockText.size() && QString("\t ").contains(blockText[i]); ++i){// 若为空格if (' ' == blockText[i]){++indentationSpaceCount;}else // 若为制表符 \t{indentationSpaceCount += tabStopDistance() / fontMetrics().averageCharWidth();}}return indentationSpaceCount;
}

继续在 keyPressEvent 接口中实现 Shift + Tab 反缩进，或者也可以使用 Qt::Key_BackTab 枚举，这里使用与缩进处理文本不同的方式

void TextEdit::keyPressEvent(QKeyEvent* e)
{// ...else if (Qt::Key_BackTab == e->key()){// 获取光标实例QTextCursor cursor = textCursor();// 没有选中内容时，去除当前行的一个缩进并返回if (!cursor.hasSelection()){int spaceCount = std::min(GetIndentationSpaces(cursor.block().text(), m_indentation.size());cursor.movePosition(QTextCursor::StartOfLine); // movePosition 第二个参数缺省值为 QTextCursor::MoveMode::MoveAnchor// 从行起始处删除当前的一个缩进长度cursor.movePosition(QTextCursor::Right, QTextCursor::KeepAnchor, spaceCount);cursor.removeSelectedText();return;}// 记录光标选中内容的开始和结束位置 int startPos = cursor.anchor();int endPos = cursor.position();// 在由下向上选中时，交换开始和结束位置if(startPos > endPos){std::swap(startPos, endPos);}// 若选中内容未选中首行的全部内容，更新开始位置cursor.setPosition(startPos, QTextCursor::MoveAnchor);cursor.movePosition(QTextCursor::StartOfBlock, QTextCursor::MoveAnchor);startPos = cursor.position()// 重新选中curosr.setPosition(endPos, QTextCursor::MoveAnchor);		cursor.setPosition(startPos);cursor.setPosition(endPos, QTextCursor::KeepAnchor);QString content = cursor.selection().toPlainText();QStringList list = content.split("\n");// 减少开销int sz = list.size();for (int = 0; i < sz; ++i){int spaceCount = GetIndentationSpaces(list[i]);spaceCount = std::min(spaceCount, m_indentation.size());// 若该行无缩进则跳过if (0 == spaceCount){continue;}// 截断list[i] = list[i].mid(spaceCount); }// 文本还原content = list.join("\n");// 移除选中文本，替换为去除缩进的文本cursor.removeSelectedText();cursor.insertText(content);// 重新使用光标选中文本，保证可连续反缩进cursor.setPosition(startPos);cursor.setPosition(startPos() + content.size(), QTextCursor::KeepAnchor);setTextCursor(cursor);return;}
}

最后不要忘了， 调用父类的keyPressEvent ，以保证不影响其他的键盘事件

QTextEdit::keyPressEvent(e);
// 或
QPlainTextEdit::keyPressEvent(e);

III - 参考链接

• https://www.qtcentre.org/threads/33582-indent-selection-in-QPlainTextEdit

• https://codereview.stackexchange.com/questions/33899/qplaintextedit-subclass-function-to-indent-lines-in-selection