Source code for ttkwidgets.debugwindow

"""
Author: RedFantom
License: GNU GPLv3
Source: This repository
"""
try:
    import Tkinter as tk
    import ttk
    import tkFileDialog as fd
except ImportError:
    import tkinter as tk
    from tkinter import ttk
    import tkinter.filedialog as fd
import sys
from ttkwidgets import AutoHideScrollbar


class DebugWindow(tk.Toplevel):
    """
    A Toplevel that shows sys.stdout and sys.stderr for Tkinter applications
    """
    def __init__(self, master=None, title="Debug window", stdout=True, 
                 stderr=False, width=70, autohidescrollbar=True, **kwargs):
        """
        Create a Debug window.
        
        :param master: master widget
        :type master: widget
        :param stdout: whether to redirect stdout to the widget
        :type stdout: bool
        :param stderr:  whether to redirect stderr to the widget
        :type stderr: bool
        :param width: window width (in characters)
        :type width: int
        :param autohidescrollbar: whether to use an :class:`~ttkwidgets.AutoHideScrollbar` or a :class:`ttk.Scrollbar`
        :type autohidescrollbar: bool
        :param kwargs: options to be passed on to the :class:`tk.Toplevel` initializer
        """
        self._width = width
        tk.Toplevel.__init__(self, master, **kwargs)
        self.columnconfigure(0, weight=1)
        self.rowconfigure(0, weight=1)
        self.protocol("WM_DELETE_WINDOW", self.quit)
        self.wm_title(title)
        self._oldstdout = sys.stdout
        self._oldstderr = sys.stderr
        if stdout:
            sys.stdout = self
        if stderr:
            sys.stderr = self
        self.menu = tk.Menu(self)
        self.config(menu=self.menu)
        self.filemenu = tk.Menu(self.menu, tearoff=0)
        self.filemenu.add_command(label="Save file", command=self.save)
        self.filemenu.add_command(label="Exit", command=self.quit)
        self.menu.add_cascade(label="File", menu=self.filemenu)
        self.text = tk.Text(self, width=width, wrap=tk.WORD)
        if autohidescrollbar:
            self.scroll = AutoHideScrollbar(self, orient=tk.VERTICAL, command=self.text.yview)
        else:
            self.scroll = ttk.Scrollbar(self, orient=tk.VERTICAL, command=self.text.yview)
        self.text.config(yscrollcommand=self.scroll.set)
        self.text.bind("<Key>", lambda e: "break")
        self._grid_widgets()

    def save(self):
        """Save widget content."""
        file_name = fd.asksaveasfilename()
        if file_name is "" or file_name is None:
            return
        with open(file_name, "w") as f:
            f.write(self.text.get("1.0", tk.END))

    def _grid_widgets(self):
        self.text.grid(row=0, column=0, sticky="nsew")
        self.scroll.grid(row=0, column=1, sticky="ns")

    def write(self, line):
        """
        Write line at the end of the widget.
        
        :param line: text to insert in the widget
        :type line: str
        """
        self.text.insert(tk.END, line)

    def flush(self):
        pass

    def quit(self):
        """Restore previous stdout/stderr and destroy the window."""
        sys.stdout = self._oldstdout
        sys.stderr = self._oldstderr
        self.destroy()