PySimpleGUIで、HTMLのようにplaceholderを指定したい。

Question

実現したいこと

PySimpleGUIで、HTMLのようにplaceholderを指定したい。

Code

sg.InputText("ファイル", key="load")
```このままだと、入力するときに"ファイル"というを文字を消さないといけない。
日本語の情報が少なく、分からなかったので質問させて頂きました。

### Version
Python: 3.7.7
PySimpleGUI: 4.26.0

Answer 1

残念ながら、PySimpleGUI (tkinter) では対応してません。

---

解決案

• 自分で実装する
• wx/qt を使う
• tk8.7 を使う ※

実際の挙動を確認した訳では有りませんが、
PySimpleGUI 内部で使われているライブラリ側で、
placeholder 対応が予定されてます。

https://www.tcl.tk/man/tcl8.7/TkCmd/options.htm

現在の安定版の最新は 8.6 で、
Pythonにバンドルされてるものも最新で 8.6 なので、
将来のアップデート待ち。

---

以下、wx/qt/web の場合の placeholder の設定方法と、
tkの場合(標準) の代替実装です。

あまりテストしてないので、実装する場合のたたき台くらいに考えてください。

sgPlaceHolder Demo on repl.it

# import PySimpleGUIWx as sg
# import PySimpleGUIQt as sg
# import PySimpleGUIWeb as sg
import PySimpleGUI as sg


def setPlaceholder(widget, placeholderText):
    """
    wx/qt/web の場合、placeholder 設定を有効にします。
    tk の場合、代替実装を利用。

    実装メモ:
        通常なら hasattr で属性チェックするところですが、
        SimpleGUIWeb なのに Qt 用の属性が残っていたりする為、回避策を取ってます。
    """
    if getattr(widget, "WxTextCtrl", None): # SimpleGUIWx
        textCtrl = widget.WxTextCtrl # type: wx.TextCtrl
        textCtrl.SetHint(placeholderText)
        return

    if getattr(widget, "QT_QLineEdit", None): # SimpleGUIQt
        lineEdit = widget.QT_QLineEdit # type: QWidgets.QLineEdit
        lineEdit.setPlaceholderText(placeholderText)
        return

    if getattr(widget, "Widget", None) and hasattr(widget.Widget, "attributes"): # SimpleGUIWeb
        textInput = widget.Widget # type: remi.gui.TextInput
        textInput.attributes["placeholder"] = placeholderText
        return

    if getattr(widget, "TKEntry", None):
        # NOTE: tk8.7 will support "-placeholder" option
        #
        #   entry = widget.TKEntry
        #   entry.config(placeholder=placeholderText) # XXX: 未検証
        #   return entry.get
        #
        entry = widget.TKEntry

        def resetCursor(event=None):
            if entry.get() == placeholderText:
                entry.after_idle(entry.icursor, 0)

        def startInput(event=None):
            if entry.get() == placeholderText:
                entry.delete(0, "end")
                entry.config(fg="black")
            else:
                entry.after_idle(showPlaceholder)

        def showPlaceholder(event=None):
            if entry.get() == placeholderText or not entry.get():
                entry.delete(0, "end")
                entry.insert(0, placeholderText)
                entry.config(fg="gray50")
                entry.after_idle(entry.icursor, 0)

        entry.bind("<FocusIn>", resetCursor)
        entry.bind("<FocusOut>", showPlaceholder)
        entry.bind("<Button-1>", resetCursor)
        entry.bind("<Key>", startInput)
        showPlaceholder()

        def get_value():
            # ※ Tk の場合のみ
            # 空欄の場合、placeholder のテキストを入力値と勘違いしてしまうので、
            # placeholder を表示中の場合は、空文字を返す、この関数を通じて実際の値を所得します。
            # 
            # tk8.7 で placeholder オプションが実装されれば、廃止。
            # 
            text = entry.get()
            return text if text != placeholderText else ""

        widget.Get = get_value
        return

    import warnings
    warnings.warn("Unknown GUI Platform, setPlaceholder was ignored.")


layout = [
    [sg.Input("", key="load")],
    [sg.Button("OK")]
]

window = sg.Window("Placeholder", layout).Finalize()

# NOTE: Finalize() を呼んで、ウィジェットの生成完了を待つ
setPlaceholder(window["load"], placeholderText="FILE:")

while True:
    event, values = window.read()

    if event == sg.WIN_CLOSED:
        break
    
    if event == "OK":
        print("value: {}".format(values["load"]))

window.close()

Comments

[ForestSeo]

なるほど。
ありがとうございます。