如何突出显示文本小部件的当前行？

Question

我正在使用 Python 开发一个简单的 GUI 代码编辑器，我希望光标所在的文本行始终处于突出显示状态。

现在，我的TextEditor 类看起来像：

class TextEditor:

   def __init__(self, container):
      self.scrollbar = Scrollbar(container)
      self.scrollbar.pack(side=RIGHT, fill=Y)

      self.textbox = Text(container, height=40, undo=True, width=80,
                          font=tkFont.Font(family="Consolas", size=12))
      self.textbox.pack(side=LEFT)

      self.textbox.config(yscrollcommand=self.scrollbar.set)
      self.scrollbar.config(command=self.textbox.yview)

我该怎么做？

Answer 1

tkinter 没有内置任何东西直接支持这一点。但是，对于大多数用途来说已经足够好的方法是编写一个函数来轮询光标位置并定期更新突出显示。

例如：

import Tkinter as tk

class MyApp(tk.Tk):
    def __init__(self, *args, **kwargs):
        tk.Tk.__init__(self, *args, **kwargs)
        self.text = tk.Text(self)
        self.text.pack(side="top", fill="both", expand=True)
        self.text.tag_configure("current_line", background="#e9e9e9")
        self._highlight_current_line()

    def _highlight_current_line(self, interval=100):
        '''Updates the 'current line' highlighting every "interval" milliseconds'''
        self.text.tag_remove("current_line", 1.0, "end")
        self.text.tag_add("current_line", "insert linestart", "insert lineend+1c")
        self.after(interval, self._highlight_current_line)

app = MyApp()
app.mainloop()

显然，间隔越长，引入的“滞后”就越多，间隔越短，使用的 CPU 越多，但在几乎没有可察觉的滞后和难以察觉的两个极端之间存在相当大的最佳平衡点增加 CPU 使用率。

还有另一种不涉及轮询且绝对万无一失的方法。您可以将突出显示移动到插入光标实际移动的精确位置，但这涉及编写一些嵌入式 Tcl 代码来创建隐藏在 Tkinter Text 对象的实现中的实际 tk 小部件的代理。

最后，第三种方法是为所有可能修改光标位置的事件设置自定义绑定。虽然可能，但很难做到 100% 正确，因为您必须考虑修改光标位置的所有 事件，以及处理代码中可能在不使用事件的情况下移动光标的位置。尽管如此，使用绑定是一个非常好的解决方案，它只是需要更多的工作。

Answer 2

绝对不需要轮询like Bryan Oakley says in his answer，也不需要在 Python 代码中嵌入 Tcl 代码。我的解决方案是绑定到可能最终移动光标的事件，即<Key> 和<Button-1>。

import tkinter as tk

class CurrentHighlightedLineText(tk.Text):

    """Text widget with current line highlighted"""

    def __init__(self, root, *args, **kwargs):
        tk.Text.__init__(self, root, *args, **kwargs)

        self.tag_configure('currentLine', background='#e9e9e9')
        self.bind('<Key>', lambda _: self.highlightCurrentLine())
        self.bind('<Button-1>', lambda _: self.highlightCurrentLine())
        self.highlightCurrentLine(delay=0)

    def highlightCurrentLine(self, delay=10):

        def delayedHighlightCurrentLine():
            self.tag_remove('currentLine', 1.0, "end")
            self.tag_add('currentLine', 'insert linestart', 'insert lineend+1c')
        # This bound function is called before the cursor actually moves.
        # So delay checking the cursor position and moving the highlight 10 ms.

        self.after(delay, delayedHighlightCurrentLine)


if __name__ == "__main__":
    root = tk.Tk()

    text = CurrentHighlightedLineText(root)
    text.grid(row=0, column=0, sticky='nesw')

    root.grid_rowconfigure(0, weight=1)
    root.grid_columnconfigure(0, weight=1)

    root.mainloop()

Answer 3

只是为了扩展 Bryan Oakley 的回答：当您想要选择一些包含当前行的部分但不是全部的文本时，简单地突出显示当前行会变得很痛苦，因为当前行的选定部分是使用当前行颜色而不是选定文本颜色着色，因此很难一眼看出当前行的哪一部分被选中。

所以我修改了 Bryan 的示例代码，如果选择了任何文本，则不会突出显示当前行：

import Tkinter as tk

class MyApp(tk.Tk):
    def __init__(self, *args, **kwargs):
        tk.Tk.__init__(self, *args, **kwargs)
        self.text = tk.Text(self)
        self.text.pack(side="top", fill="both", expand=True)
        self.text.tag_configure("current_line", background="#e9e9e9")
        self._highlight_current_line()

    def _highlight_current_line(self, interval=100):
        '''Rehighlights the 'current line' every "interval" milliseconds'''
        self.text.tag_remove("current_line", 1.0, "end")

        # If text is selected, DON'T highlight the current line.
        try:
            text = self.text.get(tk.SEL_FIRST, tk.SEL_LAST)
        except tk.TclError:
            self.text.tag_add("current_line",
                                "insert linestart", "insert lineend+1c")

        self.after(interval, self._highlight_current_line)

app = MyApp()
app.mainloop()

我希望这对某人有所帮助。