Checkbox控件的使用

复选框控件

功能功能

复选框控件，用来实现选择和取消选择的提示功能

属性介绍

1. ShowText 是否显示文本
2. Text 文本内容，可使用语言自动转换功能
3. AlignTextToLeft 文字是否靠最左侧对齐，默认文字是在图标的右侧
4. Background 背景样式
5. TextStyle 文字样式
6. ShowIcon 是否显示图标
7. UncheckIcon 未选中图标
8. UncheckHotIcon 未选中高亮图标
9. CheckedIcon 选中图标
10. CheckedHotIcon 选中高亮图标
11. DisableIcon 禁用图标
12. HorAlign 图标水平对齐方式
13. VerAlign 图标垂直对齐方式
14. OffsetX 水平偏移量
15. OffsetY 垂直偏移量

控件事件介绍

1. UIG_CB_CHANGED

事件处理示例：

 BEGIN_UIG_MESSAGE_MAP(CTestDlg)
    ON_UIG_CB_CHANGE(_cbkValue, CbkChanged)
 END_UIG_MESSAGE_MAP()
 ...
 void CDemoDlg::CbkChanged(IUIGearsControl* control,  UICheckState state)
{
    if (control == _cbkValue)
    {   
    }
}

enum UICheckState
    {
        UIG_UNCHECKED = 0,  // 未选中状态
        UIG_CHECKED,  // 选中状态
        UIG_HALFCHECKED // 保留
    };

接口介绍

1. IsChecked

接口描述: 是否选中

参数值:

无

返回值:

bool   是否选中

示例:

_demoCtrl->IsChecked();

2. SetChecked

接口描述: 设置是否选中

参数值:

参数名	参数类型	参数含义
bCheck	bool	是否选中

返回值:

void

示例:

_demoCtrl->SetChecked();

3. SetText

接口描述: 设置文本

参数值:

参数名	参数类型	参数含义
text	const tchar*	是否选中

返回值:

void

示例:

_demoCtrl->SetText();

4. GetText

接口描述: 获取文本

参数值:

无

返回值:

const tchar* 文本内容

示例:

_demoCtrl->GetText();

5. SetShowText

接口描述: 设置是否显示文本

参数值:

参数名	参数类型	参数含义
show	bool	是否显示文本

返回值:

void

示例:

_demoCtrl->SetShowText();

6. GetShowText

接口描述: 获取是否显示文本

参数值:

无

返回值:

bool 是否显示

示例:

_demoCtrl->GetShowText();

7. SetShowIcon

接口描述: 设置是否显示图标

参数值:

参数名	参数类型	参数含义
show	bool	是否显示

返回值:

void

示例:

_demoCtrl->SetShowIcon();

8. GetShowIcon

接口描述: 获取是否显示图标

参数值:

无

返回值:

bool 是否显示

示例:

_demoCtrl->GetShowIcon();

9. SetUncheckIcon

接口描述: 设置未选中图标

参数值:

参数名	参数类型	参数含义
iconPath	const tchar*	图标路径

返回值:

bool 是否成功

示例:

_demoCtrl->SetUncheckIcon();

10. GetUncheckIcon

接口描述: 获取未选中图标

参数值:

无

返回值:

const tchar* 图标路径，此路径不是绝对路径，为资源包内路径

示例:

_demoCtrl->GetUncheckIcon();

11. SetCheckedIcon

接口描述: 设置选中图标

参数值:

参数名	参数类型	参数含义
iconPath	const tchar*	图标路径

返回值:

bool 是否成功

示例:

_demoCtrl->SetCheckedIcon();

12. GetCheckedIcon

接口描述: 获取选中图标

参数值:

无

返回值:

const tchar* 图标路径，此路径不是绝对路径，为资源包内路径

示例:

_demoCtrl->GetCheckedIcon();

13. SetUncheckHotIcon

接口描述: 设置未选中高亮图标

参数值:

参数名	参数类型	参数含义
iconPath	const tchar*	图标路径

返回值:

bool 是否成功

示例:

_demoCtrl->SetUncheckHotIcon();

14. GetUncheckHotIcon

接口描述: 获取未选中高亮图标

参数值:

无

返回值:

const tchar* 图标路径，此路径不是绝对路径，为资源包内路径

示例:

_demoCtrl->GetUncheckHotIcon();

15. SetCheckedHotIcon

接口描述: 设置选中高亮图标

参数值:

参数名	参数类型	参数含义
iconPath	const tchar*	图标路径

返回值:

bool 是否成功

示例:

_demoCtrl->SetCheckedHotIcon();

16. GetUncheckHotIcon

接口描述: 获取选中高亮图标

参数值:

无

