ui_toggle_button
ui_toggle_button 模块提供开关按钮组件,支持开/关状态切换显示。
Class Summary
OHOS::UIToggleButton
开关按钮组件,包含开/关两种状态的图片显示
- 构造:无
-
成员函数:
接口名称 功能简述 GetViewType 获取组件类型 OnDraw 执行开关按钮绘制 SetState 设置开关按钮状态 GetState 获取开关按钮状态 -
使用包含头文件:
#include "components/ui_toggle_button.h" - 声明头文件:
middleware/services/gui/uikit/ui/interfaces/kits/components/ui_toggle_button.h - 公有运算符:无
- 继承关系:UICheckBox
- 嵌套类型:无
- 模板形参:无
Functions
OHOS::UIToggleButton
GetViewType
UIViewType GetViewType() const override
功能说明
- 核心用途:获取当前组件的类型标识
- 设计目的:区分 UIToggleButton 与其他 UI 组件类型,供框架进行类型判断和分发
- 使用场景:UI 框架类型检查、组件遍历过滤、事件分发时按类型筛选
返回值
- 返回类型:
UIViewType
返回组件类型标识
| 返回值 | 触发场景 |
|---|---|
| UI_TOGGLE_BUTTON(6) | 当前组件为 UIToggleButton |
OnDraw
void OnDraw(BufferInfo& gfxDstBuffer, const Rect& invalidatedArea) override
功能说明
- 核心用途:在指定区域绘制开关按钮
- 设计目的:根据开关状态绘制对应的背景和圆形滑块,若设置了选中/未选中图片则委托父类绘制
- 使用场景:UI 渲染流程中由渲染管理器调用,不可由应用层直接调用
入参
| 名称 | 参数类型 | 详细说明 | 约束取值范围 |
|---|---|---|---|
| gfxDstBuffer | BufferInfo& | 图形目标缓冲区,入参引用,写入 | 有效的图形缓冲区对象 |
| invalidatedArea | const Rect& | 需要重绘的无效区域,入参只读引用 | 有效的矩形区域 |
SetState
void SetState(bool state)
功能说明
- 核心用途:设置开关按钮的开关状态
- 设计目的:提供布尔语义的状态设置接口,将 true/false 映射为选中/未选中
- 使用场景:初始化开关按钮默认状态、响应用户操作或业务逻辑切换开关状态
入参
| 名称 | 参数类型 | 详细说明 | 约束取值范围 |
|---|---|---|---|
| state | bool | 开关状态,true 表示开(On),false 表示关(Off) | true / false |
GetState
bool GetState() const
功能说明
- 核心用途:获取开关按钮当前的开/关状态
- 设计目的:将内部选中/未选中枚举转换为布尔语义供外部查询
- 使用场景:查询开关按钮当前状态以驱动业务逻辑分支、状态同步
返回值
- 返回类型:
bool
返回开关按钮状态
| 返回值 | 触发场景 |
|---|---|
| true(1) | 开关处于开(On)状态 |
| false(0) | 开关处于关(Off)状态 |