カスタムポップアップtkinterダイアログボックスを実装する正しい方法

Question

カスタムポップアップダイアログボックスの作成方法を学び始めたばかりです。結局のところ、_tkinter messagebox_は本当に簡単に使用できますが、あまり多くのことも行いません。ここでは、入力を取得してユーザー名に保存するダイアログボックスを作成しようとしています。

私の質問は、これを実装するための推奨スタイルは何ですか？ Bryan Oakleyが このコメント で提案したように。

グローバル変数の使用はお勧めしません。ダイアログ自体を破棄する代わりに、実際のウィジェットのみを破棄し、オブジェクトはそのままにしておきます。次に、inputDialog.get_string()のようなものを呼び出してから、メインロジックから_del inputDialog_を呼び出します。

グローバル変数を使用して文字列を返すことは最善のアイデアではありませんが、なぜですか？そして、提案された方法は何ですか？ウィンドウが破棄されたらgetstringをトリガーする方法がわからないため、混乱します。実際のウィジェットを破棄する行は、彼がTopLevelを参照しているかどうかわかりません。

私が尋ねる理由は、送信ボタンを押した後にポップアップボックスを破棄したいからです。結局のところ、メインプログラムに戻ったり、何かを更新したりする必要があるからです。この場合、ボタンメソッドsendはどうすればよいのでしょうか。この特定の例のアイデアは、ユーザーが望むなら何度でもそれを行えるようにすることだからです。

_import tkinter as tk

class MyDialog:
    def __init__(self, parent):
        top = self.top = tk.Toplevel(parent)
        self.myLabel = tk.Label(top, text='Enter your username below')
        self.myLabel.pack()

        self.myEntryBox = tk.Entry(top)
        self.myEntryBox.pack()

        self.mySubmitButton = tk.Button(top, text='Submit', command=self.send)
        self.mySubmitButton.pack()

    def send(self):
        global username
        username = self.myEntryBox.get()
        self.top.destroy()

def onClick():
    inputDialog = MyDialog(root)
    root.wait_window(inputDialog.top)
    print('Username: ', username)

username = 'Empty'
root = tk.Tk()
mainLabel = tk.Label(root, text='Example for pop up input box')
mainLabel.pack()

mainButton = tk.Button(root, text='Click me', command=onClick)
mainButton.pack()

root.mainloop()
_

Answer 1

global statement の使用は、思い浮かぶ2つのシナリオでは不要です。

1. withメインGUIを使用するためにインポートできるダイアログボックスをコーディングする場合
2. withoutメインGUIを使用するためにインポートできるダイアログボックスをコーディングしたい

---

withメインGUIを使用するためにインポートできるダイアログボックスのコーディング

---

ダイアログボックスのインスタンスを作成するときに辞書とキーを渡すことで、グローバルステートメントを回避できます。辞書とキーは、 lambda を使用して、ボタンのコマンドに関連付けることができます。これにより、ボタンが押されたときに（argsを使用して）関数呼び出しを実行する匿名関数が作成されます。

親をクラス属性（この例ではルート）にバインドすることにより、ダイアログボックスのインスタンスを作成するたびに親を渡す必要を回避できます。

以下を_mbox.py_として_your_python_folder\Lib\site-packages_として、またはメインGUIのファイルと同じフォルダーに保存できます。

_import tkinter

class Mbox(object):

    root = None

    def __init__(self, msg, dict_key=None):
        """
        msg = <str> the message to be displayed
        dict_key = <sequence> (dictionary, key) to associate with user input
        (providing a sequence for dict_key creates an entry for user input)
        """
        tki = tkinter
        self.top = tki.Toplevel(Mbox.root)

        frm = tki.Frame(self.top, borderwidth=4, relief='ridge')
        frm.pack(fill='both', expand=True)

        label = tki.Label(frm, text=msg)
        label.pack(padx=4, pady=4)

        caller_wants_an_entry = dict_key is not None

        if caller_wants_an_entry:
            self.entry = tki.Entry(frm)
            self.entry.pack(pady=4)

            b_submit = tki.Button(frm, text='Submit')
            b_submit['command'] = lambda: self.entry_to_dict(dict_key)
            b_submit.pack()

        b_cancel = tki.Button(frm, text='Cancel')
        b_cancel['command'] = self.top.destroy
        b_cancel.pack(padx=4, pady=4)

    def entry_to_dict(self, dict_key):
        data = self.entry.get()
        if data:
            d, key = dict_key
            d[key] = data
            self.top.destroy()
