File: wx.lib.docview.DocChildFrame.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 (143 lines) | stat: -rw-r--r-- 5,882 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
.. 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.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

   <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>DocChildFrame</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.DocChildFrame_inheritance.png" alt="Inheritance diagram of DocChildFrame" 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.lib.docview.DocChildFrame.html" title="wx.lib.docview.DocChildFrame" alt="" coords="9,547,217,576"/> <area shape="rect" id="node2" href="wx.Frame.html" title="wx.Frame" alt="" coords="72,469,153,499"/> <area shape="rect" id="node3" href="wx.Trackable.html" title="wx.Trackable" alt="" coords="5,5,107,35"/> <area shape="rect" id="node4" href="wx.EvtHandler.html" title="wx.EvtHandler" alt="" coords="57,83,168,112"/> <area shape="rect" id="node6" href="wx.WindowBase.html" title="wx.WindowBase" alt="" coords="53,160,173,189"/> <area shape="rect" id="node5" href="wx.Object.html" title="wx.Object" alt="" coords="131,5,212,35"/> <area shape="rect" id="node7" href="wx.Window.html" title="wx.Window" alt="" coords="69,237,157,267"/> <area shape="rect" id="node9" href="wx.NonOwnedWindow.html" title="wx.NonOwnedWindow" alt="" coords="34,315,192,344"/> <area shape="rect" id="node8" href="wx.TopLevelWindow.html" title="wx.TopLevelWindow" alt="" coords="42,392,184,421"/> </map> 
   </p>

|


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