Foxit PDF SDK  9.1
FSPageNumberRange Class Reference
Inheritance diagram for FSPageNumberRange:

Instance Methods

(void) - dealloc
 
(void *) - getCptr
 
(id) - init
 
(id) - initWithCptr:swigOwnCObject:
 
(id) - initWithPage_range:
 Constructor, with another page number range object.
More...
 
(id) - initWithStart_number:end_number:filter:
 Constructor, with parameters.
More...
 
(void) - set:end_number:filter:
 Set value.
More...
 

Protected Attributes

BOOL swigCMemOwn
 
void * swigCPtr
 

Properties

int end_number
 Page number of the end page in current range, starting from 1.
More...
 
FSRangeFilter filter
 Filter type to decide which page numbers of this range would be used. Please refer to values starting from FSRangeAll and this should be one of these values.
More...
 
int start_number
 Page number of the start page in current range, starting from 1.
More...
 

Detailed Description

This class represents the page number range (not index range) which is used for class FSHeaderFooter .

See also
FSHeaderFooter

Method Documentation

◆ dealloc

- (void) dealloc

◆ getCptr

- (void*) getCptr

◆ init

- (id) init

◆ initWithCptr:swigOwnCObject:

- (id) initWithCptr: (void *)  cptr
swigOwnCObject: (BOOL)  ownCObject 

◆ initWithPage_range:

- (id) initWithPage_range: (FSPageNumberRange*)  page_range

Constructor, with another page number range object.

Parameters
[in]page_rangeAnother page number range object.

◆ initWithStart_number:end_number:filter:

- (id) initWithStart_number: (int)  start_number
end_number: (int)  end_number
filter: (FSRangeFilter filter 

Constructor, with parameters.

Parameters
[in]start_numberPage number of the start page in current range, starting from 1.
[in]end_numberPage number of the end page in current range, starting from 1.
[in]filterFilter type to decide which page numbers of this range would be used. Please refer to values starting from FSRangeAll and this should be one of these values.

◆ set:end_number:filter:

- (void) set: (int)  start_number
end_number: (int)  end_number
filter: (FSRangeFilter filter 

Set value.

Parameters
[in]start_numberPage number of the start page in current range, starting from 1.
[in]end_numberPage number of the end page in current range, starting from 1.
[in]filterFilter type to decide which page numbers of this range would be used. Please refer to values starting from FSRangeAll and this should be one of these values.
Returns
None.

Member Data Documentation

◆ swigCMemOwn

- (BOOL) swigCMemOwn
protected

◆ swigCPtr

- (void*) swigCPtr
protected

Property Documentation

◆ end_number

- (int) end_number
readwritenonatomicassign

Page number of the end page in current range, starting from 1.

◆ filter

- (FSRangeFilter) filter
readwritenonatomicassign

Filter type to decide which page numbers of this range would be used. Please refer to values starting from FSRangeAll and this should be one of these values.

◆ start_number

- (int) start_number
readwritenonatomicassign

Page number of the start page in current range, starting from 1.