_

effbot で、TopLevelおよびtkSimpleDialog（py3のtkinter.simpledialog）をサブクラス化する例を見ることができます。

ttk widgets は、この例のtkinterウィジェットと交換可能であることに注意してください。

ダイアログボックスを正確に中央に配置するには、→ this と読みます。

使用例：

_import tkinter
import mbox

root = tkinter.Tk()

Mbox = mbox.Mbox
Mbox.root = root

D = {'user':'Bob'}

b_login = tkinter.Button(root, text='Log in')
b_login['command'] = lambda: Mbox('Name?', (D, 'user'))
b_login.pack()

b_loggedin = tkinter.Button(root, text='Current User')
b_loggedin['command'] = lambda: Mbox(D['user'])
b_loggedin.pack()

root.mainloop()
_

---

メインGUIなしでを使用するためにインポートできるダイアログボックスをコーディングする

---

ダイアログボックスクラス（ここではMessageBox）を含むモジュールを作成します。また、そのクラスのインスタンスを作成し、最後に押されたボタンの値（またはEntryウィジェットからのデータ）を返す関数を含めます。

これらの参照を使用してカスタマイズできる完全なモジュールを次に示します。 NMTech ＆ Effbot 。
次のコードを_mbox.py_として_your_python_folder\Lib\site-packages_として保存します

_import tkinter

