M5Msgbox

M5Msgbox 是一个用于在用户界面中创建msgbox的组件。

UiFlow2 示例

msgbox事件

在 UiFlow2 中打开 msgbox_core2_example.m5f2 项目。

本示例创建msgbox并关联事件。

UiFlow2 代码块：

示例输出：

None

MicroPython 应用示例

msgbox事件

本示例创建msgbox并关联事件。

MicroPython 代码块：

# SPDX-FileCopyrightText: 2025 M5Stack Technology CO LTD
#
# SPDX-License-Identifier: MIT

import os, sys, io
import M5
from M5 import *
import m5ui
import lvgl as lv


page0 = None
msgbox0 = None
label_sfu = None
btn_apply = None
btn_cancel = None


import random


def btn_apply_clicked_event(event_struct):
    global page0, msgbox0, label_sfu, btn_apply, btn_cancel

    label_sfu.set_text(str((str("Hello ") + str((random.randint(1, 100))))))


def btn_cancel_clicked_event(event_struct):
    global page0, msgbox0, label_sfu, btn_apply, btn_cancel

    btn_apply.toggle_flag(lv.obj.FLAG.HIDDEN)


def btn_apply_event_handler(event_struct):
    global page0, msgbox0, label_sfu, btn_apply, btn_cancel
    event = event_struct.code
    if event == lv.EVENT.CLICKED and True:
        btn_apply_clicked_event(event_struct)
    return


def btn_cancel_event_handler(event_struct):
    global page0, msgbox0, label_sfu, btn_apply, btn_cancel
    event = event_struct.code
    if event == lv.EVENT.CLICKED and True:
        btn_cancel_clicked_event(event_struct)
    return


def setup():
    global page0, msgbox0, label_sfu, btn_apply, btn_cancel

    M5.begin()
    Widgets.setRotation(1)
    m5ui.init()
    page0 = m5ui.M5Page(bg_c=0xFFFFFF)
    msgbox0 = m5ui.M5Msgbox(title="Message Box", x=0, y=0, w=320, h=240, parent=page0)
    label_sfu = msgbox0.add_text("This is label_sfu")
    btn_apply = msgbox0.add_button(text="Apply", option="footer")
    btn_cancel = msgbox0.add_button(text="Cancel", option="footer")
    msgbox0.add_close_button()

    btn_apply.add_event_cb(btn_apply_event_handler, lv.EVENT.ALL, None)
    btn_cancel.add_event_cb(btn_cancel_event_handler, lv.EVENT.ALL, None)

    page0.screen_load()


def loop():
    global page0, msgbox0, label_sfu, btn_apply, btn_cancel
    M5.update()


if __name__ == "__main__":
    try:
        setup()
        while True:
            loop()
    except (Exception, KeyboardInterrupt) as e:
        try:
            m5ui.deinit()
            from utility import print_error_msg

            print_error_msg(e)
        except ImportError:
            print("please update to latest firmware")

示例输出：

None

API参考

M5Msgbox

class m5ui.msgbox.M5Msgbox(*args, **kwargs)

基类：msgbox

创建一个msgbox对象。

参数:

title (str) – msgbox的标题。
x (int) – msgbox的 x 坐标。
y (int) – msgbox的 y 坐标。
w (int) – msgbox的宽度。
h (int) – msgbox的高度。
parent (lv.obj) – 要附加msgbox的父对象。如果未指定，则msgbox会附加到默认屏幕。

MicroPython 代码块：

from m5ui import M5Msgbox
import lvgl as lv

m5ui.init()
msgbox_0 = M5Msgbox(
    title="msgbox",
    x=0,
    y=0,
    w=320,
    h=240,
    parent=page0,
)

add_close_button()

为msgbox头部添加关闭按钮。

返回:: None

UiFlow2 代码块：

MicroPython 代码块：

msgbox_0.add_close_button()

delete()

从msgbox中删除项目。

UiFlow2 代码块：

MicroPython 代码块：

button_0.delete()
text_0.delete()

set_text(txt)

设置msgbox按钮/标签的文本。

参数:: txt (str) – 要为msgbox按钮/标签设置的文本。
返回:: None

UiFlow2 代码块：

MicroPython 代码块：

button_0.set_text("Select an option")

label_0.set_text("M5Stack")

set_style_text_font(font, part)

设置msgbox按钮/标签文本的字体。

