Foxit PDF SDK
FSTreeItemInfo Class Reference

Inherits NSObject.

Instance Methods

(id) - init
 Constructor.

 
(id) - initWithOther:
 Constructor, with another reading order tree item info object.
More...
 
(void) - set:order_index:page_index:text:rect:
 Set value.
More...
 

Properties

int order_index
 The order index of item, beginning from 0.

 
int page_index
 The page index of selected item. Valid range: from 0 to (count-1). count is returned by function FSPDFDoc::getPageCount.

 
FSRectF * rect
 The rect of page content item.

 
NSString * text
 The text of item, shown in UI.

 
FSContentType type
 The type of item content. Please refer to values starting from FSContentTypeUnknown and this should be one of these values.

 

Detailed Description

This class represents data used for reading order tree item info.

Method Documentation

◆ initWithOther:()

- (id) initWithOther: (FSTreeItemInfo*)  other

Constructor, with another reading order tree item info object.

Parameters
[in]otherAnother reading order tree item info object.

◆ set:order_index:page_index:text:rect:()

- (void) set: (FSContentType)  type
order_index: (int)  order_index
page_index: (int)  page_index
text: (NSString *)  text
rect: (FSRectF*)  rect 

Set value.

Parameters
[in]typeThe content type. Please refer to values starting from FSContentTypeUnknown and this should be one of these values.
[in]order_indexThe order index.
[in]page_indexThe page index. Valid range: from 0 to (count-1). count is returned by function FSPDFDoc::getPageCount.
[in]textThe item text.
[in]rectThe rectangle.
Returns
None.