class MessageBox(object):

    def __init__(self, msg, b1, b2, frame, t, entry):

        root = self.root = tkinter.Tk()
        root.title('Message')
        self.msg = str(msg)
        # ctrl+c to copy self.msg
        root.bind('<Control-c>', func=self.to_clip)
        # remove the outer frame if frame=False
        if not frame: root.overrideredirect(True)
        # default values for the buttons to return
        self.b1_return = True
        self.b2_return = False
        # if b1 or b2 is a Tuple unpack into the button text & return value
        if isinstance(b1, Tuple): b1, self.b1_return = b1
        if isinstance(b2, Tuple): b2, self.b2_return = b2
        # main frame
        frm_1 = tkinter.Frame(root)
        frm_1.pack(ipadx=2, ipady=2)
        # the message
        message = tkinter.Label(frm_1, text=self.msg)
        message.pack(padx=8, pady=8)
        # if entry=True create and set focus
        if entry:
            self.entry = tkinter.Entry(frm_1)
            self.entry.pack()
            self.entry.focus_set()
        # button frame
        frm_2 = tkinter.Frame(frm_1)
        frm_2.pack(padx=4, pady=4)
        # buttons
        btn_1 = tkinter.Button(frm_2, width=8, text=b1)
        btn_1['command'] = self.b1_action
        btn_1.pack(side='left')
        if not entry: btn_1.focus_set()
        btn_2 = tkinter.Button(frm_2, width=8, text=b2)
        btn_2['command'] = self.b2_action
        btn_2.pack(side='left')
        # the enter button will trigger the focused button's action
        btn_1.bind('<KeyPress-Return>', func=self.b1_action)
        btn_2.bind('<KeyPress-Return>', func=self.b2_action)
        # roughly center the box on screen
        # for accuracy see: https://stackoverflow.com/a/10018670/1217270
        root.update_idletasks()
        xp = (root.winfo_screenwidth() // 2) - (root.winfo_width() // 2)
        yp = (root.winfo_screenheight() // 2) - (root.winfo_height() // 2)
        geom = (root.winfo_width(), root.winfo_height(), xp, yp)
        root.geometry('{0}x{1}+{2}+{3}'.format(*geom))
        # call self.close_mod when the close button is pressed
        root.protocol("WM_DELETE_WINDOW", self.close_mod)
        # a trick to activate the window (on windows 7)
        root.deiconify()
        # if t is specified: call time_out after t seconds
        if t: root.after(int(t*1000), func=self.time_out)

    def b1_action(self, event=None):
        try: x = self.entry.get()
        except AttributeError:
            self.returning = self.b1_return
            self.root.quit()
        else:
            if x:
                self.returning = x
                self.root.quit()

    def b2_action(self, event=None):
        self.returning = self.b2_return
        self.root.quit()

    # remove this function and the call to protocol
    # then the close button will act normally
    def close_mod(self):
        pass

    def time_out(self):
        try: x = self.entry.get()
        except AttributeError: self.returning = None
        else: self.returning = x
        finally: self.root.quit()

    def to_clip(self, event=None):
        self.root.clipboard_clear()
        self.root.clipboard_append(self.msg)
_

そして：

_def mbox(msg, b1='OK', b2='Cancel', frame=True, t=False, entry=False):
    """Create an instance of MessageBox, and get data back from the user.
    msg = string to be displayed
    b1 = text for left button, or a Tuple (<text for button>, <to return on press>)
    b2 = text for right button, or a Tuple (<text for button>, <to return on press>)
    frame = include a standard outerframe: True or False
    t = time in seconds (int or float) until the msgbox automatically closes
    entry = include an entry widget that will have its contents returned: True or False
    """
    msgbox = MessageBox(msg, b1, b2, frame, t, entry)
    msgbox.root.mainloop()
    # the function pauses here until the mainloop is quit
    msgbox.root.destroy()
    return msgbox.returning
_

mboxがMessageBoxのインスタンスを作成した後、メインループを開始し、
メインループがroot.quit()を介して終了するまで、そこで関数を効果的に停止します。
mbox関数は_msgbox.returning_にアクセスし、その値を返すことができます。

例：

_user = {}
mbox('starting in 1 second...', t=1)
user['name'] = mbox('name?', entry=True)
if user['name']:
    user['sex'] = mbox('male or female?', ('male', 'm'), ('female', 'f'))
    mbox(user, frame=False)
_

Answer 2

オブジェクトinputDialogは破棄されないため、オブジェクト属性にアクセスできました。戻り文字列を属性として追加しました：

import tkinter as tk

class MyDialog:

    def __init__(self, parent):
        top = self.top = tk.Toplevel(parent)
        self.myLabel = tk.Label(top, text='Enter your username below')
        self.myLabel.pack()
        self.myEntryBox = tk.Entry(top)
        self.myEntryBox.pack()
        self.mySubmitButton = tk.Button(top, text='Submit', command=self.send)
        self.mySubmitButton.pack()

    def send(self):
        self.username = self.myEntryBox.get()
        self.top.destroy()

def onClick():
    inputDialog = MyDialog(root)
    root.wait_window(inputDialog.top)
    print('Username: ', inputDialog.username)

root = tk.Tk()
mainLabel = tk.Label(root, text='Example for pop up input box')
mainLabel.pack()

mainButton = tk.Button(root, text='Click me', command=onClick)
mainButton.pack()

root.mainloop()

Answer 3

コードの正直な阿部の2番目の部分 タイトル：

メインGUIなしで使用するためにインポートできるダイアログボックスのコーディング

テンプレートとして、いくつかの変更を加えました。エントリーではなくコンボボックスが必要だったので、それも実装しました。他に何かが必要な場合は、変更するのはかなり簡単です。

以下が変更点です

• 子供として行動する
• 親のモーダル
• 親の上に中央揃え
• サイズ変更不可
• エントリではなくコンボボックス
• クロス（X）をクリックしてダイアログを閉じます

削除済み

• フレーム、タイマー、クリップボード

以下をmbox.pyとしてyour_python_folder\Lib\site-packagesとして、またはメインGUIのファイルと同じフォルダーに保存します。

import tkinter
import tkinter.ttk as ttk

class MessageBox(object):

    def __init__(self, msg, b1, b2, parent, cbo, cboList):

        root = self.root = tkinter.Toplevel(parent)

        root.title('Choose')
        root.geometry('100x100')
        root.resizable(False, False)
        root.grab_set() # modal

        self.msg = str(msg)
        self.b1_return = True
        self.b2_return = False
        # if b1 or b2 is a Tuple unpack into the button text & return value
        if isinstance(b1, Tuple): b1, self.b1_return = b1
        if isinstance(b2, Tuple): b2, self.b2_return = b2
        # main frame
        frm_1 = tkinter.Frame(root)
        frm_1.pack(ipadx=2, ipady=2)
        # the message
        message = tkinter.Label(frm_1, text=self.msg)
        if cbo: message.pack(padx=8, pady=8)
        else: message.pack(padx=8, pady=20)
        # if entry=True create and set focus
        if cbo:
            self.cbo = ttk.Combobox(frm_1, state="readonly", justify="center", values= cboList)
            self.cbo.pack()
            self.cbo.focus_set()
            self.cbo.current(0)
        # button frame
        frm_2 = tkinter.Frame(frm_1)
        frm_2.pack(padx=4, pady=4)
        # buttons
        btn_1 = tkinter.Button(frm_2, width=8, text=b1)
        btn_1['command'] = self.b1_action
        if cbo: btn_1.pack(side='left', padx=5)
        else: btn_1.pack(side='left', padx=10)
        if not cbo: btn_1.focus_set()
        btn_2 = tkinter.Button(frm_2, width=8, text=b2)
        btn_2['command'] = self.b2_action
        if cbo: btn_2.pack(side='left', padx=5)
        else: btn_2.pack(side='left', padx=10)
        # the enter button will trigger the focused button's action
        btn_1.bind('<KeyPress-Return>', func=self.b1_action)
        btn_2.bind('<KeyPress-Return>', func=self.b2_action)
        # roughly center the box on screen
        # for accuracy see: https://stackoverflow.com/a/10018670/1217270
        root.update_idletasks()
        root.geometry("210x110+%d+%d" % (parent.winfo_rootx()+7,
                                         parent.winfo_rooty()+70))

        root.protocol("WM_DELETE_WINDOW", self.close_mod)

        # a trick to activate the window (on windows 7)
        root.deiconify()

    def b1_action(self, event=None):
        try: x = self.cbo.get()
        except AttributeError:
            self.returning = self.b1_return
            self.root.quit()
        else:
            if x:
                self.returning = x
                self.root.quit()

    def b2_action(self, event=None):
        self.returning = self.b2_return
        self.root.quit()

    def close_mod(self):
        # top right corner cross click: return value ;`x`;
        # we need to send it a value, otherwise there will be an exception when closing parent window
        self.returning = ";`x`;"
        self.root.quit()

すばやく簡単に使用できるはずです。以下に例を示します。

from mbox import MessageBox
from tkinter import *

root = Tk()


def mbox(msg, b1, b2, parent, cbo=False, cboList=[]):
    msgbox = MessageBox(msg, b1, b2, parent, cbo, cboList)
    msgbox.root.mainloop()
    msgbox.root.destroy()
    return msgbox.returning


Prompt = {}

# it will only show 2 buttons & 1 label if (cbo and cboList) aren't provided
# click on 'x' will return ;`x`;
Prompt['answer'] = mbox('Do you want to go?', ('Go', 'go'), ('Cancel', 'cancel'), root)
ans = Prompt['answer']
print(ans)
if ans == 'go':
    # do stuff
    pass
else:
    # do stuff
    pass


allowedItems = ['phone','laptop','battery']
Prompt['answer'] = mbox('Select product to take', ('Take', 'take'), ('Cancel', 'cancel'), root, cbo=True, cboList=allowedItems)
ans = Prompt['answer']
print(ans)
if (ans == 'phone'):
    # do stuff
    pass
Elif (ans == 'laptop'):
    # do stuff
    pass
else:
    # do stuff
    pass