Button控件的使用

按钮控件

功能功能

提供用户点击特性，支持图标显示

属性介绍

1. HasIcon 是否显示图标
2. Icon 图标路径
3. HotIcon 高亮图标路径，如果没有设置将使用Icon路径
4. IconHorType 图标水平对齐方式
5. IconVertType 图标垂直对齐方式
6. Text 按钮文本内容
7. ShowText 是否显示文本
8. TextX 文本水平偏移量
9. TextY 文本垂直偏移量
10. Background 按钮背景样式
11. TextFont 按钮文字样式

控件事件介绍

1. UIG_BTN_CLICK

事件处理示例：

 BEGIN_UIG_MESSAGE_MAP(CTestDlg)
    ON_UIG_BN_CLICKED(_btnOpen, BtnClicked)
 END_UIG_MESSAGE_MAP()
 ...
 void CVisualGearDlg::BtnClicked(IUIGearsControl* control)
{
    if (control == _btnOpen)
    {   
    }
}

2. UIG_BTN_DOWN

事件处理示例：

 BEGIN_UIG_MESSAGE_MAP(CTestDlg)
    ON_UIG_BN_DOWN(_btnOpen, BtnDown)
 END_UIG_MESSAGE_MAP()
 ...
 void CVisualGearDlg::BtnDown(IUIGearsControl* control)
{
    if (control == _btnOpen)
    {   
    }
}

3. UIG_BTN_UP

事件处理示例：

 BEGIN_UIG_MESSAGE_MAP(CTestDlg)
    ON_UIG_BN_UP(_btnOpen, BtnUp)
 END_UIG_MESSAGE_MAP()
 ...
 void CVisualGearDlg::BtnUp(IUIGearsControl* control)
{
    if (control == _btnOpen)
    {   
    }
}

4. UIG_BTN_DBCLICK

事件处理示例：

 BEGIN_UIG_MESSAGE_MAP(CTestDlg)
    ON_UIG_BN_DBCLICKED(_btnOpen, BtnDBClicked)
 END_UIG_MESSAGE_MAP()
 ...
 void CVisualGearDlg::BtnDBClicked(IUIGearsControl* control)
{
    if (control == _btnOpen)
    {   
    }
}

接口介绍

1. SetText

接口描述： 设置按钮文本内容

参数值:

参数名	参数类型	参数含义
text	const tchar*	按钮文本内容

返回值： 无

示例：

button.SetText(_T("Hello world"))

2. GetText

接口描述： 获取按钮文本内容

参数值:

无

返回值：

const tchar*

示例：

std::string text = button.GetText(); // text == "hello world"

3. SetIcon

接口描述： 设置按钮图标

参数值:

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

返回值： 无

示例：

button.SetIcon("images/1.png"); 

4. SetIcon

接口描述： 获取按钮图标路径

参数值:

无

返回值：

const tchar*

示例：

std::string iconPath = button.GetText(); // iconPath == "images/1.png"

5. SetHotIcon

接口描述： 设置按钮高亮状态图标

参数值:

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

返回值： 无

示例：

button.SetIcon("images/1.png"); 

6. SetHotIcon

接口描述： 获取按钮高亮状态图标路径

参数值:

无

返回值：

const tchar*

示例：

std::string iconPath = button.GetText(); // iconPath == "images/1.png"

7. SetUseIcon

接口描述： 设置显示图标

参数值:

参数名	参数类型	参数含义
use	bool	是否显示图标

返回值： 无

示例：

button.SetUseIcon(true); 

8. GetUseIcon

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

参数值:

无

返回值：

bool

示例：

bool useIcon = button.GetUseIcon(); // useIcon == true

9. SetTextX

接口描述： 设置按钮文字水平偏移量

参数值:

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

返回值： 无

示例：

button.SetTextX(10); 

10. GetTextX

接口描述： 获取按钮文字水平偏移量

参数值:

无

返回值：

int

示例：

int x = button.GetTextX(); // x == 10 

11. SetTextY

接口描述： 设置按钮文字垂直偏移量

参数值:

参数名	参数类型	参数含义
y	int	偏移量

返回值： 无

示例：

button.SetTextY(10); 

12. GetTextY

接口描述： 获取按钮文字垂直偏移量

参数值:

无

返回值：

int

示例：

int y= button.GetTextY(); // y == 10 

13. SetShowText

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

参数值:

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

返回值： 无

示例：

button.SetShowText(false); 

14. GetShowText

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

参数值:

无

返回值：

bool

示例：

bool showText = button.GetShowText(); // showText == false

15. SetBackgroundStyle

接口描述： 设置背景样式

参数值:

参数名	参数类型	参数含义
state	UIState	状态枚举
style	IUIGearsRectStyle*	状态对象指针

返回值： 无

示例：

UIGears::IUIGearsRectStyle* pStyle = （UIGears::IUIGearsRectStyle*）GetStyleByName(UIGears::UIG_RECTSTYLE, "buttonNormal");
if(pStyle)
{
  button.SetBackgroundStyle(UGears::UI_NORMAL , style); 
}

14. GetBackgroundStyle

接口描述： 获取背景样式

参数值:

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

返回值：

UIGears::IUIGearsRectStyle*

示例：

UIGears::IUIGearsRectStyle* pStyle = button.SetBackgroundStyle(UGears::UI_NORMAL);

16. SetTextStyle

接口描述： 设置文字样式

参数值:

参数名	参数类型	参数含义
state	UIState	背景状态
style	IUIGearsTextStyle*	文字样式指针

返回值： 无

示例：

UIGears::IUIGearsTextStyle* pStyle = （UIGears::IUIGearsTextStyle*）GetStyleByName(UIGears::UIG_TEXTTYLE, "fontNormal");
if(pStyle)
{
  button.SetTextStyle(UGears::UI_NORMAL , style); 
}

17. GetTextStyle

接口描述： 获取文字样式

参数值:

参数名	参数类型	参数含义
state	UIState	字体状态

返回值：

UIGears::IUIGearsTextStyle* 

示例：

UIGears::IUIGearsRectStyle* pStyle = button.SetBackgroundStyle(UGears::UI_NORMAL);

18. SetIconHorDockType

接口描述： 设置图标水平停靠类型

参数值:

参数名	参数类型	参数含义
dock	UIGears::DockType	对齐方式枚举

返回值： 无

示例：

button.SetIconHorDockType(UGears::UIG_DOCK_CENTERMIDDLE); 

19. GetIconHorDockType

接口描述： 获取图标水平停靠类型

参数值:

无

返回值： UIGears::DockType

示例：

UIGears::DockType type = button.GetIconHorDockType(); 

20. SetIconVerDockType

接口描述： 设置图标垂直停靠类型

参数值:

参数名	参数类型	参数含义
dock	UIGears::DockType	对齐方式枚举

返回值： 无

示例：

button.SetIconVerDockType(UGears::UIG_DOCK_CENTERMIDDLE); 

21. GetIconVerDockType

接口描述： 获取图标垂直停靠类型

参数值:

无

返回值： UIGears::DockType

示例：

UIGears::DockType type = button.GetIconVerDockType(); 

22. SetIconX

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

参数值:

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

返回值： 无

示例：

button.SetIconX(10); 

23. GetIconX

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

参数值:

无

返回值： int

示例：

int xOffset = button.GetIconX(); 

24. SetIconY

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

参数值:

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

返回值： 无

示例：

button.SetIconY(10); 

25. GetIconY

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

参数值:

无

返回值： int

示例：

int xOffset = button.GetIconY();