Tkinter在文本小部件中添加行号

时间:2013-05-04 00:43:31

标签: python tkinter

尝试学习tkinter和python。我想在相邻的框架中显示文本小部件的行号

from Tkinter import *
root = Tk()
txt = Text(root)
txt.pack(expand=YES, fill=BOTH)
frame= Frame(root, width=25)
#

frame.pack(expand=NO, fill=Y, side=LEFT)
root.mainloop()

我在一个名为unpythonic的网站上看到过一个例子,但它假设txt的行高为6像素。

我正在尝试这样的事情:

1)将Any-KeyPress事件绑定到返回按键发生的行的函数:

textPad.bind("<Any-KeyPress>", linenumber)


def linenumber(event=None):
    line, column = textPad.index('end').split('.')
    #creating line number toolbar
    try:
       linelabel.pack_forget()
       linelabel.destroy()
       lnbar.pack_forget()
       lnbar.destroy()
    except:
      pass
   lnbar = Frame(root,  width=25)
   for i in range(0, len(line)):
      linelabel= Label(lnbar, text=i)
      linelabel.pack(side=LEFT)
      lnbar.pack(expand=NO, fill=X, side=LEFT)

不幸的是,这会在帧上给出一些奇怪的数字。 有更简单的解决方案吗? 如何处理?

5 个答案:

答案 0 :(得分:29)

我有一个相对简单的解决方案,但它很复杂,可能很难理解,因为它需要了解Tkinter和底层tcl / tk文本小部件的工作原理。我将在这里作为一个完整的解决方案提供,您可以按原样使用,因为我认为它说明了一种非常有效的独特方法。

请注意,无论您使用何种字体,以及是否在不同的行上使用不同的字体,嵌入的小部件等,此解决方案都能正常工作。

导入Tkinter

在我们开始之前,以下代码假设如果您使用python 3.0或更高版本,则会像这样导入tkinter:

import tkinter as tk

...或者这个,对于python 2.x:

import Tkinter as tk

行号小部件

让我们来解决行号的显示问题。我们想要做的是使用画布,以便我们可以精确定位数字。我们将创建一个自定义类,并为其提供一个名为redraw的新方法,该方法将重新绘制关联文本小部件的行号。我们还为它提供了一个方法attach,用于将文本小部件与此小部件相关联。

此方法利用了这样一个事实:文本小部件本身可以通过dlineinfo方法准确地告诉我们文本行的开始和结束位置。这可以准确地告诉我们在画布上绘制行号的位置。它还利用dlineinfo如果一条线不可见则返回None的事实,我们可以用它来知道何时停止显示行号。

class TextLineNumbers(tk.Canvas):
    def __init__(self, *args, **kwargs):
        tk.Canvas.__init__(self, *args, **kwargs)
        self.textwidget = None

    def attach(self, text_widget):
        self.textwidget = text_widget

    def redraw(self, *args):
        '''redraw line numbers'''
        self.delete("all")

        i = self.textwidget.index("@0,0")
        while True :
            dline= self.textwidget.dlineinfo(i)
            if dline is None: break
            y = dline[1]
            linenum = str(i).split(".")[0]
            self.create_text(2,y,anchor="nw", text=linenum)
            i = self.textwidget.index("%s+1line" % i)

如果您将其与文本小部件相关联,然后调用redraw方法,则应该显示行号。

自动更新行号

这有效,但有一个致命的缺陷:你必须知道何时拨打redraw。您可以创建一个在每次按键时触发的绑定,但您还必须触发鼠标按钮,并且您必须处理用户按下键并使用自动重复功能等的情况。行号也需要如果窗口增长或缩小或者用户滚动,则重新绘制,因此我们陷入了一个试图找出可能导致数字发生变化的每个可能事件的兔子洞。

还有另一种解决方案,即只要有变化,文本窗口小部件就会触发事件。不幸的是,文本小部件没有直接支持通知程序的更改。为了解决这个问题,我们可以使用代理来拦截对文本小部件的更改并为我们生成一个事件。

在对“binding to cursor movement doesnt change INSERT mark”问题的回答中,我提供了一个类似的解决方案,该解决方案展示了如何让文本小部件在发生变化时调用回调。这一次,我们将生成一个事件而不是回调,因为我们的需求有点不同。

自定义文本类

这是一个创建自定义文本小部件的类,无论何时插入或删除文本,或者滚动视图,都会生成<<Change>>事件。

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

        # create a proxy for the underlying widget
        self._orig = self._w + "_orig"
        self.tk.call("rename", self._w, self._orig)
        self.tk.createcommand(self._w, self._proxy)

    def _proxy(self, *args):
        # let the actual widget perform the requested action
        cmd = (self._orig,) + args
        result = self.tk.call(cmd)

        # generate an event if something was added or deleted,
        # or the cursor position changed
        if (args[0] in ("insert", "replace", "delete") or 
            args[0:3] == ("mark", "set", "insert") or
            args[0:2] == ("xview", "moveto") or
            args[0:2] == ("xview", "scroll") or
            args[0:2] == ("yview", "moveto") or
            args[0:2] == ("yview", "scroll")
        ):
            self.event_generate("<<Change>>", when="tail")

        # return what the actual widget returned
        return result        

