This class represents index range. Here, a range consists of one or more segments and each segment consists of one single index or a group of consecutive indexes.
For some special case, such as used in foxit.conversion.pdf2office.PDF2OfficeSettingData , index values specified in this range represent page numbers directly instead of page indexes.
- See also
- foxit.conversion.pdf2office.PDF2OfficeSettingData
◆ Filter
Enumeration for range filter.
Values of this enumeration should be used alone.
Enumerator |
---|
e_All | All the indexes within a range will be used.
|
e_Even | Only even numbers in a range will be used (discards odd numbers).
|
e_Odd | Only odd numbers in a range will be used (discards even numbers).
|
◆ Range() [1/3]
foxit.common.Range.Range |
( |
int |
index | ) |
|
|
inline |
Constructor, with a single index.
- Parameters
-
◆ Range() [2/3]
foxit.common.Range.Range |
( |
int |
start_index, |
|
|
int |
end_index, |
|
|
Range.Filter |
filter |
|
) |
| |
|
inline |
Constructor, with a specified index range.
- Parameters
-
[in] | start_index | The start index of a range segment. |
[in] | end_index | The end index of a range segment. |
[in] | filter | Filter type to decide which indexes of this range would be used. Please refer to values starting from foxit.common.Range.Filter.e_All and this should be one of these values.
Specially, when this value is foxit.common.Range.Filter.e_Even or foxit.common.Range.Filter.e_Odd , that means each even or odd number within the specified range segment will be treated as a single segment. |
◆ Range() [3/3]
foxit.common.Range.Range |
( |
Range |
other | ) |
|
|
inline |
Constructor, with another range object.
- Parameters
-
[in] | other | Another range object. |
◆ AddSegment()
void foxit.common.Range.AddSegment |
( |
int |
start_index, |
|
|
int |
end_index, |
|
|
Range.Filter |
filter |
|
) |
| |
|
inline |
Add a new range segment. (Reverse ordering is legal.)
- Parameters
-
[in] | start_index | The start index of a new range segment. |
[in] | end_index | The end index of a new range segment. |
[in] | filter | Filter type to decide which indexes of this range would be used. Please refer to values starting from foxit.common.Range.Filter.e_All and this should be one of these values.
Specially, when this value is foxit.common.Range.Filter.e_Even or foxit.common.Range.Filter.e_Odd , that means each even or odd number within the specified range segment will be treated as a single segment. |
- Returns
- None.
◆ AddSingle()
void foxit.common.Range.AddSingle |
( |
int |
index | ) |
|
|
inline |
Add an index as a new range segment.
- Parameters
-
[in] | index | An index to be added as a new range segment. |
◆ GetSegmentCount()
int foxit.common.Range.GetSegmentCount |
( |
| ) |
|
|
inline |
Get the count of range segments.
- Returns
- The count of range segments.
◆ GetSegmentEnd()
int foxit.common.Range.GetSegmentEnd |
( |
int |
segment_index | ) |
|
|
inline |
Get the end index of a specified range segment.
- Parameters
-
[in] | segment_index | The segment index. Valid range: 0 to (count-1). count is returned by function Range.GetSegmentCount . |
- Returns
- The end index of a specified range segment.
◆ GetSegmentStart()
int foxit.common.Range.GetSegmentStart |
( |
int |
segment_index | ) |
|
|
inline |
Get the start index of a specified range segment.
- Parameters
-
[in] | segment_index | The segment index. Valid range: 0 to (count-1). count is returned by function Range.GetSegmentCount . |
- Returns
- The start index of a specified range segment.
◆ IsEmpty()
bool foxit.common.Range.IsEmpty |
( |
| ) |
|
|
inline |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
- Returns
- true means current object is empty, while false means not.
◆ RemoveAll()
void foxit.common.Range.RemoveAll |
( |
| ) |
|
|
inline |
Remove all range segments.
- Returns
- None.