参数:

font (lv.lv_font_t) – 要设置的字体。
part (int) – 要应用样式的对象部分（例如 lv.PART.MAIN）。

返回:

None

UiFlow2 代码块：

MicroPython 代码块：

label_0.set_style_text_font(lv.font_montserrat_14, lv.PART.MAIN | lv.STATE.DEFAULT)

button_0.set_style_text_font(lv.font_montserrat_14, lv.PART.MAIN | lv.STATE.DEFAULT)

set_text_color(color, opa, part)

设置msgbox按钮/标签的颜色。

参数:

color (int) – 要设置的颜色。
opa (int) – 颜色的不透明度。
part (int) – 要应用样式的对象部分（例如 lv.PART.MAIN）。

返回:

None

UiFlow2 代码块：

MicroPython 代码块：

button_0.set_text_color(lv.color_hex(0x000000), 255, lv.PART.MAIN | lv.STATE.DEFAULT)

label_0.set_text_color(lv.color_hex(0x000000), 255, lv.PART.MAIN | lv.STATE.DEFAULT)

set_bg_color(color, opa, part)

设置msgbox按钮/标签的背景颜色。

参数:

color (int) – 要设置的颜色。
opa (int) – 颜色的不透明度。
part (int) – 要应用样式的对象部分（例如 lv.PART.MAIN）。

返回:

None

UiFlow2 代码块：

MicroPython 代码块：

button_0.set_bg_color(lv.color_hex(0x000000), 255, lv.PART.MAIN | lv.STATE.DEFAULT)

label_0.set_bg_color(lv.color_hex(0x000000), 255, lv.PART.MAIN | lv.STATE.DEFAULT)

set_long_mode(mode)

设置msgbox标签的长文本模式。

参数:: mode (int) – 要设置的长文本模式。

UiFlow2 代码块：

MicroPython 代码块：

label_0.set_long_mode(lv.label.LONG_MODE.WRAP)

set_flag(flag, value)

在对象上设置标志。如果 value 为 True，则添加该标志；为 False 时移除该标志。

参数:

flag (int) – 要设置的标志。
value (bool) – 为 True 时添加标志，为 False 时移除标志。

UiFlow2 代码块：

MicroPython 代码块：

msgbox_0.set_flag(lv.obj.FLAG.HIDDEN, True)

set_pos(x, y)

设置msgbox的位置。

参数:

x (int) – msgbox的 x 坐标。
y (int) – msgbox的 y 坐标。

UiFlow2 代码块：

MicroPython 代码块：

msgbox_0.set_pos(100, 100)

set_x(x)

设置msgbox的 x 坐标。

参数:: x (int) – msgbox的 x 坐标。

UiFlow2 代码块：

MicroPython 代码块：

msgbox_0.set_x(100)

set_y(y)

设置msgbox的 y 坐标。

参数:: y (int) – msgbox的 y 坐标。

UiFlow2 代码块：

MicroPython 代码块：

msgbox_0.set_y(100)

set_size(width, height)

设置msgbox的尺寸。

参数:

width (int) – msgbox的宽度。
height (int) – msgbox的高度。

返回:

None

UiFlow2 代码块：

MicroPython 代码块：

msgbox_0.set_size(100, 50)

align_to(obj, align, x, y)

将msgbox对齐到其他对象。

参数:

obj (lv.obj) – 要对齐的对象。
align (int) – 对齐方式类型。
x (int) – 相对于对齐对象的 x 偏移量。
y (int) – 相对于对齐对象的 y 偏移量。

UiFlow2 代码块：

MicroPython 代码块：

msgbox_0.align_to(page_0, lv.ALIGN.CENTER, 0, 0)

set_state(state, value)

设置进度条的状态。如果 value 为 True，则设置状态；为 False 时取消状态。

参数:

state (int) – 要设置的状态。
value (bool) – 为 True 时设置状态；为 False 时取消状态。

返回:

None

UiFlow2 代码块：

MicroPython 代码块：

msgbox_0.set_state(lv.STATE.PRESSED, True)

toggle_flag(flag)

切换对象上的标志。如果该标志已设置，则移除；否则添加。

参数:: flag (int) – 要切换的标志。
返回:: None

UiFlow2 代码块：

MicroPython 代码块：

msgbox_0.toggle_flag(lv.obj.FLAG.HIDDEN)