全部放在一起

最后,这是一个使用这两个类的示例程序:

class Example(tk.Frame):
    def __init__(self, *args, **kwargs):
        tk.Frame.__init__(self, *args, **kwargs)
        self.text = CustomText(self)
        self.vsb = tk.Scrollbar(orient="vertical", command=self.text.yview)
        self.text.configure(yscrollcommand=self.vsb.set)
        self.text.tag_configure("bigfont", font=("Helvetica", "24", "bold"))
        self.linenumbers = TextLineNumbers(self, width=30)
        self.linenumbers.attach(self.text)

        self.vsb.pack(side="right", fill="y")
        self.linenumbers.pack(side="left", fill="y")
        self.text.pack(side="right", fill="both", expand=True)

        self.text.bind("<<Change>>", self._on_change)
        self.text.bind("<Configure>", self._on_change)

        self.text.insert("end", "one\ntwo\nthree\n")
        self.text.insert("end", "four\n",("bigfont",))
        self.text.insert("end", "five\n")

    def _on_change(self, event):
        self.linenumbers.redraw()

...当然,在文件的末尾添加它来引导它:

if __name__ == "__main__":
    root = tk.Tk()
    Example(root).pack(side="top", fill="both", expand=True)
    root.mainloop()

答案 1 :(得分:2)

  

我在一个名为unpythonic的网站上看到过一个例子,但它假设txt 的行高为6像素

比较

  

#假设每行至少6像素高   step = 6

step - 为新行编程检查文本小部件的频率(以像素为单位)。如果文本小部件中的行高为30像素,则此程序执行5次检查并仅绘制一个数字 如果字体非常小,您可以将其设置为&lt; 6的值 有一个条件:text小部件中的所有符号必须使用一种字体,而绘制数字的小部件必须使用相同的字体。

# http://tkinter.unpythonic.net/wiki/A_Text_Widget_with_Line_Numbers
class EditorClass(object):
    ...


    self.lnText = Text(self.frame,
                    ...
                    state='disabled', font=('times',12))
    self.lnText.pack(side=LEFT, fill='y')
    # The Main Text Widget
    self.text = Text(self.frame,
                        bd=0,
                        padx = 4, font=('times',12))
    ...

答案 2 :(得分:1)

这是我尝试做同样的事情。我尝试了上面的Bryan Oakley的答案,看起来效果很好,但它的性价比却很高。每当我在窗口小部件中加载大量行时,都需要很长时间才能完成。为了解决这个问题,我使用了一个普通的Text小部件来绘制行号,这是我如何做到的:

创建文本小部件并将其网格化到您要添加行的主文本小部件的左侧,让我们将其称为textarea。确保您还使用与textarea

相同的字体
self.linenumbers = Text(self, width=3)
self.linenumbers.grid(row=__textrow, column=__linenumberscol, sticky=NS)
self.linenumbers.config(font=self.__myfont)

添加标记以右对齐添加到行号窗口小部件的所有行,让我们称之为line

self.linenumbers.tag_configure('line', justify='right')

禁用窗口小部件,以便用户无法编辑它

self.linenumbers.config(state=DISABLED)

现在棘手的部分是添加一个滚动条,让我们称之为uniscrollbar来控制主文本小部件和行号文本小部件。为了做到这一点,我们首先需要两个方法,一个由滚动条调用,然后可以更新两个文本小部件以反映新位置,另一个在滚动文本区域时调用,这将更新滚动条:

def __scrollBoth(self, action, position, type=None):
    self.textarea.yview_moveto(position)
    self.linenumbers.yview_moveto(position)

def __updateScroll(self, first, last, type=None):
    self.textarea.yview_moveto(first)
    self.linenumbers.yview_moveto(first)
    self.uniscrollbar.set(first, last)

现在我们已准备好创建uniscrollbar

    self.uniscrollbar= Scrollbar(self)
    self.uniscrollbar.grid(row=self.__uniscrollbarRow, column=self.__uniscrollbarCol, sticky=NS)
    self.uniscrollbar.config(command=self.__scrollBoth)
    self.textarea.config(yscrollcommand=self.__updateScroll)
    self.linenumbers.config(yscrollcommand=self.__updateScroll)

瞧!您现在拥有一个非常轻量级的文本小部件,其中包含行号:

enter image description here

答案 3 :(得分:0)

根据Bryan Oakley的回答,我使用了一种非常简单的方法。而不是监听所做的任何更改,只需使用self.after()方法“刷新”窗口小部件,该方法会在几毫秒后调度一个调用。这样做非常简单。在这个例子中,我在瞬间附加了文本小部件,但如果你愿意,你可以稍后再这样做。

