Inheritance diagram for ICaret:

Public Member Functions
	DEF_OBJ_BASE (ICaret, Undef) long AddRef() PURE
	添加引用

long	Release () PURE
	释放引用

void	OnFinalRelease () PURE
	释放对象

BOOL	IsClass (LPCWSTR lpszName) SCONST PURE
	判断this是不是属于指定的类型

LPCWSTR	GetObjectClass () SCONST PURE
	获得类型名

int	GetObjectType () SCONST PURE
	获得对象类型

int	GetID () SCONST PURE
	获取对象ID

void	SetID (int nID) PURE
	设置对象ID

LPCWSTR	GetName () SCONST PURE
	获取对象Name

LPCSTR	GetNameA () SCONST PURE

void	SetName (LPCWSTR pszName) PURE
	设置对象Name

BOOL	InitFromXml (IXmlNode *xmlNode) PURE
	从XML结节初始化SObject对象

void	OnInitFinished (IXmlNode *xmlNode) PURE
	属性初始化完成处理接口

HRESULT	ISetAttribute (const IStringW strAttribName, const IStringW strValue, BOOL bLoading) PURE
	设置一个对象属性

HRESULT	SetAttributeA (LPCSTR pszAttr, LPCSTR pszValue, BOOL bLoading DEF_VAL(FALSE)) PURE
	设置一个对象属性

HRESULT	SetAttribute (LPCWSTR pszAttr, LPCWSTR pszValue, BOOL bLoading DEF_VAL(FALSE)) PURE
	设置一个对象属性

BOOL	GetAttribute (LPCWSTR strAttr, IStringW *pValue) SCONST PURE
	通过属性名查询属性值

HRESULT	AfterAttribute (LPCWSTR pszAttr, LPCWSTR pszValue, BOOL bLoading, HRESULT hr) PURE
	属性处理后调用的方法

void	SetAttrHandler (FunAttrHandler attrHandler) PURE
	设置属性处理回调方法

BOOL	Init (HBITMAP hBmp, int nWid, int nHei) PURE
	初始化光标

void	SetPosition (int x, int y) PURE
	设置光标位置

BOOL	SetVisible (BOOL bVisible, SWND owner) PURE
	设置光标显示状态

BOOL	IsVisible () SCONST PURE
	获取光标显示状态

void	Draw (IRenderTarget *pRT) PURE
	绘制光标

RECT	GetRect () SCONST PURE
	获取光标显示矩形

Public Member Functions inherited from IObject
long	AddRef () PURE
	添加引用

long	Release () PURE
	释放引用

void	OnFinalRelease () PURE
	释放对象

BOOL	IsClass (LPCWSTR lpszName) SCONST PURE
	判断this是不是属于指定的类型

LPCWSTR	GetObjectClass () SCONST PURE
	获得类型名

int	GetObjectType () SCONST PURE
	获得对象类型

int	GetID () SCONST PURE
	获取对象ID

void	SetID (int nID) PURE
	设置对象ID

LPCWSTR	GetName () SCONST PURE
	获取对象Name

LPCSTR	GetNameA () SCONST PURE

void	SetName (LPCWSTR pszName) PURE
	设置对象Name

BOOL	InitFromXml (IXmlNode *xmlNode) PURE
	从XML结节初始化SObject对象

void	OnInitFinished (IXmlNode *xmlNode) PURE
	属性初始化完成处理接口

HRESULT	ISetAttribute (const IStringW strAttribName, const IStringW strValue, BOOL bLoading) PURE
	设置一个对象属性

HRESULT	SetAttributeA (LPCSTR pszAttr, LPCSTR pszValue, BOOL bLoading DEF_VAL(FALSE)) PURE
	设置一个对象属性

HRESULT	SetAttribute (LPCWSTR pszAttr, LPCWSTR pszValue, BOOL bLoading DEF_VAL(FALSE)) PURE
	设置一个对象属性

BOOL	GetAttribute (LPCWSTR strAttr, IStringW *pValue) SCONST PURE
	通过属性名查询属性值

HRESULT	AfterAttribute (LPCWSTR pszAttr, LPCWSTR pszValue, BOOL bLoading, HRESULT hr) PURE
	属性处理后调用的方法

void	SetAttrHandler (FunAttrHandler attrHandler) PURE
	设置属性处理回调方法

Public Member Functions inherited from IObjRef
long	AddRef () PURE
	Increases the reference count.

long	Release () PURE
	Decreases the reference count.

void	OnFinalRelease () PURE
	Called when the reference count reaches zero and the object is about to be released.

Detailed Description

Definition at line 11 of file scaret-i.h.

Member Function Documentation

◆ AfterAttribute()

HRESULT ICaret::AfterAttribute	(	LPCWSTR	pszAttr,
		LPCWSTR	pszValue,
		BOOL	bLoading,
		HRESULT	hr )

属性处理后调用的方法

OnAttribute

Parameters

LPCWSTR	pszAttr– 属性名
LPCWSTR	pszValue – 属性值
BOOL	bLoading – 对象创建时由系统调用标志
HRESULT	hr – 属性处理结果 Describe 不做处理，直接返回

◆ Draw()

void ICaret::Draw ( IRenderTarget * pRT )

绘制光标

Parameters

pRT	–绘制光标的RenderTarget

