AnyCAD::API::ParameterUI类 参考

The UI description for parameters. 更多...

#include <APIParameterUI.h>

类 AnyCAD::API::ParameterUI 继承关系图:

Public 成员函数
int	GetIndex () const
void	SetParamId (const String &paramId)
String	GetParamId () const
void	SetName (const String &strName)
String	GetName () const
void	SetVisible (bool bVisible)
bool	IsVisible () const
void	SetReadonly (bool bReadonly)
bool	IsReadonly () const
void	SetGroup (bool bGroup)
bool	IsGroup () const
void	SetUsedByScript (bool bUseByScript)
bool	IsUsedByScript () const
void	SetGroupName (const String &groupParamId)
String	GetGroupName () const
void	SetDescription (const String &desc)
String	GetDescription () const
void	SetControlId (const String &controlId)
String	GetControlId () const
void	SetControlType (const String &controlType)
String	GetControlType () const
bool	SetParameter (const String &paramId, const ParameterValue &pValue)
ParameterValue	GetParameter (const String &paramId) const
Public 成员函数 继承自 AnyCAD::API::Object
String	GetObjectClassId () const
StringList	ListParentClassIds () const

详细描述

The UI description for parameters.

TODO:

成员函数说明

String AnyCAD::API::ParameterUI::GetControlId

(

)

const

Get control id.

String AnyCAD::API::ParameterUI::GetControlType

(

)

const

Get control type.

String AnyCAD::API::ParameterUI::GetDescription

(

)

const

Get the description of the ParameterUI.

返回

the description of the ParameterUI.

String AnyCAD::API::ParameterUI::GetGroupName

(

)

const

Get the group name of the ParameterUI.

返回

the group name of the ParameterUI.

int AnyCAD::API::ParameterUI::GetIndex

(

)

const

Get the index of this ParameterUI.

返回

the index of this ParameterUI.

String AnyCAD::API::ParameterUI::GetName

(

)

const

Get the readable UI name.

返回

the name of this ParameterUI.

ParameterValue AnyCAD::API::ParameterUI::GetParameter

(

const String &

paramId

)

const

Get Parameter value.

参数

paramId

the id.

返回

the ParameterValue

String AnyCAD::API::ParameterUI::GetParamId

(

)

const

Get the ParamId of this ParameterUI.

返回

the ParamId of this ParameterUI.

bool AnyCAD::API::ParameterUI::IsGroup

(

)

const

If the ParameterUI is group.

返回

true if it's group.

bool AnyCAD::API::ParameterUI::IsReadonly

(

)

const

Get the read only of this ParameterUI.

返回

true if the ParameterUI is read only.

bool AnyCAD::API::ParameterUI::IsUsedByScript

(

)

const

If the ParameterUI is used by script.

返回

true if it's used by script.

bool AnyCAD::API::ParameterUI::IsVisible

(

)

const

Get the visibility of this ParameterUI.

返回

the visibility of this ParameterUI.

void AnyCAD::API::ParameterUI::SetControlId

(

const String &

controlId

)

Set control id.

参数

controlId

the id.

void AnyCAD::API::ParameterUI::SetControlType

(

const String &

controlType

)

Set control type.

参数

controlType

the control type.

void AnyCAD::API::ParameterUI::SetDescription

(

const String &

desc

)

Set the description.

参数

desc	the description.

void AnyCAD::API::ParameterUI::SetGroup

(

bool

bGroup

)

Set it used as Group.

参数

bGroup

true for group usage.

void AnyCAD::API::ParameterUI::SetGroupName

(

const String &

groupParamId

)

Set the parent group name.

参数

groupParamId

the group parameter id.

void AnyCAD::API::ParameterUI::SetName

(

const String &

strName

)

Set the name.

参数

strName

the name.

bool AnyCAD::API::ParameterUI::SetParameter	(	const String &	paramId,
		const ParameterValue &	pValue
	)

Set parameter

参数

paramId	the id.
pValue	the value.

void AnyCAD::API::ParameterUI::SetParamId

(

const String &

paramId

)

Set the ParamId.

参数

paramId

the parameter id.

void AnyCAD::API::ParameterUI::SetReadonly

(

bool

bReadonly

)

Set the read-ability.

参数

bReadonly

readable or writable.

void AnyCAD::API::ParameterUI::SetUsedByScript

(

bool

bUseByScript

)

Set it accessible via the script.

参数

bUseByScript

true for script.

void AnyCAD::API::ParameterUI::SetVisible

(

bool

bVisible

)

Set the visibility.

参数

bVisible

show or hide the parameter ui.

---

该类的文档由以下文件生成:

• E:/Depot/sdk.cpp.ent/inc/Core/APIParameterUI.h