AnyCAD::API::Document类 参考

文档类。 更多...

#include <APIDocument.h>

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

Public 成员函数
void	SetName (const String &name)
String	GetName () const
String	GetUUID () const
DocumentMetadata	GetMetadata () const
void	SetModified (bool bModified)
bool	IsModified () const
ParameterValue	GetParameterValue (ParameterId paramId) const
void	SetParameterValue (ParameterId paramId, const ParameterValue &pParameter)
void	SetMasterTypeId (const ElementId &elemId)
ElementId	GetMasterTypeId () const
void	SetMasterInstanceId (const ElementId &elemId)
ElementId	GetMasterInstanceId () const
String	GetDocumentType () const
void	Close ()
UndoTransaction	NewTransaction (const String &strName)
void	Undo ()
bool	CanUndo () const
void	Redo ()
bool	CanRedo () const
bool	IsUndoEnabled () const
void	EnableUndo (bool bEnable)
bool	IsUndoIgnored () const
void	IgnoreUndo (bool bIgnored)
void	ClearUndoList (int keepCount)
ElementId	AddElement (const Element &pElement)
Element	FindElement (const ElementId &id) const
bool	RemoveElement (const ElementId &id)
ElementTable	FindTable (const String &classId) const
StringList	ListTables () const
void	AddElementToMaster (const ElementIdList &ids)
void	AddElementToMaster (const ElementId &id)
void	ShowElement (const ElementId &id)
void	ShowElement (const ElementIdList &ids)
void	UpdateViews ()
ElementIterator	NewElementIterator () const
Public 成员函数 继承自 AnyCAD::API::Object
String	GetObjectClassId () const
StringList	ListParentClassIds () const

详细描述

文档类。

用于管理Element对象，记录数据的状态。

成员函数说明

ElementId AnyCAD::API::Document::AddElement

(

const Element &

pElement

)

增加Element。在加入前，Element没有被分配ID。

参数

pElement

新加入的Element对象。

返回

Element的ID。

void AnyCAD::API::Document::AddElementToMaster

(

const ElementIdList &

ids

)

[obsoleted] use ShowElement instead. Add the elements to master element.

参数

ids	the ids to add.

void AnyCAD::API::Document::AddElementToMaster

(

const ElementId &

id

)

[obsoleted] use ShowElement instead. Add the element to master element.

参数

id	the ids to add.

bool AnyCAD::API::Document::CanRedo

(

)

const

判断是否可以Redo。

返回

true 如果可以执行Redo操作。

bool AnyCAD::API::Document::CanUndo

(

)

const

判断是否可以Undo。

返回

true 如果可以执行Undo操作。

void AnyCAD::API::Document::ClearUndoList

(

int

keepCount

)

清空Undo列表。之前的修改将不可重做。

参数

keepCount

保留最近的Undo个数。超出的将被清除。

void AnyCAD::API::Document::Close

(

)

关闭文档。

void AnyCAD::API::Document::EnableUndo

(

bool

bEnable

)

启用或者禁止Undo机制。有的时候需要临时禁用Undo机制，可以调用禁用。

参数

bEnable

true 表示启用。

Element AnyCAD::API::Document::FindElement

(

const ElementId &

id

)

const

根据ID查找Element。

参数

id	Element的ID。

返回

Element对象。

ElementTable AnyCAD::API::Document::FindTable

(

const String &

classId

)

const

查找ElementTable。

参数

classId

ElementTable的类ID。

返回

ElementTable对象。

String AnyCAD::API::Document::GetDocumentType

(

)

const

获取文档的类型。

返回

类型标识。

ElementId AnyCAD::API::Document::GetMasterInstanceId

(

)

const

获取主要的InstanceEement ID.

返回

InstanceEement ID.

ElementId AnyCAD::API::Document::GetMasterTypeId

(

)

const

获取主要的TypeElement ID.

返回

TypeElement的ID.

DocumentMetadata AnyCAD::API::Document::GetMetadata

(

)

const

获取文档的Metadata。

返回

返回文档的metadata.

String AnyCAD::API::Document::GetName

(

)

const

获取文档名。

返回

文档名称.

ParameterValue AnyCAD::API::Document::GetParameterValue

(

ParameterId

paramId

)

const

获取文档的自定义参数。

参数

paramId

参数ID.

返回

参数的值。

String AnyCAD::API::Document::GetUUID

(

)

const

获取文档的UUID.

返回

UUID.

void AnyCAD::API::Document::IgnoreUndo

(

bool

bIgnored

)

设置是否忽略接下来的UndoTransaction。忽略后后续对Document的修改则不会被Undo。

参数

bIgnored

true表示忽略。

bool AnyCAD::API::Document::IsModified

(

)

const

判断文档是否被修改过。

返回

true代表被修改了；false表示已经被保存过了。

bool AnyCAD::API::Document::IsUndoEnabled

(

)

const

判断当前是否启用了记录Undo的机制。

返回

true 如果启用。

bool AnyCAD::API::Document::IsUndoIgnored

(

)

const

判断是否忽略接下来的UndoTransaction。

返回

true表示忽略。

StringList AnyCAD::API::Document::ListTables

(

)

const

列出当前文档中所有的ElementTable的类ID。

返回

类ID列表。

ElementIterator AnyCAD::API::Document::NewElementIterator

(

)

const

创建遍历Element的迭代器。

返回

ElementIterator对象.

UndoTransaction AnyCAD::API::Document::NewTransaction

(

const String &

strName

)

创建UndoTransaction对象。

参数

strName

UndoTransaction对象的名称。

返回

UndoTransaction对象。

void AnyCAD::API::Document::Redo

(

)

执行Redo操作。

bool AnyCAD::API::Document::RemoveElement

(

const ElementId &

id

)

移除Element。

参数

id	被移除Element的ID.

void AnyCAD::API::Document::SetMasterInstanceId

(

const ElementId &

elemId

)

设置主要的InstanceEement ID.

参数

elemId

ID.

void AnyCAD::API::Document::SetMasterTypeId

(

const ElementId &

elemId

)

设置 Master Type Element ID.

参数

elemId

ID.

void AnyCAD::API::Document::SetModified

(

bool

bModified

)

设置文档是否被修改了。

参数

bModified

true代表被修改了；false表示已经被保存过了。

void AnyCAD::API::Document::SetName

(

const String &

name

)

设置文档名。

参数

name

名称。

void AnyCAD::API::Document::SetParameterValue	(	ParameterId	paramId,
		const ParameterValue &	pParameter
	)

设置自定义的参数。

参数

paramId	参数ID。
pParameter	参数值。

void AnyCAD::API::Document::ShowElement

(

const ElementId &

id

)

在View中显示Element。

参数

id	Element的ID。

void AnyCAD::API::Document::ShowElement

(

const ElementIdList &

ids

)

在View中显示多个Element。

参数

ids	Element的ID数组.

void AnyCAD::API::Document::Undo

(

)

执行Undo命令。

void AnyCAD::API::Document::UpdateViews

(

)

通知更新所有的View。

---

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

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