主题
Battery 继承自:Service, BaseControl
提供对设备电池信息和状态变化的访问。
示例
python
import flet as ft
async def main(page: ft.Page):
page.vertical_alignment = ft.MainAxisAlignment.CENTER
page.horizontal_alignment = ft.CrossAxisAlignment.CENTER
async def refresh_info(e: ft.Event[ft.Button] = None):
level = await battery.get_battery_level()
state = await battery.get_battery_state()
save_mode = await battery.is_in_battery_save_mode()
info.value = (
f"Battery level: {level}% \n"
f"Battery state: {state.name} \n"
f"Battery saver: {'ON' if save_mode else 'OFF'}"
)
async def on_state_change(e: ft.BatteryStateChangeEvent):
print(f"State changed: {e.state}")
await refresh_info()
battery = ft.Battery(on_state_change=on_state_change)
page.services.append(battery) # need to keep a reference to the service
page.add(
ft.SafeArea(
content=ft.Column(
horizontal_alignment=ft.CrossAxisAlignment.CENTER,
controls=[
info := ft.Text(),
ft.Button("Refresh battery info", on_click=refresh_info),
],
)
)
)
await refresh_info()
if __name__ == "__main__":
ft.run(main)属性
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
data | Any | skip_ | 任意类型的自定义数据。 |
key | Optional['KeyValue'] | None | 用于在更新之间保持控件标识稳定的键。 |
只读属性
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
parent | Optional['BaseControl'] | — | 此控件的直接祖先(父级)。 默认为 None,只有在此控件被挂载(加入页面树)后才有值。 Page 控件(页面树的根)是个例外 —— 它的 parent 始终为 None。 |
page | 'Page' | — | 此控件所属的页面。 |
事件
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
on_state_change | Optional[EventHandler[BatteryStateChangeEvent]] | None | 当电池状态发生变化(充电、放电、充满、未知)时调用。 |
方法
| 名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
get_battery_level | Optional[int] | — | 以百分比获取当前电池电量,范围为 0 到 100。 返回: 电池电量;如果当前环境不支持,则返回 None。 |
get_battery_state | BatteryState | — | 返回当前电池状态。 |
is_in_battery_save_mode | bool | — | 如果设备当前处于省电模式,则返回 True。 |
init | — | — | — |
is_isolated | — | — | 返回此控件是否被标记为隔离。 隔离控件会被排除在父级驱动的更新遍历之外,并需要自行管理更新边界。 |
build | — | — | 在控件初始化期间调用一次,用于定义其子控件。在此方法中 page 属性可用。 |
before_update | — | — | 每当此控件被更新时都会调用此方法。 注意: 务必不要在此处调用或请求 update()。 |
before_event | — | — | 在事件处理器执行之前拦截事件。 返回 False 可取消分发。返回 True 或 None 则继续正常的事件处理。 |
did_mount | — | — | 在控件挂载到页面树之后调用。 重写此方法以启动需要已挂载页面的资源,例如订阅、定时器或服务监听器。 |
will_unmount | — | — | 在控件从页面树移除之前调用。 重写此方法以释放 did_mount() 中创建的资源,例如订阅、定时器或外部句柄。 |
get_data_channel | — | — | 解析为此 widget 在 Dart 侧分配的 [DataChannel]。模式: on_data_channel_open: Optional[ft.EventHandler[DataChannelOpenEvent]] = None def init(self): self.on_data_channel_open = self._on_open def _on_open(self, e): self._channel = self.get_data_channel(e.channel_id) 幂等 —— 底层的 Connection 会按 id 缓存 DataChannel,因此重复调用会返回同一实例。没有错误路径:该 id 始终来自框架触发的事件,所以当此方法运行时,通道在两端都已存在。 |
update | None | — | 为此控件请求一次 UI 更新。 在更改控件状态或属性后调用。控件必须已挂载到页面且未被标记为冻结。 |