Foxit PDF SDK
|
Public Types | |
enum | Filter { e_All = 0, e_Even = 1, e_Odd = 2 } |
Enumeration for range filter. More... | |
Public Member Functions | |
Range () | |
Constructor. | |
Range (int index) | |
Constructor, with a single index. More... | |
Range (int start_index, int end_index, Filter filter=e_All) | |
Constructor, with a specified index range. More... | |
Range (const Range &other) | |
Constructor, with another range object. More... | |
~Range () | |
Destructor. | |
void | AddSegment (int start_index, int end_index, Filter filter=e_All) |
Add a new range segment. (Reverse ordering is legal.) More... | |
void | AddSingle (int index) |
Add an index as a new range segment. More... | |
int | GetSegmentCount () const |
Get the count of range segments. More... | |
int | GetSegmentEnd (int segment_index) const |
Get the end index of a specified range segment. More... | |
int | GetSegmentStart (int segment_index) const |
Get the start index of a specified range segment. More... | |
bool | IsEmpty () const |
Check whether current object is empty or not. More... | |
bool | operator != (const Range &other) const |
Not equal operator. More... | |
Range & | operator= (const Range &other) |
Assign operator. More... | |
bool | operator== (const Range &other) const |
Equal operator. More... | |
void | RemoveAll () |
Remove all range segments. More... | |
![]() | |
FS_HANDLE | Handle () const |
Get the handle of current object. More... | |
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 pdf::HeaderFooter, index values specified in this range represent page numbers directly instead of page indexes.
|
explicit |
Constructor, with a single index.
[in] | index | A single index. |
Constructor, with a specified index range.
[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 Range::e_All and this should be one of these values. Default value: Range::e_All. Specially, when this value is Range::e_Even or Range::e_Odd, that means each even or odd number within the specified range segment will be treated as a single segment. |
foxit::common::Range::Range | ( | const Range & | other | ) |
Constructor, with another range object.
[in] | other | Another range object. |
Add a new range segment. (Reverse ordering is legal.)
[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 Range::e_All and this should be one of these values. Default value: Range::e_All. Specially, when this value is Range::e_Even or Range::e_Odd, that means each even or odd number within the specified range segment will be treated as a single segment. |
void foxit::common::Range::AddSingle | ( | int | index | ) |
Add an index as a new range segment.
[in] | index | An index to be added as a new range segment. |
int foxit::common::Range::GetSegmentCount | ( | ) | const |
Get the count of range segments.
int foxit::common::Range::GetSegmentEnd | ( | int | segment_index | ) | const |
Get the end index of a specified range segment.
[in] | segment_index | The segment index. Valid range: 0 to (count-1). count is returned by function Range::GetSegmentCount. |
int foxit::common::Range::GetSegmentStart | ( | int | segment_index | ) | const |
Get the start index of a specified range segment.
[in] | segment_index | The segment index. Valid range: 0 to (count-1). count is returned by function Range::GetSegmentCount. |
bool foxit::common::Range::IsEmpty | ( | ) | const |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
bool foxit::common::Range::operator != | ( | const Range & | other | ) | const |
Not equal operator.
[in] | other | Another range object. This function will check if current object is not equal to this one. |
Assign operator.
[in] | other | Another range object, whose value would be assigned to current object. |
bool foxit::common::Range::operator== | ( | const Range & | other | ) | const |
Equal operator.
[in] | other | Another range object. This function will check if current object is equal to this one. |
void foxit::common::Range::RemoveAll | ( | ) |
Remove all range segments.