跳转至

tkflu.menu · FluMenu 菜单

下拉菜单。

FluMenu 继承自 :class:~tkflu.popupmenu.FluPopupMenu， 用 :class:~tkflu.button.FluButton（style="menu"）逐项拼出菜单内容， 因此菜单项天然具备主题切换与悬停动画。

用 :meth:~tkflu.menu.FluMenu.add_command 添加普通项， :meth:~tkflu.menu.FluMenu.add_cascade 添加子菜单。

FluMenu

Bases: FluPopupMenu, FluToolTipBase

源代码位于： tkflu\menu.py 
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
class FluMenu(FluPopupMenu, FluToolTipBase):
    def __init__(self, *args, height=None, **kwargs):
        """构造下拉菜单。

        :param args: 第一个位置参数是**属主控件**（见
            :class:`~tkflu.popupmenu.FluPopupMenu`）
        :param height: 弹出窗口的初始高度；``None`` 表示沿用默认值

        .. note::
           旧签名是 ``(height=None, *args, **kwargs)``——位置参数先被
           ``height`` 吃掉，于是 ``FluMenu(toplevel)`` 会把 toplevel 当成
           高度传给 ``FluFrame``（换来一个莫名其妙的尺寸），而真正的
           ``master`` 永远拿不到。现在 ``height`` 变成关键字参数。
        """
        if height is not None:
            kwargs["height"] = height
        super().__init__(*args, **kwargs)

    def _init(self, mode, style):
        from easydict import EasyDict

        self.attributes = EasyDict(
            {
                "back_color": None,
                "back_opacity": None,
                "border_color": None,
                "border_color_opacity": None,
                "border_width": None,
                "radius": None,
                "actions": {},
            }
        )

        self.theme(mode=mode, style=style)

    def preferred_size(self, item_height: int = 45):
        """按当前菜单项算出弹出窗口该多大。

        历史实现把宽度写死成 100px、高度按 ``项数 * 45`` 算。
        中文菜单项在 100px 内会被截断，所以这里按最长标签实测宽度。

        :param item_height: 每项占的高度（与 ``add_command`` 里的间距对应）
        :returns: ``(width, height)``
        """
        from .defs import measure_label_width

        actions = self.dcget("actions") or {}
        widest = 0
        for widget in actions.values():
            label = ""
            if hasattr(widget, "dcget"):
                label = widget.dcget("text") or ""
            elif hasattr(widget, "cget"):
                try:
                    label = widget.cget("text") or ""
                except Exception:
                    label = ""
            # 弹出窗口每侧留 1px 内边距，再加一点外边距
            widest = max(widest, measure_label_width(self, label) + 8)

        width = max(100, widest)
        height = max(item_height, len(actions) * item_height)
        return width, height

    def add_command(self, custom_widget=None, width=None, label: str = "", **kwargs):
        if width is None:
            from .defs import measure_label_width

            width = measure_label_width(self, label)
        if custom_widget:
            widget = custom_widget(self)
        else:
            from .button import FluButton

            widget = FluButton(self, width=width)
        if "style" in kwargs:
            style = kwargs.pop("style")
        else:
            style = "menu"
        if "command" in kwargs:
            c = kwargs.pop("command")

            def command():
                c()
                self.hide_all()

        else:
            # 没有 command 的项：点一下只把菜单收起来（保持历史行为）
            command = self.hide_all
        if "id" in kwargs:
            id = kwargs.pop("id")
        else:
            id = widget._w
        if hasattr(widget, "dconfigure"):
            widget.dconfigure(text=label, command=command)
        else:
            if hasattr(widget, "configure"):
                widget.configure(text=label, command=command)
        if hasattr(widget, "theme"):
            widget.theme(style=style)

        widget.pack(side="top", fill="x", padx=1, pady=(1, 0))
        self.dcget("actions")[id] = widget

    def add_cascade(
        self, custom_widget=None, width=None, menu=None, label: str = "", **kwargs
    ):
        """添加一个带子菜单的项。

        :param menu: 子菜单（:class:`FluMenu`）
        :param label: 显示文字
        :param width: 项宽；``None`` 时按文字实测
        :param custom_widget: 用一个自定义组件代替默认的 ``FluButton``
        """
        if width is None:
            from .defs import measure_label_width

            width = measure_label_width(self, label)
        if custom_widget:
            widget = custom_widget(self)
        else:
            from .button import FluButton

            widget = FluButton(self, width=width)
        if "style" in kwargs:
            style = kwargs.pop("style")
        else:
            style = "menu"
        if "id" in kwargs:
            id = kwargs.pop("id")
        else:
            id = widget._w

        # 记住父子关系：子菜单里的项被点掉时要连父菜单一起收起
        if menu is not None:
            menu._parent_menu = self

        def command(event=None):
            self.l1 = True

            menu.popup(
                widget.winfo_rootx() + widget.winfo_width(), widget.winfo_rooty() - 5
            )
            # 子菜单弹窗也按内容算尺寸（原来写死 100px 宽）
            menu_width, menu_height = menu.preferred_size()
            menu.window.geometry(f"{menu_width}x{menu_height}")
            menu.window.deiconify()
            menu.window.attributes("-topmost")

        if hasattr(widget, "dconfigure"):
            widget.dconfigure(text=label)
        else:
            if hasattr(widget, "configure"):
                widget.configure(text=label)
        widget.bind("<Enter>", command, add="+")
        if hasattr(widget, "theme"):
            widget.theme(style=style)

        widget.pack(side="top", fill="x", padx=1, pady=(1, 0))
        self.dcget("actions")[id] = widget

