File: wx.lib.docview.DocMDIChildFrame.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 (152 lines) | stat: -rw-r--r-- 6,561 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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
.. 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.DocMDIChildFrame:

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

The :class:`DocMDIChildFrame` class provides a default frame for displaying
documents on separate windows. This class can only be used for 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

   <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>DocMDIChildFrame</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.DocMDIChildFrame_inheritance.png" alt="Inheritance diagram of DocMDIChildFrame" 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.MDIChildFrame.html" title="wx.MDIChildFrame" alt="" coords="53,547,189,576"/> <area shape="rect" id="node3" href="wx.lib.docview.DocMDIChildFrame.html" title="wx.lib.docview.DocMDIChildFrame" alt="" coords="5,624,237,653"/> <area shape="rect" id="node2" href="wx.Frame.html" title="wx.Frame" alt="" coords="80,469,161,499"/> <area shape="rect" id="node4" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="13,5,115,35"/> <area shape="rect" id="node5" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="65,83,176,112"/> <area shape="rect" id="node7" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="61,160,181,189"/> <area shape="rect" id="node6" href="wx.Object.html" title="wx.Object" alt="" coords="139,5,220,35"/> <area shape="rect" id="node8" href="wx.Window.html" title="wx.Window" alt="" coords="77,237,165,267"/> <area shape="rect" id="node10" href="wx.NonOwnedWindow.html" title="wx.NonOwnedWindow" alt="" coords="42,315,200,344"/> <area shape="rect" id="node9" href="wx.TopLevelWindow.html" title="wx.TopLevelWindow" alt="" coords="50,392,192,421"/> </map> 
   </p>

|


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

:class:`wx.MDIChildFrame`

|


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

================================================================================ ================================================================================
:meth:`~wx.lib.docview.DocMDIChildFrame.__init__`                                Constructor.  Note that the event table must be rebuilt for the
:meth:`~wx.lib.docview.DocMDIChildFrame.Activate`                                Activates the current view.
:meth:`~wx.lib.docview.DocMDIChildFrame.GetDocument`                             Returns the document associated with this frame.
:meth:`~wx.lib.docview.DocMDIChildFrame.GetView`                                 Returns the view associated with this frame.
:meth:`~wx.lib.docview.DocMDIChildFrame.OnActivate`                              Sets the currently active view to be the frame's view. You may need to
:meth:`~wx.lib.docview.DocMDIChildFrame.OnCloseWindow`                           Closes and deletes the current view and document.
:meth:`~wx.lib.docview.DocMDIChildFrame.OnTitleIsModified`                       Add/remove to the frame's title an indication that the document is dirty.
:meth:`~wx.lib.docview.DocMDIChildFrame.ProcessEvent`                            Processes an event, searching event tables and calling zero or more
:meth:`~wx.lib.docview.DocMDIChildFrame.SetDocument`                             Sets the document for this frame.
:meth:`~wx.lib.docview.DocMDIChildFrame.SetView`                                 Sets the view for this frame.
================================================================================ ================================================================================


|


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


.. class:: DocMDIChildFrame(wx.MDIChildFrame)

   The :class:`DocMDIChildFrame` class provides a default frame for displaying
   documents on separate windows. This class can only be used for 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.  Note that the event table must be rebuilt for the
      frame since the EvtHandler is not virtual.


   .. method:: Activate(self)

      Activates the current view.


   .. method:: GetDocument(self)

      Returns the document associated with this frame.


   .. method:: GetView(self)

      Returns the view associated with this frame.


   .. method:: OnActivate(self, event)

      Sets the currently active view to be the frame's view. You may need to
      override (but still call) this function in order to set the keyboard
      focus for your subwindow.


   .. method:: OnCloseWindow(self, event)

      Closes and deletes the current view and document.


   .. method:: OnTitleIsModified(self)

      Add/remove to the frame's title an indication that the document is dirty.
      If the document is dirty, an '*' is appended to the title


   .. method:: ProcessEvent(event)

      Processes an 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.