class TextLineNumbers(tk.Canvas):
        def __init__(self, textwidget, *args, **kwargs):
        tk.Canvas.__init__(self, *args, **kwargs)
        self.textwidget = textwidget
        self.redraw()

    def redraw(self, *args):
        '''redraw line numbers'''
        self.delete("all")

        i = self.textwidget.index("@0,0")
        while True :
            dline= self.textwidget.dlineinfo(i)
            if dline is None: break
            y = dline[1]
            linenum = str(i).split(".")[0]
            self.create_text(2,y,anchor="nw", text=linenum)
            i = self.textwidget.index("%s+1line" % i)

        # Refreshes the canvas widget 30fps
        self.after(30, self.redraw)

答案 4 :(得分:0)

在通读了这里提到的每个解决方案并亲自尝试了其中的一些解决方案之后,我决定使用Brian Oakley的解决方案进行一些修改。这可能不是一个更有效的解决方案,但对于正在寻求一种快速且易于实现的方法(原则上也很简单)的人来说应该足够了。

它以相同的方式绘制线条,但是与其生成<<Change>>事件,它只是将按键,滚动,左击事件绑定到文本以及将左击事件绑定到滚动条。为了不出现故障,例如执行粘贴命令,然后等待2ms才真正重绘行号。

编辑:这也类似于FoxDot的解决方案,但是与其持续刷新行号,不如仅刷新绑定事件

下面是一个示例代码,其中实现了延迟以及我的滚动实现

import tkinter as tk


# This is a scrollable text widget
class ScrollText(tk.Frame):
    def __init__(self, master, *args, **kwargs):
        tk.Frame.__init__(self, *args, **kwargs)
        self.text = tk.Text(self, bg='#2b2b2b', foreground="#d1dce8", 
                            insertbackground='white',
                            selectbackground="blue", width=120, height=30)

        self.scrollbar = tk.Scrollbar(self, orient=tk.VERTICAL, command=self.text.yview)
        self.text.configure(yscrollcommand=self.scrollbar.set)

        self.numberLines = TextLineNumbers(self, width=40, bg='#313335')
        self.numberLines.attach(self.text)

        self.scrollbar.pack(side=tk.RIGHT, fill=tk.Y)
        self.numberLines.pack(side=tk.LEFT, fill=tk.Y, padx=(5, 0))
        self.text.pack(side=tk.RIGHT, fill=tk.BOTH, expand=True)

        self.text.bind("<Key>", self.onPressDelay)
        self.text.bind("<Button-1>", self.numberLines.redraw)
        self.scrollbar.bind("<Button-1>", self.onScrollPress)
        self.text.bind("<MouseWheel>", self.onPressDelay)

    def onScrollPress(self, *args):
        self.scrollbar.bind("<B1-Motion>", self.numberLines.redraw)

    def onScrollRelease(self, *args):
        self.scrollbar.unbind("<B1-Motion>", self.numberLines.redraw)

    def onPressDelay(self, *args):
        self.after(2, self.numberLines.redraw)

    def get(self, *args, **kwargs):
        return self.text.get(*args, **kwargs)

    def insert(self, *args, **kwargs):
        return self.text.insert(*args, **kwargs)

    def delete(self, *args, **kwargs):
        return self.text.delete(*args, **kwargs)

    def index(self, *args, **kwargs):
        return self.text.index(*args, **kwargs)

    def redraw(self):
        self.numberLines.redraw()


'''THIS CODE IS CREDIT OF Bryan Oakley (With minor visual modifications on my side): 
https://stackoverflow.com/questions/16369470/tkinter-adding-line-number-to-text-widget'''


class TextLineNumbers(tk.Canvas):
    def __init__(self, *args, **kwargs):
        tk.Canvas.__init__(self, *args, **kwargs, highlightthickness=0)
        self.textwidget = None

    def attach(self, text_widget):
        self.textwidget = text_widget

    def redraw(self, *args):
        '''redraw line numbers'''
        self.delete("all")

        i = self.textwidget.index("@0,0")
        while True :
            dline= self.textwidget.dlineinfo(i)
            if dline is None: break
            y = dline[1]
            linenum = str(i).split(".")[0]
            self.create_text(2, y, anchor="nw", text=linenum, fill="#606366")
            i = self.textwidget.index("%s+1line" % i)


'''END OF Bryan Oakley's CODE'''

if __name__ == '__main__':
    root = tk.Tk()
    scroll = ScrollText(root)
    scroll.insert(tk.END, "HEY" + 20*'\n')
    scroll.pack()
    scroll.text.focus()
    root.after(200, scroll.redraw())
    root.mainloop()

此外,我注意到在Brian Oakley的代码中,如果您使用鼠标滚轮滚动(并且可滚动文本已满),则顶部的数字行有时会出现毛刺并与实际文本不同步,这就是为什么我决定首先添加延迟。 尽管我仅在自己的“滚动文本”窗口小部件实现上对其进行了测试,所以此错误可能是我的解决方案所独有的,尽管它仍然很特殊