__init__(*args, height=None, **kwargs)

构造下拉菜单。

:param args: 第一个位置参数是属主控件（见 :class:~tkflu.popupmenu.FluPopupMenu） :param height: 弹出窗口的初始高度；None 表示沿用默认值

.. note:: 旧签名是 (height=None, *args, **kwargs)——位置参数先被 height 吃掉，于是 FluMenu(toplevel) 会把 toplevel 当成 高度传给 FluFrame（换来一个莫名其妙的尺寸），而真正的 master 永远拿不到。现在 height 变成关键字参数。

源代码位于： tkflu\menu.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
def __init__(self, *args, height=None, **kwargs):
    """构造下拉菜单。

    :param args: 第一个位置参数是**属主控件**（见
        :class:`~tkflu.popupmenu.FluPopupMenu`）
    :param height: 弹出窗口的初始高度；``None`` 表示沿用默认值

    .. note::
       旧签名是 ``(height=None, *args, **kwargs)``——位置参数先被
       ``height`` 吃掉，于是 ``FluMenu(toplevel)`` 会把 toplevel 当成
       高度传给 ``FluFrame``（换来一个莫名其妙的尺寸），而真正的
       ``master`` 永远拿不到。现在 ``height`` 变成关键字参数。
    """
    if height is not None:
        kwargs["height"] = height
    super().__init__(*args, **kwargs)

add_cascade(custom_widget=None, width=None, menu=None, label='', **kwargs)

添加一个带子菜单的项。

:param menu: 子菜单（:class:FluMenu） :param label: 显示文字 :param width: 项宽；None 时按文字实测 :param custom_widget: 用一个自定义组件代替默认的 FluButton

源代码位于： tkflu\menu.py 
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
def add_cascade(
    self, custom_widget=None, width=None, menu=None, label: str = "", **kwargs
):
    """添加一个带子菜单的项。

    :param menu: 子菜单（:class:`FluMenu`）
    :param label: 显示文字
    :param width: 项宽；``None`` 时按文字实测
    :param custom_widget: 用一个自定义组件代替默认的 ``FluButton``
    """
    if width is None:
        from .defs import measure_label_width

        width = measure_label_width(self, label)
    if custom_widget:
        widget = custom_widget(self)
    else:
        from .button import FluButton

        widget = FluButton(self, width=width)
    if "style" in kwargs:
        style = kwargs.pop("style")
    else:
        style = "menu"
    if "id" in kwargs:
        id = kwargs.pop("id")
    else:
        id = widget._w

    # 记住父子关系：子菜单里的项被点掉时要连父菜单一起收起
    if menu is not None:
        menu._parent_menu = self

    def command(event=None):
        self.l1 = True

        menu.popup(
            widget.winfo_rootx() + widget.winfo_width(), widget.winfo_rooty() - 5
        )
        # 子菜单弹窗也按内容算尺寸（原来写死 100px 宽）
        menu_width, menu_height = menu.preferred_size()
        menu.window.geometry(f"{menu_width}x{menu_height}")
        menu.window.deiconify()
        menu.window.attributes("-topmost")

    if hasattr(widget, "dconfigure"):
        widget.dconfigure(text=label)
    else:
        if hasattr(widget, "configure"):
            widget.configure(text=label)
    widget.bind("<Enter>", command, add="+")
    if hasattr(widget, "theme"):
        widget.theme(style=style)

    widget.pack(side="top", fill="x", padx=1, pady=(1, 0))
    self.dcget("actions")[id] = widget

preferred_size(item_height=45)

按当前菜单项算出弹出窗口该多大。

历史实现把宽度写死成 100px、高度按 项数 * 45 算。 中文菜单项在 100px 内会被截断，所以这里按最长标签实测宽度。

:param item_height: 每项占的高度（与 add_command 里的间距对应） :returns: (width, height)

源代码位于： tkflu\menu.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
def preferred_size(self, item_height: int = 45):
    """按当前菜单项算出弹出窗口该多大。

    历史实现把宽度写死成 100px、高度按 ``项数 * 45`` 算。
    中文菜单项在 100px 内会被截断，所以这里按最长标签实测宽度。

    :param item_height: 每项占的高度（与 ``add_command`` 里的间距对应）
    :returns: ``(width, height)``
    """
    from .defs import measure_label_width

    actions = self.dcget("actions") or {}
    widest = 0
    for widget in actions.values():
        label = ""
        if hasattr(widget, "dcget"):
            label = widget.dcget("text") or ""
        elif hasattr(widget, "cget"):
            try:
                label = widget.cget("text") or ""
            except Exception:
                label = ""
        # 弹出窗口每侧留 1px 内边距，再加一点外边距
        widest = max(widest, measure_label_width(self, label) + 8)

    width = max(100, widest)
    height = max(item_height, len(actions) * item_height)
    return width, height