GXPS.DocumentStructure¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
class |
|
|
Virtual Methods¶
- Inherited:
Properties¶
Name |
Type |
Flags |
Short Description |
---|---|---|---|
w/co |
The DocStructure Source File |
Signals¶
- Inherited:
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
---|---|---|---|
parent |
r |
Class Details¶
- class GXPS.DocumentStructure(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
The
GXPS.DocumentStructure
struct contains only private fields and should not be directly accessed.- classmethod outline_iter_init(iter, structure)¶
- Parameters:
iter (
GXPS.OutlineIter
) – an uninitializedGXPS.OutlineIter
structure (
GXPS.DocumentStructure
) – aGXPS.DocumentStructure
- Returns:
True
if iter was successfully initialized to the root item,False
if it failed or structure does not have an outline.- Return type:
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; conststr
*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>
Property Details¶
- GXPS.DocumentStructure.props.source¶
- Name:
source
- Type:
- Default Value:
- Flags:
The DocStructure Source File