GXPS.OutlineIter

Fields

Name	Type	Access	Description
dummy1	object	r
dummy2	object	r

Methods

	children (parent)
	get_description ()
	get_target ()
	next ()

Details

class GXPS.OutlineIter

GXPS.OutlineIter represents an iterator that can be used to iterate over the items of an outline contained in a GXPS.DocumentStructure

children(parent)

Parameters:

parent (GXPS.OutlineIter) – an initialized GXPS.OutlineIter

Returns:

True if self was set to the first child of parent, False if parent does not have children.

Return type:

bool

Initializes self to the first child item of parent. See GXPS.DocumentStructure.outline_iter_init() for more details.

get_description()

Returns:

the description of the outline item

Return type:

str

Gets the description of the outline item associated with self. See GXPS.DocumentStructure.outline_iter_init() for more details.

get_target()

Returns:

a new allocated GXPS.LinkTarget. Free the returned object with GXPS.LinkTarget.free().

Return type:

GXPS.LinkTarget

Gets the GXPS.LinkTarget of the outline item associated with self. See GXPS.DocumentStructure.outline_iter_init() for more details.

next()

Returns:

True if self was set to the next item, False if the end of the current level has been reached

Return type:

bool

Advances self to the next item at the current level. See GXPS.DocumentStructure.outline_iter_init() for more details.