Foxit PDF SDK
foxit::addon::accessibility::TreeItemInfo Class Reference

Inherits Object.

Public Member Functions

 TreeItemInfo ()
 Constructor.
 
 TreeItemInfo (const TreeItemInfo &other)
 Constructor, with another reading order tree item info object. More...
 
 TreeItemInfo (ContentType type, int order_index, int page_index, const wchar_t *text, foxit::RectF rect)
 Constructor. More...
 
TreeItemInfo & operator= (const TreeItemInfo &other)
 Assign operator. More...
 
void Set (ContentType type, int order_index, int page_index, const wchar_t *text, foxit::RectF rect)
 Set value. More...
 

Public Attributes

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 pdf::PDFDoc::GetPageCount.
 
foxit::RectF rect
 The rect of page content item.
 
WString text
 The text of item, shown in UI.
 
ContentType type
 The type of item content. Please refer to values starting from foxit::addon::accessibility::e_ContentTypeUnknown and this should be one of these values.
 

Detailed Description

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

Constructor & Destructor Documentation

◆ TreeItemInfo() [1/2]

foxit::addon::accessibility::TreeItemInfo::TreeItemInfo ( ContentType  type,
int  order_index,
int  page_index,
const wchar_t *  text,
foxit::RectF  rect 
)
inline

Constructor.

Parameters
[in]typeThe content type. Please refer to values starting from foxit::addon::accessibility::e_ContentTypeUnknown 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 pdf::PDFDoc::GetPageCount.
[in]textThe item text.
[in]rectThe rectangle.
Returns
None.

◆ TreeItemInfo() [2/2]

foxit::addon::accessibility::TreeItemInfo::TreeItemInfo ( const TreeItemInfo &  other)
inline

Constructor, with another reading order tree item info object.

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

Member Function Documentation

◆ operator=()

TreeItemInfo& foxit::addon::accessibility::TreeItemInfo::operator= ( const TreeItemInfo &  other)
inline

Assign operator.

Parameters
[in]otherAnother reading order tree item info object, whose value would be assigned to current object.
Returns
Reference to current object itself.

◆ Set()

void foxit::addon::accessibility::TreeItemInfo::Set ( ContentType  type,
int  order_index,
int  page_index,
const wchar_t *  text,
foxit::RectF  rect 
)
inline

Set value.

Parameters
[in]typeThe content type. Please refer to values starting from foxit::addon::accessibility::e_ContentTypeUnknown 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 pdf::PDFDoc::GetPageCount.
[in]textThe item text.
[in]rectThe rectangle.
Returns
None.