.. 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.DocParentFrame:
==========================================================================================================================================
|phoenix_title| **wx.lib.docview.DocParentFrame**
==========================================================================================================================================
The :class:`DocParentFrame` class provides a default top-level frame for
applications using the document/view framework. This class can only be
used for SDI (not MDI) parent frames.
It cooperates with the :class:`View`, :class:`Document`, :class:`DocManager`
and :class:`DocTemplates` classes.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
DocParentFrame:
|
|super_classes| Known Superclasses
==================================
:class:`wx.Frame`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.docview.DocParentFrame.__init__` Constructor. Note that the event table must be rebuilt for the
:meth:`~wx.lib.docview.DocParentFrame.OnCloseWindow` Deletes all views and documents. If no user input cancelled the
:meth:`~wx.lib.docview.DocParentFrame.OnExit` Called when File/Exit is chosen and closes the window.
:meth:`~wx.lib.docview.DocParentFrame.OnMRUFile` Opens the appropriate file when it is selected from the file history
:meth:`~wx.lib.docview.DocParentFrame.ProcessEvent` Processes an event, searching event tables and calling zero or more
:meth:`~wx.lib.docview.DocParentFrame.ProcessUpdateUIEvent` Processes a UI event, searching event tables and calling zero or more
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: DocParentFrame(wx.Frame)
The :class:`DocParentFrame` class provides a default top-level frame for
applications using the document/view framework. This class can only be
used for SDI (not MDI) parent frames.
It cooperates with the :class:`View`, :class:`Document`, :class:`DocManager`
and :class:`DocTemplates` classes.
.. method:: __init__(self, manager, frame, id, title, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.DEFAULT_FRAME_STYLE, name="frame")
Constructor. Note that the event table must be rebuilt for the
frame since the EvtHandler is not virtual.
.. method:: OnCloseWindow(self, event)
Deletes all views and documents. If no user input cancelled the
operation, the frame will be destroyed and the application will exit.
.. method:: OnExit(self, event)
Called when File/Exit is chosen and closes the window.
.. method:: OnMRUFile(self, event)
Opens the appropriate file when it is selected from the file history
menu.
.. 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).