Table Of Contents

Previous topic

ChildDocTemplate

Next topic

DocApp

This Page

phoenix_title 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 Inheritance Diagram

Inheritance diagram for class ChildDocument

Inheritance diagram of ChildDocument


super_classes Known Superclasses

lib.docview.Document


method_summary Methods Summary

GetData Returns the data that the ChildDocument contains.
GetParentDocument Returns the parent Document of the ChildDocument.
OnOpenDocument Called when the ChildDocument is opened and does the minimum such that the
OnSaveDocument Called when the ChildDocument is saved and does the minimum such that the
Save Called when the ChildDocument is saved and does the minimum such that the
SaveAs Called when the ChildDocument is saved and does the minimum such that the
SetData Sets the data that the ChildDocument contains.
SetParentDocument Sets the parent Document of the ChildDocument.

api Class API



class ChildDocument(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.


Methods



GetData(self)

Returns the data that the ChildDocument contains.



GetParentDocument(self)

Returns the parent Document of the ChildDocument.



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.



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.



Save(self)

Called when the ChildDocument is saved and does the minimum such that the ChildDocument looks like a real Document to the framework.



SaveAs(self)

Called when the ChildDocument is saved and does the minimum such that the ChildDocument looks like a real Document to the framework.



SetData(self, data)

Sets the data that the ChildDocument contains.



SetParentDocument(self, parentDocument)

Sets the parent Document of the ChildDocument.