.. 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.docview
.. highlight:: python
.. _wx.lib.docview.DocChildFrame:
==========================================================================================================================================
|phoenix_title| **wx.lib.docview.DocChildFrame**
==========================================================================================================================================
The :class:`DocChildFrame` class provides a default frame for displaying
documents on separate windows. This class can only be used for SDI (not
MDI) child frames.
The class is part of the document/view framework and cooperates with
the :class:`View`, :class:`Document`, :class:`DocManager` and
:class:`DocTemplate` classes.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
DocChildFrame:
|
|super_classes| Known Superclasses
==================================
:class:`wx.Frame`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.docview.DocChildFrame.__init__` Constructor.
:meth:`~wx.lib.docview.DocChildFrame.GetDocument` Returns the document associated with this frame.
:meth:`~wx.lib.docview.DocChildFrame.GetView` Returns the view associated with this frame.
:meth:`~wx.lib.docview.DocChildFrame.OnActivate` Activates the current view.
:meth:`~wx.lib.docview.DocChildFrame.OnCloseWindow` Closes and deletes the current view and document.
:meth:`~wx.lib.docview.DocChildFrame.ProcessEvent` Processes an event, searching event tables and calling zero or more
:meth:`~wx.lib.docview.DocChildFrame.ProcessUpdateUIEvent` Processes a UI event, searching event tables and calling zero or more
:meth:`~wx.lib.docview.DocChildFrame.SetDocument` Sets the document for this frame.
:meth:`~wx.lib.docview.DocChildFrame.SetView` Sets the view for this frame.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: DocChildFrame(wx.Frame)
The :class:`DocChildFrame` class provides a default frame for displaying
documents on separate windows. This class can only be used for SDI (not
MDI) child frames.
The class is part of the document/view framework and cooperates with
the :class:`View`, :class:`Document`, :class:`DocManager` and
:class:`DocTemplate` classes.
.. method:: __init__(self, doc, view, frame, id, title, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.DEFAULT_FRAME_STYLE, name="frame")
Constructor.
.. method:: GetDocument(self)
Returns the document associated with this frame.
.. method:: GetView(self)
Returns the view associated with this frame.
.. method:: OnActivate(self, event)
Activates the current view.
.. method:: OnCloseWindow(self, event)
Closes and deletes the current view and document.
.. method:: ProcessEvent(self, event)
Processes an event, searching event tables and calling zero or more
suitable event handler function(s).
.. method:: ProcessUpdateUIEvent(self, event)
Processes a UI event, searching event tables and calling zero or more
suitable event handler function(s).
.. method:: SetDocument(self, document)
Sets the document for this frame.
.. method:: SetView(self, view)
Sets the view for this frame.