GXPS.DocumentStructure¶

Methods¶

class	`outline_iter_init` (iter, structure)
	`has_outline` ()

Name	Type	Flags	Short Description
`source`	`str`	w/co	The DocStructure Source File

Name	Type	Access	Description
parent	`GObject.Object`	r

class GXPS.DocumentStructure(**kwargs)¶

The GXPS.DocumentStructure struct contains only private fields and should not be directly accessed.

classmethod outline_iter_init(iter, structure)¶

Parameters:

Returns:

True if iter was successfully initialized to the root item, False if it failed or structure does not have an outline.

Return type:

bool

Initializes iter to the root item of the outline contained by structure and a associates it with structure.

Here is a simple example of some code that walks the full outline:

<informalexample><programlisting> static void walk_outline (GXPS.OutlineIter *iter) { do { GXPS.OutlineIter child_iter; const str *description = GXPS.OutlineIter.get_description (iter); GXPS.LinkTarget *target = GXPS.OutlineIter.get_target (iter);

/<!– –>* Do something with description and taregt *<!– –>/ if (GXPS.OutlineIter.children (&child_iter, iter)) walk_outline (&child_iter); } while (GXPS.OutlineIter.next (iter)); } … { GXPS.OutlineIter iter; if (GXPS.DocumentStructure.outline_iter_init (&iter, structure)) walk_outline (&iter); } </programlisting></informalexample>

has_outline()¶

Whether self has an outline or not.

GXPS.DocumentStructure.props.source¶

The DocStructure Source File