7、文本Text

Text 组件用于显示文本文档，包含纯文本或格式化文本（使用不同字体，嵌入图片，显示链接，甚至是带 CSS 格式的 HTML 等）。因此，它常常也被用于作为简单的文本编辑器和网页浏览器使用。

import tkinter as tk

root = tk.Tk()

# 创建了一个宽60字符、高10行的Text控件
text = tk.Text(root,width=60,height=30)
text.pack()

# 创建一个Button，每次点击给Text尾部添加一句话
btn = tk.Button(root,text='click to add text',command=lambda :text.insert('end','hello\n'))
btn.pack()

root.mainloop()

属性

加载控件或图片

在 Text 组件中插入对象，可以使用 window_create() 和 image_create() 方法来插入一个控件或者一个图片

import tkinter as tk
from PIL import Image,ImageTk

root = tk.Tk()

# 创建Text
text = tk.Text(root,width=30,height=10)
text.pack()

# 在 Text 中插入一个按钮控件
test_btn = tk.Button(text,text='test_btn')
text.window_create('insert',window=test_btn)

# 在 Text 中插入一张图片
# 这个方法传入 file 参数的话只支持 gif 图片
img1 = tk.PhotoImage(file='./123.gif')
text.image_create('insert',image=img1)

# 如果需要插入其他格式图片，则需要使用PIL库中的ImageTk方法进行转换
img2 = ImageTk.PhotoImage(Image.open('./123.jpg'))
text.image_create('insert',image=img2)

root.mainloop()

只读

将 state 选项从默认的 "normal" 修改为 "disabled"，使得 Text 组件中的内容为“只读”形式。不过需要注意的是，当你需要进行任何修改的时候，记得将 state 选项改回 "normal"，否则 insert() 和 delete() 方法都会失效。

text['state'] = 'disabled'

搜索

使用search()方法，可以可以搜索 Text 组件中的内容

search()方法的 backwards 属性表示是否向后搜索

pos + '+1c'表示pos后一个字符，同理pos - '-1c'表示pos前一个字符

import tkinter as tk
from PIL import Image,ImageTk

root = tk.Tk()

# 创建Text
text = tk.Text(root,width=30,height=10)
text.pack()
text.insert('insert','hello\nworld')

lable = tk.Label(root)
lable.pack()

search_val = ''
search_start = 1.0
pos = ''

# 搜索函数
def search():
    global search_val,search_start,pos
    # 获取搜索框内的内容
    val = search_entry.get()
    # 判断搜索框内容如果变了的话就重新从头搜索
    if search_val != val:
        search_start = 1.0
        pos = None
        search_val = val
    # 在Text控件中搜索，返回索引
    pos = text.search(val,index=search_start,stopindex='end')
    # 如果没有搜索到，则显示 not found，并退出函数
    if not pos:
        lable['text'] = 'not found'
        search_val = ''
        return
    # 如果搜索到了，就显示索引
    lable['text'] = pos
    # 并且将下回搜索的开始位置设置到本次搜索结果后一个字符
    search_start = pos + '+1c'

# 搜索框与搜索按钮
search_entry = tk.Entry(root)
search_entry.pack()
search_btn = tk.Button(root,text='Search',command=search)
search_btn.pack()


root.mainloop()

恢复和撤销操作

通过设置 undo 选项为 True 可以开启 Text 组件的“撤销”功能。然后用 edit_undo() 方法实现“撤销”操作，用 edit_redo() 方法实现“恢复”操作。

这是因为 Text 组件内部有一个栈专门用于记录内容的每次变动，所以每次“撤销”操作就是一次弹栈操作，“恢复”就是再次压栈。

import tkinter as tk

root = tk.Tk()

# 此处开启Text控件的撤销操作
text = tk.Text(root,undo=True)
text.pack()

undo_btn = tk.Button(root,text='撤销',command=lambda :text.edit_undo())
redo_btn = tk.Button(root,text='恢复',command=lambda :text.edit_redo())
undo_btn.pack()
redo_btn.pack()

root.mainloop()

默认情况下，每一次完整的操作将会放入栈中。但怎么样算是一次完整的操作呢？Tkinter 觉得每次焦点切换、用户按下 Enter 键、删除、插入操作的转换等之前的操作算是一次完整的操作。也就是说你连续输入I love Python的话，一次的“撤销”操作就会将所有的内容删除。

