DreamGUI
类参考

UDreamRadioButton

UDreamRadioButton

继承自 UDreamUIControl。

声明于 Public/Controls/DreamRadioButton.h 中。

一个层级结构由代码而非资源定义的单选按钮。

它采用开关(toggle)的解剖结构,底层是开关自身的行为——一个方框、一个居中于其中的标记、一个在同一行中位于其旁的标签——仅在两处有所不同,这正是它是一个类而不是一种样式的原因:标记是按样式设定尺寸的图片圆点而非字形,且方框的圆角半径默认是其尺寸的一半,这正是使其被视为单选按钮的全部所在。

在运行时使单选按钮成为单选按钮的是组(GROUP),而组并不属于此控件:它是位于共享祖先上的 UUIToggleGroup 行为,成员资格通过 SetToggleGroup 移交。未分组时,此控件诚实地表现为一个圆形开关——再次点击它会将其关闭;带有 bAllowNoneSelected=false 的组才是禁止此行为的东西。

/Script/DreamGUIControls.DreamRadioButton OptionA {
    bIsOn = true
    OnToggleChanged -> HandleOptionA
}

属性

名称类型类别在细节面板中来自蓝图描述
StyleFDreamRadioButtonStyleRadio Button是GetStyle / SetStyle此实例自身的外观。当 StyleSource 指示如此且项目中确实存在样式表时,项目样式表优先;如果项目中没有样式表,则此实例本身即为生效的外观——这正是它保持可编辑而不受枚举约束的原因:旧的编辑条件把正在驱动控件的那些确切值灰掉了。
bAutoGroupWithSiblingsboolRadio Button是GetAutoGroupWithSiblings / SetAutoGroupWithSiblings在 Awake 时在祖先上查找 UUIToggleGroup 并加入——有了共享父级上的组行为,同级的单选按钮无需任何连线即可相互排斥。默认开启,因为不排斥的单选按钮就是个圆形开关;关闭时,分组通过 SetToggleGroup 进行。
bIsOnboolRadio Button是GetIsOn / SetIsOn是否选中。它是一个属性,而不仅仅是 getter/setter 对,因为仅靠这对方法是不可见的:.dui 写入属性,设计器列出属性,绑定解析属性。写入的是创作值,输出的是行为的镜像——当用户(或将该按钮关闭的组)是写入者时,HandleValueChanged 保持其准确。
CheckedStateEDreamCheckStateRadio Button是GetCheckedState / SetCheckedState完整状态,采用 UMG 复选框的术语——与 UDreamToggle 所携带的相同的 EDreamCheckState,以及相同的三种答案。
AcceptedMouseButtonsint32Radio Button是GetAcceptedMouseButtons / SetAcceptedMouseButtons哪些鼠标按键按下并选择此单选按钮——一个基于 EDreamUIMouseButtonType 的位掩码,默认仅左键:对 UMG 来说单选按钮就是复选框,而 SCheckBox 只响应左键而不响应其他按键,因此右键点击既不会按下也不会选择它。
BoxNodeTObjectPtr<UDreamWidget>Radio Button-只读
DotNodeTObjectPtr<UDreamWidget>Radio Button-只读
ToggleBehaviourTObjectPtr<UUIToggle>Radio Button-只读

函数

函数种类描述
int32 GetAcceptedMouseButtons()pure获取接受的鼠标按键
bool GetAutoGroupWithSiblings()pure获取与同级自动分组
EDreamCheckState GetCheckedState()pure完整状态。对于行为可持有的两种状态,行为是真相;未确定(Undetermined)是控件自身的状态,并从此处读取。
bool GetIsOn()pure获取是否开启
FDreamRadioButtonStyle GetStyle()pure获取样式
UUIToggleGroup* GetToggleGroup()pure获取切换组
bool IsChecked()pureUMG 的便利方法:完全等同于 GetCheckedState() == Checked。
void SetAcceptedMouseButtons(int32 InAcceptedMouseButtons)callable写入位掩码并立即将其推送到行为上。
void SetAutoGroupWithSiblings(bool bInAutoGroupWithSiblings)callable开启或关闭自动分组,并立即对其生效。
void SetCheckedState(EDreamCheckState InCheckedState)callable设置三种状态中的任意一种。Checked/Unchecked 通过行为并带通知——这是点击所走的路径,也是组所听到的路径——而 Undetermined 则在不带通知的情况下将行为停放在未选中状态,并存在于控件上。
void SetIsChecked(bool bInIsChecked)callable设置是否勾选
void SetIsOn(bool bInIsOn)callableSetCheckedState(Checked/Unchecked) 的兼容写法,与开关上的完全一致。
void SetStyle(FDreamRadioButtonStyle InStyle)callable此实例的完整外观,替换并推送。注意事项见 UDreamButton::SetStyle。
void SetToggleGroup(UUIToggleGroup* InGroup)callable成员资格,直接传递给行为。

事件

事件签名描述
OnToggleChangedvoid DreamRadioButtonChangedEvent__DelegateSignature(bool bIsOn)由底层的开关触发,在此处重新广播,以便使用者永远无需深入内部部件。
OnCheckStateChangedvoid DreamRadioCheckStateChangedEvent__DelegateSignature(EDreamCheckState CheckedState)UMG 对同一时刻的表述,携带完整状态。每当 CheckedState 改变时触发——当布尔投影也发生变化时,与 OnToggleChanged 一同触发。
OnValueChangedBPvoid DreamRadioButtonChangedEvent__DelegateSignature(bool bIsOn)<-> 约定:双向绑定会针对这个确切的名称合成其反向路由,因此值控件会将其与其所述事件一同携带。与它们一同触发。

本页目录