fsdk.TreeItemInfo Class Reference

Public Member Functions
def	GetOrder_index ()
	Get the order index of item, beginning from 0. More...
def	GetPage_index ()
	Get the page index of selected item. More...
def	GetRect ()
	Get the rect of page content item. More...
def	GetText ()
	Get the text of item, shown in UI. More...
def	Set (type, order_index, page_index, text, rect)
	Set value. More...
def	SetOrder_index (value)
	Set the order index of item, beginning from 0. More...
def	SetPage_index (value)
	Set the page index of selected item. More...
def	SetRect (value)
	Set the rect of page content item. More...
def	SetText (value)
	Set the text of item, shown in UI. More...

Detailed Description

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

Member Function Documentation

GetOrder_index()

fsdk.TreeItemInfo.GetOrder_index

(

)

Get the order index of item, beginning from 0.

Returns

The order index of item, beginning from 0.

GetPage_index()

fsdk.TreeItemInfo.GetPage_index

(

)

Get the page index of selected item.

Returns

The page index of selected item. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFDoc.GetPageCount .

GetRect()

fsdk.TreeItemInfo.GetRect

(

)

Get the rect of page content item.

Returns

The rect of page content item.

GetText()

fsdk.TreeItemInfo.GetText

(

)

Get the text of item, shown in UI.

Returns

The text of item, shown in UI.

Set()

def fsdk.TreeItemInfo.Set	(		type,
			order_index,
			page_index,
			text,
			rect
	)

Set value.

Parameters

[in]	type	The content type. Please refer to values starting from fsdk.E_ContentTypeUnknown and this should be one of these values.
[in]	order_index	The order index.
[in]	page_index	The page index. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFDoc.GetPageCount .
[in]	text	The item text.
[in]	rect	The rectangle.

Returns

None.

SetOrder_index()

fsdk.TreeItemInfo.SetOrder_index

(

value

)

Set the order index of item, beginning from 0.

Parameters

[in]

value

The order index of item, beginning from 0.

Returns

None.

SetPage_index()

fsdk.TreeItemInfo.SetPage_index

(

value

)

Set the page index of selected item.

Parameters

[in]

value

The page index of selected item. Valid range: from 0 to (count-1). count is returned by function fsdk.PDFDoc.GetPageCount .

Returns

None.

SetRect()

fsdk.TreeItemInfo.SetRect

(

value

)

Set the rect of page content item.

Parameters

[in]

value

The rect of page content item.

Returns

None.

SetText()

fsdk.TreeItemInfo.SetText

(

value

)

Set the text of item, shown in UI.

Parameters

[in]

value

The text of item, shown in UI.

Returns

None.