1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2020 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. currentmodule:: wx.lib.pydocview
.. highlight:: python
.. _wx.lib.pydocview.ChildDocument:
==========================================================================================================================================
|phoenix_title| **wx.lib.pydocview.ChildDocument**
==========================================================================================================================================
A ChildDocument is a document that represents a portion of a Document. The child
document is managed by the parent document, so it will be prompted to close if its
parent is closed, etc. Child Documents are useful when there are complicated
Views of a Document and users will need to tunnel into the View.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>ChildDocument</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.lib.pydocview.ChildDocument_inheritance.png" alt="Inheritance diagram of ChildDocument" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.lib.pydocview.ChildDocument.html" title="wx.lib.pydocview.ChildDocument" alt="" coords="5,237,244,267"/> <area shape="rect" id="node2" href="wx.lib.docview.Document.html" title="wx.lib.docview.Document" alt="" coords="30,160,219,189"/> <area shape="rect" id="node3" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="66,83,183,112"/> <area shape="rect" id="node4" href="wx.Object.html" title="wx.Object" alt="" coords="21,5,108,35"/> <area shape="rect" id="node5" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="133,5,239,35"/> </map>
</p>
</div>
|
|super_classes| Known Superclasses
==================================
:class:`wx.lib.docview.Document`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.pydocview.ChildDocument.GetData` Returns the data that the ChildDocument contains.
:meth:`~wx.lib.pydocview.ChildDocument.GetParentDocument` Returns the parent Document of the ChildDocument.
:meth:`~wx.lib.pydocview.ChildDocument.OnOpenDocument` Called when the ChildDocument is opened and does the minimum such that the
:meth:`~wx.lib.pydocview.ChildDocument.OnSaveDocument` Called when the ChildDocument is saved and does the minimum such that the
:meth:`~wx.lib.pydocview.ChildDocument.Save` Called when the ChildDocument is saved and does the minimum such that the
:meth:`~wx.lib.pydocview.ChildDocument.SaveAs` Called when the ChildDocument is saved and does the minimum such that the
:meth:`~wx.lib.pydocview.ChildDocument.SetData` Sets the data that the ChildDocument contains.
:meth:`~wx.lib.pydocview.ChildDocument.SetParentDocument` Sets the parent Document of the ChildDocument.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: ChildDocument(wx.lib.docview.Document)
A ChildDocument is a document that represents a portion of a Document. The child
document is managed by the parent document, so it will be prompted to close if its
parent is closed, etc. Child Documents are useful when there are complicated
Views of a Document and users will need to tunnel into the View.
.. method:: GetData(self)
Returns the data that the ChildDocument contains.
.. method:: GetParentDocument(self)
Returns the parent Document of the ChildDocument.
.. method:: OnOpenDocument(self, filename)
Called when the ChildDocument is opened and does the minimum such that the
ChildDocument looks like a real Document to the framework.
.. method:: OnSaveDocument(self, filename)
Called when the ChildDocument is saved and does the minimum such that the
ChildDocument looks like a real Document to the framework.
.. method:: Save(self)
Called when the ChildDocument is saved and does the minimum such that the
ChildDocument looks like a real Document to the framework.
.. method:: SaveAs(self)
Called when the ChildDocument is saved and does the minimum such that the
ChildDocument looks like a real Document to the framework.
.. method:: SetData(self, data)
Sets the data that the ChildDocument contains.
.. method:: SetParentDocument(self, parentDocument)
Sets the parent Document of the ChildDocument.
|
