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

Inherits Object.

Public Member Functions

 ContentTreeItemData ()
 Constructor.
 
 ContentTreeItemData (const ContentTreeItemData &other)
 Constructor, with another content tree item data object. More...
 
 ContentTreeItemData (WString name, String id, RectFArray rect_array, int page_index, ContentType type)
 Constructor, with parameters. More...
 
ContentTreeItemData & operator= (const ContentTreeItemData &other)
 Assign operator. More...
 
void Set (WString name, String id, RectFArray rect_array, int page_index, ContentType type)
 Set value. More...
 

Public Attributes

String id
 The item ID.
 
WString name
 The item name.
 
int page_index
 The page index. Valid range: from 0 to (count-1). count is returned by function pdf::PDFDoc::GetPageCount.
 
RectFArray rect_array
 The item rectangle array.
 
ContentType type
 The content type. Please refer to values starting from foxit::addon::accessibility::e_ContentTypeUnknown and this should be one of these values.
 

Detailed Description

This class represents content tree item data.

Constructor & Destructor Documentation

◆ ContentTreeItemData() [1/2]

foxit::addon::accessibility::ContentTreeItemData::ContentTreeItemData ( WString  name,
String  id,
RectFArray  rect_array,
int  page_index,
ContentType  type 
)
inline

Constructor, with parameters.

Parameters
[in]nameThe item name.
[in]idThe item ID.
[in]rect_arrayThe item rectangle array.
[in]page_indexThe page index. Valid range: from 0 to (count-1). count is returned by function pdf::PDFDoc::GetPageCount.
[in]typeThe content type. Please refer to values starting from foxit::addon::accessibility::e_ContentTypeUnknown and this should be one of these values.

◆ ContentTreeItemData() [2/2]

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

Constructor, with another content tree item data object.

Parameters
[in]otherAnother content tree item data object.

Member Function Documentation

◆ operator=()

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

Assign operator.

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

◆ Set()

void foxit::addon::accessibility::ContentTreeItemData::Set ( WString  name,
String  id,
RectFArray  rect_array,
int  page_index,
ContentType  type 
)
inline

Set value.

Parameters
[in]nameThe item name.
[in]idThe item ID.
[in]rect_arrayThe item rectangle array.
[in]page_indexThe page index. Valid range: from 0 to (count-1). count is returned by function pdf::PDFDoc::GetPageCount.
[in]typeThe content type. Please refer to values starting from foxit::addon::accessibility::e_ContentTypeUnknown and this should be one of these values.
Returns
None.