Returns

◆ GetAttribute()

BOOL ICaret::GetAttribute	(	LPCWSTR	strAttr,
		IStringW *	pValue )

通过属性名查询属性值

GetAttribute

Parameters

LPCWSTR	strAttr – 属性名
IStringW	* pValue – 属性值

Returns: BOOL, TRUE:获取成功，FALSE:获取失败，属性不存在 Describe 默认返回空

◆ GetID()

int ICaret::GetID ( )

获取对象ID

GetID

Returns: int – 对象ID Describe

◆ GetName()

LPCWSTR ICaret::GetName ( )

获取对象Name

GetName

Returns: LPCWSTR – 对象Name Describe

◆ GetObjectClass()

LPCWSTR ICaret::GetObjectClass ( )

获得类型名

GetObjectClass

Returns: LPCWSTR – 类型名 Describe 这是一个虚函数，注意与GetClassName的区别。

◆ GetObjectType()

int ICaret::GetObjectType ( )

获得对象类型

GetObjectType

Returns: int – 对象类型 Describe 这是一个虚函数，注意与GetClassType的区别。

◆ GetRect()

RECT ICaret::GetRect ( )

获取光标显示矩形

Returns: RECT

◆ Init()

BOOL ICaret::Init	(	HBITMAP	hBmp,
		int	nWid,
		int	nHei )

初始化光标

Parameters

hBmp	–光标的位图，可以为空
nWid	–光标宽度
nHei	–光标高度

Returns: BOOL TRUE-成功

◆ InitFromXml()

BOOL ICaret::InitFromXml ( IXmlNode * xmlNode )

从XML结节初始化SObject对象

InitFromXml

Parameters

SXmlNode – XML结节

Returns: BOOL – 成功返回TRUE Describe

◆ IsClass()

BOOL ICaret::IsClass ( LPCWSTR lpszName )

判断this是不是属于指定的类型

IsClass

Parameters

LPCWSTR lpszName – 测试类型名

Returns: BOOL – true是测试类型 Describe

◆ ISetAttribute()

HRESULT ICaret::ISetAttribute	(	const IStringW *	strAttribName,
		const IStringW *	strValue,
		BOOL	bLoading )

设置一个对象属性

ISetAttribute

Parameters

const	IStringW *strAttribName – 属性名
const	IStringW *strValue – 属性值
BOOL	bLoading – 对象创建时由系统调用标志

Returns: HRESULT – 处理处理结果 Describe

◆ IsVisible()

BOOL ICaret::IsVisible ( )

获取光标显示状态

Returns: BOOL TRUE-显示

◆ OnInitFinished()

void ICaret::OnInitFinished ( IXmlNode * xmlNode )

属性初始化完成处理接口

OnInitFinished

Parameters

SXmlNode xmlNode – 属性节点

Returns: void Describe

◆ SetAttrHandler()

void ICaret::SetAttrHandler ( FunAttrHandler attrHandler )

设置属性处理回调方法

SetAttrHandler

Parameters

FunAttrHandler attrHandler– 属性处理回调方法

Returns: void Describe

◆ SetAttribute()

HRESULT ICaret::SetAttribute	(	LPCWSTR	pszAttr,
		LPCWSTR	pszValue,
		BOOL bLoading	DEF_VALFALSE )

设置一个对象属性

SetAttribute

Parameters

LPCWSTR	pszAttr – 属性名
LPCWSTR	pszValue – 属性值
BOOL	bLoading – 对象创建时由系统调用标志

Returns: HRESULT – 处理处理结果 Describe

◆ SetAttributeA()

HRESULT ICaret::SetAttributeA	(	LPCSTR	pszAttr,
		LPCSTR	pszValue,
		BOOL bLoading	DEF_VALFALSE )

设置一个对象属性

SetAttribute

Parameters

LPCSTR	pszAttr – 属性名
LPCSTR	pszValue – 属性值
BOOL	bLoading – 对象创建时由系统调用标志

Returns: HRESULT – 处理处理结果 Describe

◆ SetID()

void ICaret::SetID ( int nID )

设置对象ID

Parameters

nID int–对象ID

Returns

◆ SetName()

void ICaret::SetName ( LPCWSTR pszName )

设置对象Name

Parameters

pszName LPCWSTR – 对象Name

Returns

◆ SetPosition()

void ICaret::SetPosition	(	int	x,
		int	y )

设置光标位置

Parameters

x	– X
y	– Y

Returns

◆ SetVisible()

BOOL ICaret::SetVisible	(	BOOL	bVisible,
		SWND	owner )

设置光标显示状态

Parameters

bVisible	–显示状态
owner	–光标的宿主

Returns: BOOL TRUE-成功

The documentation for this struct was generated from the following file:

SOUI/include/interface/scaret-i.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ AfterAttribute()

◆ Draw()

◆ GetAttribute()

◆ GetID()

◆ GetName()

◆ GetObjectClass()

◆ GetObjectType()

◆ GetRect()

◆ Init()

◆ InitFromXml()

◆ IsClass()

◆ ISetAttribute()

◆ IsVisible()

◆ OnInitFinished()

◆ SetAttrHandler()

◆ SetAttribute()

◆ SetAttributeA()

◆ SetID()

◆ SetName()

◆ SetPosition()

◆ SetVisible()