set_style_radius(radius, part)

设置msgbox按钮的圆角半径。

参数:

radius (int) – 要设置的半径。
part (int) – 要应用样式的对象部分（例如 lv.PART.MAIN）。

返回:

None

UiFlow2 代码块：

MicroPython 代码块：

button_0.set_style_radius(10, lv.PART.MAIN | lv.STATE.DEFAULT)

set_shadow(color, opa, align, offset_x, offset_y)

为标签设置阴影。

参数:

color (int) – 阴影的颜色，十六进制格式或整数。
opa (int) – 阴影的不透明度（0-255）。
align (int) – 阴影相对于标签的对齐方式。
offset_x (int) – 阴影的水平偏移量。
offset_y (int) – 阴影的垂直偏移量。

返回:

None

UiFlow2 代码块：

MicroPython 代码块：

label_0.set_shadow(color=0x000000, opa=128, align=lv.ALIGN.BOTTOM_RIGHT, offset_x=5, offset_y=5)

unset_shadow()

移除标签的阴影。

UiFlow2 代码块：

MicroPython 代码块：

label_0.unset_shadow()

get_text()

获取标签的文本。

返回:: 标签的文本内容。
返回类型:: str

UiFlow2 代码块：

MicroPython 代码块：

label_0.get_text()
button_0.get_text()

toggle_state(state)

切换按钮的状态。如果该状态已设置则取消设置，未设置则添加设置。

参数:: state (int) – 要切换的状态。
返回:: None

UiFlow2 代码块：

MicroPython 代码块：

button_0.toggle_state(lv.STATE.PRESSED)

add_event_cb(handler, event, user_data)

为按钮添加事件回调。当指定事件发生时将调用该回调函数。

参数:

handler (function) – 要调用的回调函数。
event (int) – 要监听的事件。
user_data (Any) – 可选的用户数据，将传递给回调函数。

返回:

None

UiFlow2 代码块：

MicroPython 代码块：

def btn_ono_clicked_event(event_struct):
    global page0, msgbox_0, label_lkg, btn_ono, btn_pjm, label0

    print('hello M5')


def btn_ono_event_handler(event_struct):
    global page0, msgbox_0, label_lkg, btn_ono, btn_pjm, label0
    event = event_struct.code
    if event == lv.EVENT.CLICKED and True:
        btn_ono_clicked_event(event_struct)
    return

btn_ono.add_event_cb(btn_ono_event_handler, lv.EVENT.ALL, None)

add_text(text, text_c=2171169, text_opa=255, bg_c=16777215, bg_opa=255, font=lvgl.font_montserrat_14)

向msgbox添加文本标签。

参数:

text (str) – 要显示的文本。
text_c (int) – 文本颜色（十六进制格式）。
text_opa (int) – 文本不透明度（0-255）。
bg_c (int) – 背景颜色（十六进制格式）。
bg_opa (int) – 背景不透明度（0-255）。
font (lv.font) – 用于文本的字体。

返回:

创建的标签对象。

返回类型:

m5ui.M5Label

UiFlow2 代码块：

MicroPython 代码块：

text0 = msgbox_0.add_text(
    text="Hello World",
    text_c=0x212121,
    text_opa=255,
    bg_c=0xFFFFFF,
    bg_opa=255,
    font=lv.font_montserrat_14,
)

add_button(icon=None, text='', bg_c=2201331, bg_opa=255, text_c=16777215, text_opa=255, font=lvgl.font_montserrat_14, option='footer')

向msgbox添加按钮。

参数:

icon (str) – 按钮上要显示的图标。
text (str) – 按钮上要显示的文本。
bg_c (int) – 背景颜色（十六进制格式）。
bg_opa (int) – 背景不透明度（0-255）。
text_c (int) – 文本颜色（十六进制格式）。
text_opa (int) – 文本不透明度（0-255）。
font (lv.font) – 按钮文本所使用的字体。
option (str) – 按钮的位置（“header” 或 “footer”）。

返回:

创建的按钮对象。

返回类型:

m5ui.M5Button

UiFlow2 代码块：

MicroPython 代码块：

button0 = msgbox_0.add_button(
    icon=None,
    text="OK",
    bg_c=0x2196F3,
    bg_opa=255,
    text_c=0xFFFFFF,
    text_opa=255,
    font=lv.font_montserrat_14,
    option="footer",
)