BkManager-背景管理器

HBKM WINAPI	XBkM_Create ()
	背景_创建 创建背景管理器. 更多...
void WINAPI	XBkM_Destroy (HBKM hBkInfoM)
	背景_销毁 销毁. 更多...
int WINAPI	XBkM_SetBkInfo (HBKM hBkInfoM, const wchar_t *pText)
	@背景_置内容old 废弃函数, 保留为了兼容旧版; 请使用 XBkM_SetInfo() 更多...
int WINAPI	XBkM_SetInfo (HBKM hBkInfoM, const wchar_t *pText)
	背景_置内容 设置背景内容. 更多...
int WINAPI	XBkM_AddInfo (HBKM hBkInfoM, const wchar_t *pText)
	背景_添加内容 添加背景内容. 更多...
void WINAPI	XBkM_AddBorder (HBKM hBkInfoM, int nState, COLORREF color, int width, int id)
	背景_添加边框 添加背景内容边框. 更多...
void WINAPI	XBkM_AddFill (HBKM hBkInfoM, int nState, COLORREF color, int id)
	背景_添加填充 添加背景内容填充. 更多...
void WINAPI	XBkM_AddImage (HBKM hBkInfoM, int nState, HIMAGE hImage, int id)
	背景_添加图片 添加背景内容图片. 更多...
int WINAPI	XBkM_GetCount (HBKM hBkInfoM)
	背景_取数量 获取背景内容数量. 更多...
void WINAPI	XBkM_Clear (HBKM hBkInfoM)
	背景_清空 清空背景内容. 更多...
BOOL WINAPI	XBkM_Draw (HBKM hBkInfoM, int nState, HDRAW hDraw, RECT *pRect)
	背景_绘制 绘制背景内容. 更多...
BOOL WINAPI	XBkM_DrawEx (HBKM hBkInfoM, int nState, HDRAW hDraw, RECT *pRect, int nStateEx)
	背景_绘制扩展 绘制背景内容, 设置条件. 更多...
void WINAPI	XBkM_EnableAutoDestroy (HBKM hBkInfoM, BOOL bEnable)
	@背景_启用自动销毁 是否自动销毁 更多...
void WINAPI	XBkM_AddRef (HBKM hBkInfoM)
	@背景_增加引用计数 更多...
void WINAPI	XBkM_Release (HBKM hBkInfoM)
	@背景_释放引用计数 释放引用计数,当引用计数为0时,自动销毁 更多...
int WINAPI	XBkM_GetRefCount (HBKM hBkInfoM)
	@背景_取引用计数 获取引用计数 更多...
BOOL WINAPI	XBkM_GetStateTextColor (HBKM hBkInfoM, int nState, __out COLORREF *color)
	@背景_取指定状态文本颜色 更多...
vint WINAPI	XBkM_GetObject (HBKM hBkInfoM, int id)
	@背景_取背景对象 更多...

详细描述

操作背景对象请使用 BkObject-背景对象

函数说明

XBkM_AddBorder()

void WINAPI XBkM_AddBorder	(	HBKM	hBkInfoM,
		int	nState,
		COLORREF	color,
		int	width,
		int	id
	)

背景_添加边框 添加背景内容边框.

参数

hBkInfoM	背景管理器句柄.
nState	组合状态 参加文档: API接口->组合状态
color	颜色.
width	线宽.
id	背景对象ID, 可忽略(0)

XBkM_AddFill()

void WINAPI XBkM_AddFill	(	HBKM	hBkInfoM,
		int	nState,
		COLORREF	color,
		int	id
	)

背景_添加填充 添加背景内容填充.

参数

hBkInfoM	背景管理器句柄.
nState	组合状态 参加文档: API接口->组合状态
color	颜色值, 请使用宏: RGBA()
id	背景对象ID, 可忽略(0)

XBkM_AddImage()

void WINAPI XBkM_AddImage	(	HBKM	hBkInfoM,
		int	nState,
		HIMAGE	hImage,
		int	id
	)

背景_添加图片 添加背景内容图片.

参数

hBkInfoM	背景管理器句柄.
nState	组合状态 参加文档: API接口->组合状态
hImage	图片句柄.
id	背景对象ID, 可忽略(0)

XBkM_AddInfo()

int WINAPI XBkM_AddInfo	(	HBKM	hBkInfoM,
		const wchar_t *	pText
	)

背景_添加内容 添加背景内容.

参数

hBkInfoM	背景管理器句柄.
pText	背景内容字符串.

返回

返回添加的背景对象数量.

XBkM_AddRef()

void WINAPI XBkM_AddRef

(

HBKM

hBkInfoM

)

@背景_增加引用计数

参数

hBkInfoM

背景管理器句柄

XBkM_Clear()

void WINAPI XBkM_Clear

(

HBKM

hBkInfoM

)

背景_清空 清空背景内容.

参数

hBkInfoM

背景管理器句柄.

XBkM_Create()

HBKM WINAPI XBkM_Create

(

)

背景_创建 创建背景管理器.

返回

背景管理器句柄.

XBkM_Destroy()

void WINAPI XBkM_Destroy

(

HBKM

hBkInfoM

)

背景_销毁 销毁.

参数

hBkInfoM

背景管理器句柄.

XBkM_Draw()

BOOL WINAPI XBkM_Draw	(	HBKM	hBkInfoM,
		int	nState,
		HDRAW	hDraw,
		RECT *	pRect
	)

背景_绘制 绘制背景内容.

参数

hBkInfoM	背景管理器句柄.
nState	组合状态 参加文档: API接口->组合状态
hDraw	图形绘制句柄.
pRect	区域坐标.

返回

成功返回TRUE否则返回FALSE.

XBkM_DrawEx()

BOOL WINAPI XBkM_DrawEx	(	HBKM	hBkInfoM,
		int	nState,
		HDRAW	hDraw,
		RECT *	pRect,
		int	nStateEx
	)

背景_绘制扩展 绘制背景内容, 设置条件.

参数

hBkInfoM	背景管理器句柄.
nState	组合状态 参加文档: API接口->组合状态
hDraw	图形绘制句柄.
pRect	区域坐标.
nStateEx	当(nState)中包含(nStateEx)中的一个或多个状态时有效.

返回

成功返回TRUE否则返回FALSE.

注解

例如用来绘制列表项时, nState中包含项的状态(nStateEx)才会绘制,避免列表项与元素背景叠加.

XBkM_EnableAutoDestroy()

void WINAPI XBkM_EnableAutoDestroy	(	HBKM	hBkInfoM,
		BOOL	bEnable
	)

@背景_启用自动销毁 是否自动销毁

参数

hBkInfoM	背景管理器句柄
bEnable	是否启用

XBkM_GetCount()

int WINAPI XBkM_GetCount

(

HBKM

hBkInfoM

)

背景_取数量 获取背景内容数量.

参数

hBkInfoM

背景管理器句柄.

返回

背景内容数量.

XBkM_GetObject()

vint WINAPI XBkM_GetObject	(	HBKM	hBkInfoM,
		int	id
	)

@背景_取背景对象

参数

hBkInfoM	背景管理器句柄
id	背景对象ID

返回

返回对象句柄

XBkM_GetRefCount()

int WINAPI XBkM_GetRefCount

(

HBKM

hBkInfoM

)

@背景_取引用计数 获取引用计数

参数

hBkInfoM

背景管理器句柄

返回

返回引用计数.

XBkM_GetStateTextColor()

BOOL WINAPI XBkM_GetStateTextColor	(	HBKM	hBkInfoM,
		int	nState,
		__out COLORREF *	color
	)

@背景_取指定状态文本颜色

参数

hBkInfoM	背景管理器句柄
nState	状态
color	接收返回颜色

返回

如果成功返回TRUE,否则返回FALSE

XBkM_Release()

void WINAPI XBkM_Release

(

HBKM

hBkInfoM

)

@背景_释放引用计数 释放引用计数,当引用计数为0时,自动销毁

参数

hBkInfoM

背景管理器句柄

XBkM_SetBkInfo()

int WINAPI XBkM_SetBkInfo	(	HBKM	hBkInfoM,
		const wchar_t *	pText
	)

@背景_置内容old 废弃函数, 保留为了兼容旧版; 请使用 XBkM_SetInfo()

参数

hBkInfoM	背景管理器句柄.
pText	背景内容字符串.

返回

返回设置的背景对象数量.

XBkM_SetInfo()

int WINAPI XBkM_SetInfo	(	HBKM	hBkInfoM,
		const wchar_t *	pText
	)

背景_置内容 设置背景内容.

参数

hBkInfoM	背景管理器句柄.
pText	背景内容字符串.

返回

返回设置的背景对象数量.