QScintilla入门指南之编辑器设置
一、文本环绕
如果没有文本换行,那么一行可能会变得越来越⻓。而文本环绕则会⾃动断行,使得所有内容都适应可见窗口。注意,如果开启文本环绕,则环绕行不会增加行号。
1.1 环绕模式
文本环绕有多种风格,更改环绕模式的接口如下:
virtual void QsciScintilla::setWrapMode(WrapMode mode)
其中,枚举变量WrapMode
的不同类型如下:
- WrapNone :关闭环绕模式
- WrapWord :在单词边界处环绕
- WrapCharacter :在字符边界处环绕
- WrapWhitespace : 在空白符边界环绕
1.2 环绕标志可见性
文本环绕标志可通过如下接口 开启/关闭:
void QsciScintilla::setWrapVisualFlags(WrapVisualFlag endFlag, WrapVisualFlag startFlag = WrapFlagNone, int indent = 0)
其中,枚举变量WrapVisualFlag
的不同类型如下:
- WrapFlagNone :不显示环绕标志
- WrapFlagByText :在文本中环绕标志
- WrapFlagByBorder :在边界显示环绕标志
- WrapFlagInMargin :在行号区显示环绕标志
endFlag
参数和startFlag
参数用来确定是否以及在何处显示行尾和行首的标志。indent
参数则用来设置换行的缩进字符数。
indent 参数只有将
WrapIndentMode
设置为WrapIndentFixed
,才可以看到其效果,设置方法见环绕缩进模式。
endFlag 和 startFlag 设置为不同参数的样式如下:
- 如果 endFlag == WrapFlagNone
- 如果 endFlag == WrapFlagByText
- 如果 endFlag == WrapFlagByBorder
- 如果 endFlag == WrapFlagInMargin
- 如果 startFlag == WrapFlagNone
- 如果 startFlag == WrapFlagByText
- 如果 startFlag == WrapFlagInMargin
1.3 环绕缩进模式
环绕模式可以有缩进,可以通过如下接口设置:
void QsciScintilla::setWrapIndentMode(WrapIndentMode mode)
其中,枚举变量WrapIndentMode
的不同模式如下:
- WrapIndentFixed :环绕的子行按照由
setWrapVisualFlags()
设置的值进行缩进
- WrapIndentSame :环绕的子行与第一个子行相同
- WrapIndentIndented :环绕的子行与第一个子行相同的量上再加上一个缩进级别
- WrapIndentDeeplyIndented :环绕的子行与第一个子行相同的量上再加上两个缩进级别
缩进的宽度可以通过如下接口设置:
virtual void QsciScintilla::setTabWidth(int width)
二、行结尾符
文本中的每一行都是以行结尾符(End of Line, EOF)
来结尾。在⼤多数⽂本编辑器⾥,此字符不可见。但是,如果需要,可以显示它。注意,EOL 字符对于 Linux、Windows 和 Mac 等不同的操作系统其内容是不⼀样的:
- Windows:
\r\n
- Unix/Linux:
\n
- Mac:
\r
2.1 EOL模式
EOL模式可以通过如下接口设置:
virtual void QsciScintilla::setEolMode(EolMode mode)
其中,对于不同系统枚举变量EolMode
的设置方法如下:
editor->setEolMode(QsciScintilla::EolWindows);
editor->setEolMode(QsciScintilla::EolUnix);
editor->setEolMode(QsciScintilla::EolWMac);
2.2 EOL可见性
EOL符号的可见性可以通过如下接口设置:
virtual void QsciScintilla::setEolVisibility(bool visible)
- 如果设置为
false
:则 EOL 符号不可见
- 如果设置为
true
:则 EOL 符号可见
三、缩进
3.1 缩进字符
默认的缩进字符是" "
,即空格。可以通过如下函数设置是否使用\t
字符,即 Tab:
virtual void QsciScintilla::setIndentationsUseTabs(bool tabs)
如果设置为false
,则采用空格缩进;如果设置为true
,则采用 Tab 缩进。
3.2 缩进宽度
可以通过如下接口设置缩进的宽度:
virtual void QsciScintilla::setTabWidth (int width)
使用 Tab 键完成缩进时,此参数定义了 Tab 字符的宽度,即为空格的倍数。
3.3 缩进提示
QScintilla 可以显示虚线垂直线以用来指示该行的缩进级别,其接口为:
virtual void QsciScintilla::setIndentationGuides(bool enable)
- 如果设置为
false
:则缩进级别不可见
- 如果设置为
true
:则缩进级别可见
3.4 空格缩进
如果需要当在光标处存在空格时影响 Tab 键的行为,则可以使用如下接口设置:
virtual void QsciScintilla::setTabIndents(bool indent)
- 如果设置为
false
:则每当按下 Tab 键时,编辑器只需插入 n 个空格(也就是一个\t
字符)
- 如果设置为
true
:则编辑器会将第一个非空格字符推送到下一个缩进级别处
3.5 自动缩进
插入新行时,自动缩进会将光标推送到与前一个光标相同的缩进级别,其设置的接口如下:
virtual void QsciScintilla::setAutoIndent(bool autoindent)
- 如果设置为
false
:
- 如果设置为
true
:
注意:词法分析器可以使用其 setAutoIndentStyle 方法来修改此行为。
四、光标
编辑器可以以不同的颜色和形状来显示光标。
4.1 光标前景色
光标前景色即为光标本身的颜色,可以通过如下接口设置:
virtual void setCaretForegroundColor(const QColor &col)
4.2 高亮当前行
可以通过如下接口来设置是否高亮当前行:
virtual void QsciScintilla::setCaretLineVisible(bool enable)
- 如果设置为
false
:
- 如果设置为
true
:
4.3 当前行背景色
默认情况下,高亮当前行的颜色为黄色,可以通过如下接口修改当前行的颜色:
virtual void setCaretLineBackgroundColor(const QColor &col)
4.4 光标宽度
可以通过如下接口来设置光标宽度,其以像素为单位。注意:如果设置为0,则光标不可见!
virtual void setCaretWidth(int width)
五、代码实例
在mainwindow.cpp
中添加如下代码:
MainWindow::MainWindow(QWidget *parent)
: QMainWindow(parent)
, ui(new Ui::MainWindow)
{
ui->setupUi(this);
editor = new QsciScintilla(this);
setCentralWidget(editor);
// 编辑器设置
// ----------------------------------------
// 设置Tab键为4个空格
editor->setTabWidth(4);
// 开启自动缩进
editor->setAutoIndent(true);
// 高亮当前行
editor->setCaretLineVisible(true);
// 设置当前行颜色
editor->setCaretLineBackgroundColor(QColor("#E8E8FF"));
// 编辑器放大
editor->zoomIn(8);
}
运行结果如下图所示:
其余该系列文章如下: