File: wx.lib.docview.DocMDIParentFrame.txt

package info (click to toggle)
wxpython4.0 4.0.4%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 211,112 kB
  • sloc: cpp: 888,355; python: 223,130; makefile: 52,087; ansic: 45,780; sh: 3,012; xml: 1,534; perl: 264
file content (125 lines) | stat: -rw-r--r-- 5,586 bytes parent folder | download
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
.. wxPython Phoenix documentation

   This file was generated by Phoenix's sphinx generator and associated
   tools, do not edit by hand.

   Copyright: (c) 2011-2018 by Total Control Software
   License:   wxWindows License

.. include:: headings.inc

.. currentmodule:: wx.lib.docview

.. highlight:: python



.. _wx.lib.docview.DocMDIParentFrame:

==========================================================================================================================================
|phoenix_title|  **wx.lib.docview.DocMDIParentFrame**
==========================================================================================================================================

The :class:`DocMDIParentFrame` class provides a default top-level frame for
applications using the document/view framework. This class can only be
used for MDI parent frames.

It cooperates with the :class:`View`, :class:`Document`,
:class:`DocManager` and :class:`DocTemplate` classes.



|

|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>DocMDIParentFrame</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.docview.DocMDIParentFrame_inheritance.png" alt="Inheritance diagram of DocMDIParentFrame" usemap="#dummy" class="inheritance"/></center>
   </div>
   <script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="19,5,120,35"/> <area shape="rect" id="node2" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="71,83,181,112"/> <area shape="rect" id="node4" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="66,160,187,189"/> <area shape="rect" id="node3" href="wx.Object.html" title="wx.Object" alt="" coords="144,5,225,35"/> <area shape="rect" id="node5" href="wx.Window.html" title="wx.Window" alt="" coords="82,237,171,267"/> <area shape="rect" id="node9" href="wx.NonOwnedWindow.html" title="wx.NonOwnedWindow" alt="" coords="47,315,205,344"/> <area shape="rect" id="node6" href="wx.lib.docview.DocMDIParentFrame.html" title="wx.lib.docview.DocMDIParentFrame" alt="" coords="5,624,248,653"/> <area shape="rect" id="node7" href="wx.MDIParentFrame.html" title="wx.MDIParentFrame" alt="" coords="53,547,200,576"/> <area shape="rect" id="node8" href="wx.TopLevelWindow.html" title="wx.TopLevelWindow" alt="" coords="55,392,197,421"/> <area shape="rect" id="node10" href="wx.Frame.html" title="wx.Frame" alt="" coords="85,469,167,499"/> </map> 
   </p>

|


|super_classes| Known Superclasses
==================================

:class:`wx.MDIParentFrame`

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~wx.lib.docview.DocMDIParentFrame.__init__`                               Constructor.
:meth:`~wx.lib.docview.DocMDIParentFrame.OnCloseWindow`                          Deletes all views and documents. If no user input cancelled the
:meth:`~wx.lib.docview.DocMDIParentFrame.OnExit`                                 Called when File/Exit is chosen and closes the window.
:meth:`~wx.lib.docview.DocMDIParentFrame.OnMRUFile`                              Opens the appropriate file when it is selected from the file history
:meth:`~wx.lib.docview.DocMDIParentFrame.ProcessEvent`                           Processes an event, searching event tables and calling zero or more
:meth:`~wx.lib.docview.DocMDIParentFrame.ProcessUpdateUIEvent`                   Processes a UI event, searching event tables and calling zero or more
================================================================================ ================================================================================


|


|api| Class API
===============


.. class:: DocMDIParentFrame(wx.MDIParentFrame)

   The :class:`DocMDIParentFrame` class provides a default top-level frame for
   applications using the document/view framework. This class can only be
   used for MDI parent frames.
   
   It cooperates with the :class:`View`, :class:`Document`,
   :class:`DocManager` and :class:`DocTemplate` classes.

   .. method:: __init__(self, manager, frame, id, title, pos=wx.DefaultPosition, size=wx.DefaultSize, style=wx.DEFAULT_FRAME_STYLE, name="frame")

      Constructor.


   .. 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).