如果不想这样，那么做法就是先将 autoseparators 选项设置为 False（因为这个选项是让 Tkinter 在认为一次完整的操作结束后自动插入“分隔符”），然后绑定键盘事件，每次有输入就用 edit_separator() 方法人为地插入一个“分隔符”：

import tkinter as tk
 
root = tk.Tk()
 
text = tk.Text(root, width=40, height=5, autoseparators=False, undo=True, maxundo=10)
text.pack()
 
def callback(event):
    text.edit_separator()
 
text.bind('<Key>', callback)
 
def move():
    text.edit_undo()
 
tk.Button(root, text = "撤销", command = move).pack()
 
root.mainloop()

常用方法

indexes 索引

Text 控件的操作，基本上都与索引有关，Tkinter 提供一系列不同的索引类型：

• line.column：（行.列），例如(1.0)代表第一行第一列
  • 注意：行号以 1 开始，列号则以 0 开始
  • 在需要指定索引的时候使用浮点值例如1.0代替也是可以的。
• line.end：（某一行的末尾），例如(1,end)代表第一行末尾
• insert：对应插入光标的位置。
• current：对应与鼠标坐标最接近的位置。不过，如果你紧按鼠标任何一个按钮，它会直到你松开它才响应。
• end：对应 Text 组件的文本缓冲区最后一个字符的下一个位置。
• user-defined marks：是对 Text 组件中位置的命名。例如insert和 current就是两个预先命名好的 marks，参考后面的 marks
• user-defined tags：代表可以分配给 Text 组件的特殊事件绑定和风格，参考后面的 tags
• selection(sel.first，sel.last)：selection 是一个名为 sel的特殊 tag，表示当前被选中的范围
  • 可以使用 sel.first 到 sel.last 来表示这个范围。如果没有选中的内容，那么 Tkinter 会抛出一个TclError 异常。
• window coordinate("@x,y")：使用窗口坐标作为索引。
  • 例如在一个事件绑定中，可以使用"@%d,%d" % (event.x, event.y)找到最接近鼠标位置的字符。
• embedded object name(window，images)：用于指向在 Text 组件中嵌入的 window 和 image 对象。
• expressions：用于修改任何格式的索引，用字符串的形式实现修改索引的表达式。
  • + count chars：将索引向前（->）移动 count 个字符，可以越过换行符，但不能超过 END 的位置。
  • - count chars：将索引向后（<-）移动 count 个字符，可以越过换行符，但不能超过 1.0 的位置
  • + count lines：将索引向前（->）移动 count 行，索引会尽量保持与移动前在同一列上，但如果移动后的那一行字符太少，将移动到该行的末尾
  • - count lines：将索引向后（<-）移动 count 行，索引会尽量保持与移动前在同一列上，但如果移动后的那一行字符太少，将移动到该行的末尾
  • linestart：将索引移动到当前索引所在行的起始位置，注意，使用该表达式前边必须有一个空格隔开
  • lineend：将索引移动到当前索引所在行的末尾，注意，使用该表达式前边必须有一个空格隔开
  • wordstart：将索引移动到当前索引指向的单词的开头，单词的定义是一系列字母、数字、下划线或任何非空白字符的组合，注意，使用该表达式前边必须有一个空格隔开
  • wordend：将索引移动到当前索引指向的单词的末尾，单词的定义是一系列字母、数字、下划线或任何非空白字符的组合，注意，使用该表达式前边必须有一个空格隔开
  • 此外：只要结果不产生歧义，关键字可以被缩写，空格也可以省略。例如：+ 5 chars 可以简写成 +5c

index()

index() 方法用于将所有支持的“索引”格式，即line.column（行、列）的格式

import tkinter as tk
from PIL import Image,ImageTk

root = tk.Tk()

# 创建Text
text = tk.Text(root,width=30,height=10)
text.pack()
text.insert('insert','hello\n')

lable = tk.Label(root,text=f'insert: {text.index('insert')},end: {text.index('end')}')
lable.pack()

root.mainloop()

此时的2.0表示索引insert也就是光标在第2行第0列；3.0表示索引end也就是文档结束在第3行第0列

Marks

Marks（标记）通常是嵌入到 Text 组件文本中的不可见对象。事实上 Marks 是指定字符间的位置，并跟随相应的字符一起移动。

insert 和 current 是 Tkinter 预定义的特殊 Marks，它们不能够被删除。

