Foxit PDF SDK

构造函数 | 所有成员列表
FSRange类 参考
类 FSRange 继承关系图:

## 构造函数
(void) | - addSegment:end_index:filter:
| 添加新的范围段。（反向排序是合法的。） 更多...
(void) | - addSingle:
| 添加索引作为新的范围段。 更多...
(int) | - getSegmentCount
| 获取范围段的数量。 更多...
(int) | - getSegmentEnd:
| 获取指定范围段的结束索引。 更多...
(int) | - getSegmentStart:
| 获取指定范围段的起始索引。 更多...
(id) | - init
| 构造函数。
(id) | - initWithIndex:
| 带有单个索引的构造函数。 更多...
(id) | - initWithOther:
| 使用另一个范围对象的构造函数。 更多...
(id) | - initWithStart_index:end_index:filter:
| 带有指定索引范围的构造函数。 更多...
(BOOL) | - isEmpty
| 检查当前对象是否为空。 更多...
(void) | - removeAll
| 移除所有范围段。 更多...

## 详细描述

此类表示索引范围。在这里，范围由一个或多个段组成，每个段由 单个索引或一组连续索引组成。
对于某些特殊情况，例如在 pdf::HeaderFooter 中使用的，此范围中指定的索引值直接表示页码而不是页面索引。

参见
  pdf::HeaderFooter

## 函数文档

## ◆ addSegment:end_index:filter:()

- (void) addSegment: |  | (int) | start_index
end_index: |  | (int) | end_index
filter: |  | (FSRangeFilter) | filter

添加新的范围段。（反向排序是合法的。）

参数

  [in] | start_index | 新范围段的起始索引。
  [in] | end_index | 新范围段的结束索引。
  [in] | filter | 过滤器类型，用于决定此范围的哪些索引将被使用。请参考从 FSRangeAll 开始的值，应该是这些值中的一个。 默认值：FSRangeAll。 特别地，当此值为 FSRangeEven 或 FSRangeOdd 时， 意味着指定范围段内的每个偶数或奇数将 被视为单个段。

返回
  无。

## ◆ addSingle:()

- (void) addSingle: |  | (int) | index |

添加索引作为新的范围段。

参数

  [in] | index | 要作为新范围段添加的索引。

## ◆ getSegmentCount()

- (int) getSegmentCount |  |  |

获取范围段的数量。

返回
  范围段的数量。

## ◆ getSegmentEnd:()

- (int) getSegmentEnd: |  | (int) | segment_index |

获取指定范围段的结束索引。

参数

  [in] | segment_index | 段索引。有效范围：0到(count-1)。 count由函数 FSRange::getSegmentCount 返回。

返回
  指定范围段的结束索引。

## ◆ getSegmentStart:()

- (int) getSegmentStart: |  | (int) | segment_index |

获取指定范围段的起始索引。

参数

  [in] | segment_index | 段索引。有效范围：0到(count-1)。 count由函数 FSRange::getSegmentCount 返回。

返回
  指定范围段的起始索引。

## ◆ initWithIndex:()

- (id) initWithIndex: |  | (int) | index |

带有单个索引的构造函数。

参数

  [in] | index | 单个索引。

## ◆ initWithOther:()

- (id) initWithOther: |  | (FSRange*) | other |

使用另一个范围对象的构造函数。

参数

  [in] | other | 另一个范围对象。

## ◆ initWithStart_index:end_index:filter:()

- (id) initWithStart_index: |  | (int) | start_index
end_index: |  | (int) | end_index
filter: |  | (FSRangeFilter) | filter

带有指定索引范围的构造函数。

参数

  [in] | start_index | 范围段的起始索引。
  [in] | end_index | 范围段的结束索引。
  [in] | filter | 过滤器类型，用于决定此范围的哪些索引将被使用。请参考从 FSRangeAll 开始的值，应该是这些值中的一个。 默认值：FSRangeAll。 特别地，当此值为 FSRangeEven 或 FSRangeOdd 时， 意味着指定范围段内的每个偶数或奇数将 被视为单个段。

## ◆ isEmpty()

- (BOOL) isEmpty |  |  |

检查当前对象是否为空。

当当前对象为空时，意味着当前对象无用。

返回
  YES 表示当前对象为空，NO 表示不为空。

## ◆ removeAll()

- (void) removeAll |  |  |

移除所有范围段。

返回
  无。