SymbolGroups类参考

符号库分组集合类。 更多...

所有成员的列表。

公有成员
(SymbolGroup *)	- getGroupWithIndex:
	获取该分组集合中指定索引处的子分组（即 <SymbolGroup>类对象）。有关分组集合的具体组织结构，请参见 <SymbolGroups> 类的描述。
(SymbolGroup *)	- getGroupWithName:
	根据给定的名称，返回分组集合中相对应的子分组（即 <SymbolGroup> 类对象）。有关分组集合的具体组织结构，请参见 <SymbolGroups> 类的描述。
(NSInteger)	- indexofGroup:
	获取指定名称的子分组对象（即 <SymbolGroup> 类对象）在该分组集合中的索引值。
(SymbolGroup *)	- createGroupWith:
	在分组集合类里新建分组。
(BOOL)	- removeGroupWith:isUpMove:
	在分组集合类里移除子分组。
(BOOL)	- contains:
	在分组集合类是否包含子分组（递归遍历所有子集合）。
属性
NSInteger	count
	获取该分组集合中的子分组的个数。有关分组集合的具体组织结构，请参见 <SymbolGroups> 类的描述。

---

详细描述

符号库分组集合类。

该类的对象是符号库分组对象的集合，即<SymbolGroup> 类对象的集合，用于管理符号库分组中的子分组，包括在分组中创建及移除子分组等操作。

符号库的组织结构类似于Windows资源管理器的组织结构，磁盘的根目录下可以存在零个或多个文件夹以及零个或多个文件，每个文件夹中又可以有零个或多个子文件夹以及零个或多个文件，以此类推层层嵌套；符号库的根组就相当于这个磁盘的根目录，文件夹可以看做符号库的子分组，文件就好比各种符号，一个符号库只能存在一个根组，根组中可以有零个或多个子分组以及零个或多个符号，每个子分组下还可以有零个或多个子分组以及零个或多个符号，以此类推。

根组也是分组，对应 <SymbolGroup> 类对象，根组是符号库的最高分组层次，根组中可以包含零个或多个子分组以及零个或多个符号，子分组也是分组，同样对应 <SymbolGroup> 类对象，其中所有子分组又构成一个子分组集合，对应 <SymbolGroups> 类对象，根组中至多有一个分组集合，即 <SymbolGroups> 类对象， <SymbolGroups> 类对象是 <SymbolGroup> 类对象的集合，用来管理根组中的各子分组，通过 <SymbolGroups> 类对象来完成根组中子分组的创建与移除。当子分组（例如下图绿色框所示）中还包含有零个或多个子分组以及零个或多个符号，那么这些子分组和符号又构成了的一个分组（下图蓝色虚线框所示）， 而这个绿色框标识的子分组称为蓝色虚线框所示的这个分组的父分组，并且，蓝色虚线框中的所有子分组构成了一个子分组集合，对应一个 { <SymbolGroups> 类对象，同样该蓝色虚线框所示的分组中也至多有一个子分组集合，通过这个子分组集合对象来完成该蓝色虚线框所示的分组中的子分组的创建与移除。以此类推，下图中的黄色框所示的子分组对应一个 <SymbolGroup> 类对象，粉色虚线框内的子分组又构成一个分组对象（此分组对象中包含零个符号和三个子分组），即对应一个 <SymbolGroup> 类对象，因此，黄色框所示的分组是粉色虚线框所示分组的父分组，同样粉色虚线框所示分组中也包含了一个子分组集合。总之，符号库呈现一种树形组织结构。

注：所谓的分组和子分组是符号库的逻辑组织形式，都是使用户可以将类别相同的符号放在一个组中，从而方便管理和使用。

综上所述，一个符号库 <SymbolLibrary> 包含有唯一的一个根组 <SymbolGroup> 类对象，每个 <SymbolGroup> 类对象至多包含有一个 <SymbolGroups> 类对象，但却可以包含有零个或多个 <Symbol> 类对象，其中 <SymbolGroups> 类对象是 <SymbolGroup> 类对象的集合，以此实现符号库的树形管理结构。

---

成员函数文档

- (BOOL) contains:

(NSString *)

name

在分组集合类是否包含子分组（递归遍历所有子集合）。

参数:

name子分组名称。

返回:

在分组集合类是否包含子分组。

- (SymbolGroup*) createGroupWith:

(NSString *)

name

在分组集合类里新建分组。

参数:

name

新分组名称。

返回:

该分组集合中新建的子分组。

- (SymbolGroup *) getGroupWithIndex:

(NSInteger)

index

获取该分组集合中指定索引处的子分组（即 <SymbolGroup>类对象）。有关分组集合的具体组织结构，请参见 <SymbolGroups> 类的描述。

参数:

index

指定的索引。

返回:

该分组集合中指定索引处的子分组。

- (SymbolGroup *) getGroupWithName:

(NSString *)

name

根据给定的名称，返回分组集合中相对应的子分组（即 <SymbolGroup> 类对象）。有关分组集合的具体组织结构，请参见 <SymbolGroups> 类的描述。

参数:

name

给定的名称。

返回:

该分组集合中指定名称的子分组。

- (NSInteger) indexofGroup:

(NSString *)

groupName

获取指定名称的子分组对象（即 <SymbolGroup> 类对象）在该分组集合中的索引值。

参数:

groupName

指定的子分组名称，即类对象的名称。

返回:

指定名称的子分组对象在该分组集合中的索引值。

- (BOOL) removeGroupWith:		(NSString *)	name
isUpMove:		(BOOL)	bUpMove

在分组集合类里移除子分组。

参数:

	name子分组名称。
	bUpMove子分组中内容上移

返回:

移除是否成功。

---

属性文档

- (NSInteger) count [read, assign]

获取该分组集合中的子分组的个数。有关分组集合的具体组织结构，请参见 <SymbolGroups> 类的描述。

返回:

该分组集合中的子分组的个数。

---

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

• SymbolGroups.h