• insert 用于指定当前插入光标的位置，Tkinter 会在该位置绘制一个闪烁的光标（因此并不是所有的 Marks 都不可见）。
• current 用于指定与鼠标坐标最接近的位置。不过，如果你紧按鼠标任何一个按钮，它会直到你松开它才响应。

你还可以自定义任意数量的 Marks，Marks 的名字是由普通字符串组成，可以是除了空白字符外的任何字符（为了避免歧义，你应该起一个有意义的名字）。使用 mark_set() 方法创建和移动 Marks。

如果你在一个 Mark 标记的位置之前插入或删除文本，那么 Mark 跟着一并移动。删除 Marks 你需要使用 mark_unset() 方法，删除 Mark 周围的文本并不会删除 Mark 本身。

import tkinter as tk

root = tk.Tk()

text = tk.Text(root)
text.pack()

text.insert("1.0","HelloWorld")

text.mark_set("my_mark","1.2") # 在 e 和 l 中间插入一个 mark，命名为 my_mark

text.insert("my_mark","123") # my_mark的位置插入123

root.mainloop()

默认插入内容到 Mark，是插入到它的左侧（就是说插入一个字符的话，Mark 向后移动了一个字符的位置）。那能不能插入到 Mark 的右侧呢？其实是可以的，通过 mark_gravity() 方法就可以实现。

text.mark_gravity("my_mark", "left")  #默认是 "right"

Tags

gs（标签）通常用于改变 Text 组件中内容的样式和功能。你可以修改文本的字体、尺寸和颜色。另外，Tags 还允许你将文本、嵌入的组件和图片与键盘和鼠标等事件相关联。

sel

除了 user-defined tags（用户自定义的 Tags），还有一个预定义的特殊 Tag：sel用于表示对应的选中内容（如果有的话）。

例如实现获取选中内容：

import tkinter as tk

root = tk.Tk()

text = tk.Text(root)
text.pack()

lable = tk.Label(root)
lable.pack()

def get_select(e):
    w = text.get(text.index('sel.first'),text.index('sel.last'))
    lable['text'] = w

text.bind('<ButtonRelease-1>',get_select)

root.mainloop()

自定义Tags

你可以自定义任意数量的 Tags，Tags 的名字是由普通字符串组成，可以是除了空白字符外的任何字符。另外，任何文本内容都支持多个 Tags 描述，任何 Tag 也可以用于描述多个不同的文本内容。为指定文本添加 Tags 可以使用 tag_add() 方法：

import tkinter as tk

root = tk.Tk()

text = tk.Text(root)
text.pack()

text.insert('1.0','HelloWorld')
text.tag_add('my_tag_1','1.1') # 设置my_tag_1到第一行第二个字符
text.tag_config('my_tag_1',background='yellow',foreground='red') # 设置my_tag_1字符背景颜色和字体颜色

text.tag_add('my_tag_2','1.3','1.6') # 设置my_tag_2到第一行的第（四-七）的字符
text.tag_config('my_tag_2',background='black',foreground='white') # 设置my_tag_1字符背景颜色和字体颜色


root.mainloop()

使用 tag_config() 方法可以设置 Tags 的样式，具体参数如下：

Tags 还支持事件绑定，使用的是 tag_bind() 的方法。

下边例子中我们将文本（"Python.com"）与鼠标事件进行绑定，当鼠标进入该文本段的时候，鼠标样式切换为 "arrow" 形态，离开文本段的时候切换回 "xterm" 形态。当触发鼠标“左键点击操作”事件的时候，使用默认浏览器打开Python的首页（https://www.python.org/）：

import tkinter as tk
import webbrowser
 
root = tk.Tk()
 
text = tk.Text(root, width=40, height=5)
text.pack()
 
text.insert("insert", "I love Python.com!")
 
text.tag_add("link", "1.7", "1.17")
text.tag_config("link", foreground = "blue", underline = True)
 
def show_arrow_cursor(event):
    text.config(cursor = "arrow")
 
def show_xterm_cursor(event):
    text.config(cursor = "xterm")
 
def click(event):
    webbrowser.open("https://www.python.org/")
 
text.tag_bind("link", "<Enter>", show_arrow_cursor)
text.tag_bind("link", "<Leave>", show_xterm_cursor)
text.tag_bind("link", "<Button-1>", click)
 
root.mainloop()