返回值:

const tchar* 图标路径，此路径不是绝对路径，为资源包内路径

示例:

_demoCtrl->GetUncheckHotIcon();

17. SetCheckedHotIcon

接口描述: 设置禁用图标

参数值:

参数名	参数类型	参数含义
iconPath	const tchar*	图标路径

返回值:

bool 是否成功

示例:

_demoCtrl->SetCheckedHotIcon();

18. GetDisableIcon

接口描述: 获取禁用图标

参数值:

无

返回值:

const tchar* 图标路径，此路径不是绝对路径，为资源包内路径

示例:

_demoCtrl->GetDisableIcon();

19. SetBackgroundStyle

接口描述: 设置背景样式

参数值:

参数名	参数类型	参数含义
state	CBK_UIState	状态枚举
style	IUIGearsTextStyle*	样式指针

返回值:

bool 是否成功

示例:

_demoCtrl->SetBackgroundStyle();

20. GetBackgroundStyle

接口描述: 获取背景样式

参数值:

参数名	参数类型	参数含义
state	CBK_UIState	状态枚举

返回值:

IUIGearsRectStyle* 图标路径样式指针

示例:

_demoCtrl->GetBackgroundStyle();

21. SetTextStyle

接口描述: 设置文字样式

参数值:

参数名	参数类型	参数含义
state	CBK_UIState	状态枚举
style	IUIGearsTextStyle*	样式指针

返回值:

bool 是否成功

示例:

_demoCtrl->SetTextStyle();

22. GetTextStyle

接口描述: 获取文字样式

参数值:

参数名	参数类型	参数含义
state	CBK_UIState	状态枚举

返回值:

IUIGearsTextStyle* 样式指针

示例:

_demoCtrl->GetTextStyle();

23. SetIconHorAlign

接口描述: 设置图标水平对齐方式

参数值:

参数名	参数类型	参数含义
type	DockType	对齐方式枚举

返回值:

void

参数定义:

enum DockType
{
UIG_DOCK_LEFTTOP = 0,
UIG_DOCK_CENTERMIDDLE,
UIG_DOCK_RIGHTBOTTOM
};

示例:

_demoCtrl->SetIconHorAlign();

24. GetIconHorAlign

接口描述: 获取图标水平对齐方式

参数值:

无

返回值:

DockType

参数定义:

enum DockType
{
UIG_DOCK_LEFTTOP = 0,
UIG_DOCK_CENTERMIDDLE,
UIG_DOCK_RIGHTBOTTOM
};

示例:

_demoCtrl->GetIconHorAlign();

25. SetIconVerAlign

接口描述: 设置图标垂直对齐方式

参数值:

参数名	参数类型	参数含义
type	DockType	对齐方式枚举

返回值:

void

参数定义:

enum DockType
{
UIG_DOCK_LEFTTOP = 0,
UIG_DOCK_CENTERMIDDLE,
UIG_DOCK_RIGHTBOTTOM
};

示例:

_demoCtrl->SetIconVerAlign();

26. GetIconVerAlign

接口描述: 获取图标垂直对齐方式

参数值:

无

返回值:

DockType

参数定义:

enum DockType
{
UIG_DOCK_LEFTTOP = 0,
UIG_DOCK_CENTERMIDDLE,
UIG_DOCK_RIGHTBOTTOM
};

示例:

_demoCtrl->GetIconVerAlign();

27. SetIconOffsetX

接口描述: 设置图标水平偏移量

参数值:

参数名	参数类型	参数含义
x	int	水平偏移量

返回值:

void

示例:

_demoCtrl->SetIconOffsetX();

28. GetIconOffsetX

接口描述: 获取图标水平偏移量

参数值:

无

返回值:

int 水平偏移量

示例:

_demoCtrl->GetIconOffsetX();

29. SetIconOffsetY

接口描述: 设置图标垂直偏移量

参数值:

参数名	参数类型	参数含义
x	int	水平偏移量

返回值:

void

示例:

_demoCtrl->SetIconOffsetY();

30. GetIconOffsetY

接口描述: 获取图标垂直偏移量

参数值:

无

返回值:

int 垂直偏移量

示例:

_demoCtrl->GetIconOffsetY();

31. SetAlignTextToLeft

接口描述: 设置文字是否从最左侧开始对齐显示

参数值:

参数名	参数类型	参数含义
alignLeft	bool	是否从最左侧开始对齐显示

返回值:

void

示例:

_demoCtrl->SetAlignTextToLeft();

32. GetAlignTextToLeft

接口描述: 获取文字是否从最左侧开始对齐显示

参数值:

无

返回值:

bool

示例:

_demoCtrl->GetAlignTextToLeft();