Package wx :: Package lib :: Module pydocview :: Class ChildDocTemplate
[frames | no frames]

Type ChildDocTemplate

object --+        
         |        
    Object --+    
             |    
   DocTemplate --+
                 |
                ChildDocTemplate


A ChildDocTemplate is a DocTemplate subclass that enables the creation of ChildDocuments 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 Summary
  __init__(self, manager, description, filter, dir, ext, docTypeName, viewTypeName, docType, viewType, flags, icon)
Initializes the ChildDocTemplate.
  CreateDocument(self, path, flags, data, parentDocument)
Called when a ChildDocument is to be created and does the minimum such that the ChildDocument looks like a real Document to the framework.
    Inherited from DocTemplate
  CreateView(self, doc, flags)
Creates a new instance of the associated document view.
  FileMatchesTemplate(self, path)
Returns True if the path's extension matches one of this template's file filter extensions.
  GetDefaultExtension(self)
Returns the default file extension for the document data, as passed to the document template constructor.
  GetDescription(self)
Returns the text description of this template, as passed to the document template constructor.
  GetDirectory(self)
Returns the default directory, as passed to the document template constructor.
  GetDocumentManager(self)
Returns the document manager instance for which this template was created.
  GetDocumentName(self)
Returns the document type name, as passed to the document template constructor.
  GetDocumentType(self)
Returns the Python document class, as passed to the document template constructor.
  GetFileFilter(self)
Returns the file filter, as passed to the document template constructor.
  GetFlags(self)
Returns the flags, as passed to the document template constructor.
  GetIcon(self)
Returns the icon, as passed to the document template constructor.
  GetViewName(self)
Returns the view type name, as passed to the document template constructor.
  GetViewType(self)
Returns the Python view class, as passed to the document template constructor.
  IsNewable(self)
Returns true if the document template can be shown in "New" dialogs, false otherwise.
  IsVisible(self)
Returns true if the document template can be shown in user dialogs, false otherwise.
  SetDefaultExtension(self, defaultExt)
Sets the default file extension.
  SetDescription(self, description)
Sets the template description.
  SetDirectory(self, dir)
Sets the default directory.
  SetDocumentManager(self, manager)
Sets the document manager instance for which this template was created.
  SetFileFilter(self, filter)
Sets the file filter.
  SetFlags(self, flags)
Sets the internal document template flags (see the constructor description for more details).
  SetIcon(self, flags)
Sets the icon.
    Inherited from Object
  __repr__(self)
  Destroy(self)
Deletes the C++ object this Python object is a proxy for.
String GetClassName(self)
Returns the class name of the C++ class using wxRTTI.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
Return hash(x)...
  __new__(T, S, ...)
Return a new object with type S, a subtype of T...
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
Return str(x)...

Method Details

__init__(self, manager, description, filter, dir, ext, docTypeName, viewTypeName, docType, viewType, flags=2, icon=None)
(Constructor)

Initializes the ChildDocTemplate.

Overrides:
wx.lib.docview.DocTemplate.__init__

CreateDocument(self, path, flags, data=None, parentDocument=None)

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

Overrides:
wx.lib.docview.DocTemplate.CreateDocument

Generated by Epydoc 2.1.20050511.rpd on Sat Jun 16 16:52:44 2007 http://epydoc.sf.net