foxit::addon::accessibility::TagTreeItemData Class Reference

Inherits Object.

Public Types
enum	TagImageType {   e_TagImageTypePDF = 0, e_TagImageTypePageObject = 1, e_TagImageTypeTagParagraph = 2, e_TagImageTypeTagSection = 3,   e_TagImageTypeTable = 4, e_TagImageTypeTableDataCell = 5, e_TagImageTypeTableHeaderCell = 6, e_TagImageTypeTableRow = 7,   e_TagImageTypeTagNode = 8 }
	Enumeration for tag image type. More...
enum	TagNodeType { e_TagNodeTypeElement = 0, e_TagNodeTypeMarkedContentSeq = 1, e_TagNodeTypeObject = 2 }
	Enumeration for tag node type. More...

Public Member Functions
	TagTreeItemData ()
	Constructor.
	TagTreeItemData (const wchar_t *item_name, const char *item_id, const char *item_pos, RectFArray item_rects, int page_index, TagImageType item_image_type, TagNodeType item_node_type)
	Constructor, with parameters. More...
	TagTreeItemData (const TagTreeItemData &other)
	Constructor, with another accessibility tag tree item data object. More...
TagTreeItemData &	operator= (const TagTreeItemData &other)
	Assign operator. More...
void	Set (const wchar_t *item_name, const char *item_id, const char *item_pos, RectFArray item_rects, int page_index, TagImageType item_image_type, TagNodeType item_node_type)
	Set value. More...

Public Attributes
String	item_id
	The unique identifier of the tag tree item.
TagImageType	item_image_type
	The image type used to represent this tag tree item. Please refer to values starting from TagTreeItemData::e_TagImageTypePDF.
WString	item_name
	The display name of the tag tree item.
TagNodeType	item_node_type
	The node type of this tag tree item. Please refer to values starting from TagTreeItemData::e_TagNodeTypeElement.
String	item_pos
	The position descriptor of the tag tree item.
RectFArray	item_rects
	The rectangles associated with this tag tree item.
int	page_index
	The page index where this tag tree item is located. Valid range: from 0 to (count-1), where count is returned by function pdf::PDFDoc::GetPageCount.

Detailed Description

This class represents accessibility tag tree item data.

Member Enumeration Documentation

TagImageType

enum foxit::addon::accessibility::TagTreeItemData::TagImageType

Enumeration for tag image type.

Values of this enumeration should be used alone.

Enumerator
e_TagImageTypePDF	Tag image type : PDF.
e_TagImageTypePageObject	Tag image type : page object.
e_TagImageTypeTagParagraph	Tag image type : tag paragraph.
e_TagImageTypeTagSection	Tag image type : tag section.
e_TagImageTypeTable	Tag image type : table.
e_TagImageTypeTableDataCell	Tag image type : table data cell.
e_TagImageTypeTableHeaderCell	Tag image type : table header cell.
e_TagImageTypeTableRow	Tag image type : table row.
e_TagImageTypeTagNode	Tag image type : tag node.

TagNodeType

enum foxit::addon::accessibility::TagTreeItemData::TagNodeType

Enumeration for tag node type.

Values of this enumeration should be used alone.

Enumerator
e_TagNodeTypeElement	Tag node type : element.
e_TagNodeTypeMarkedContentSeq	Tag node type : marked content sequence.
e_TagNodeTypeObject	Tag node type : object.

Constructor & Destructor Documentation

TagTreeItemData() [1/2]

foxit::addon::accessibility::TagTreeItemData::TagTreeItemData ( const wchar_t *  item_name, const char *  item_id, const char *  item_pos, RectFArray  item_rects, int  page_index, TagImageType  item_image_type, TagNodeType  item_node_type  )

inline

Constructor, with parameters.

Parameters

[in]	item_name	The display name of the tag tree item.
[in]	item_id	The unique identifier of the tag tree item.
[in]	item_pos	The position descriptor of the tag tree item.
[in]	item_rects	The rectangles associated with this tag tree item.
[in]	page_index	The page index where this tag tree item is located. Valid range: from 0 to (count-1). count is returned by function pdf::PDFDoc::GetPageCount.
[in]	item_image_type	The image type used to represent this tag tree item.
[in]	item_node_type	The node type of this tag tree item.

TagTreeItemData() [2/2]

foxit::addon::accessibility::TagTreeItemData::TagTreeItemData ( const TagTreeItemData &  other )

inline

Constructor, with another accessibility tag tree item data object.

Parameters

[in]

other

Another accessibility tag tree item data object whose values are copied to initialize the current object.

Member Function Documentation

operator=()

TagTreeItemData& foxit::addon::accessibility::TagTreeItemData::operator= ( const TagTreeItemData &  other )

inline

Assign operator.

Parameters

[in]

other

Another accessibility tag tree item data object whose values are assigned to the current object.

Returns

Reference to current object itself.

Set()

void foxit::addon::accessibility::TagTreeItemData::Set ( const wchar_t *  item_name, const char *  item_id, const char *  item_pos, RectFArray  item_rects, int  page_index, TagImageType  item_image_type, TagNodeType  item_node_type  )

inline

Set value.

Parameters

[in]	item_name	The display name of the tag tree item.
[in]	item_id	The unique identifier of the tag tree item.
[in]	item_pos	The position descriptor of the tag tree item.
[in]	item_rects	The rectangles associated with this tag tree item.
[in]	page_index	The page index where this tag tree item is located. Valid range: from 0 to (count-1). count is returned by function pdf::PDFDoc::GetPageCount.
[in]	item_image_type	The image type used to represent this tag tree item.
[in]	item_node_type	The node type of this tag tree item.

Returns

None.