.. 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.pydocview
.. highlight:: python
.. _wx.lib.pydocview.DocTabbedChildFrame:
==========================================================================================================================================
|phoenix_title| **wx.lib.pydocview.DocTabbedChildFrame**
==========================================================================================================================================
The wxDocMDIChildFrame 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 supported by wxWindows,
and cooperates with the wxView, wxDocument, wxDocManager and wxDocTemplate
classes.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html

Inheritance diagram for class
DocTabbedChildFrame:
|
|super_classes| Known Superclasses
==================================
:class:`wx.Panel`
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.lib.pydocview.DocTabbedChildFrame.__init__` Constructor. Note that the event table must be rebuilt for the
:meth:`~wx.lib.pydocview.DocTabbedChildFrame.Activate` Activates the current view.
:meth:`~wx.lib.pydocview.DocTabbedChildFrame.Destroy` Removes the current notebook page.
:meth:`~wx.lib.pydocview.DocTabbedChildFrame.GetDocument` Returns the document associated with this frame.
:meth:`~wx.lib.pydocview.DocTabbedChildFrame.GetIcon` Dummy method since the icon of tabbed frames are managed by the notebook.
:meth:`~wx.lib.pydocview.DocTabbedChildFrame.GetTitle` Returns the frame's title.
:meth:`~wx.lib.pydocview.DocTabbedChildFrame.GetView` Returns the view associated with this frame.
:meth:`~wx.lib.pydocview.DocTabbedChildFrame.OnTitleIsModified` Add/remove to the frame's title an indication that the document is dirty.
:meth:`~wx.lib.pydocview.DocTabbedChildFrame.ProcessEvent` Processes an event, searching event tables and calling zero or more
:meth:`~wx.lib.pydocview.DocTabbedChildFrame.SetDocument` Sets the document for this frame.
:meth:`~wx.lib.pydocview.DocTabbedChildFrame.SetFocus` Activates the current notebook page.
:meth:`~wx.lib.pydocview.DocTabbedChildFrame.SetIcon` Dummy method since the icon of tabbed frames are managed by the notebook.
:meth:`~wx.lib.pydocview.DocTabbedChildFrame.SetTitle` Sets the frame's title.
:meth:`~wx.lib.pydocview.DocTabbedChildFrame.SetView` Sets the view for this frame.
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: DocTabbedChildFrame(wx.Panel)
The wxDocMDIChildFrame 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 supported by wxWindows,
and cooperates with the wxView, wxDocument, wxDocManager and wxDocTemplate
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:: Destroy(self)
Removes the current notebook page.
.. method:: GetDocument(self)
Returns the document associated with this frame.
.. method:: GetIcon(self)
Dummy method since the icon of tabbed frames are managed by the notebook.
.. method:: GetTitle(self)
Returns the frame's title.
.. method:: GetView(self)
Returns the view associated with this frame.
.. 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). Note that the ProcessEvent
method is called from the wxPython docview framework directly since
wxPython does not have a virtual ProcessEvent function.
.. method:: SetDocument(self, document)
Sets the document for this frame.
.. method:: SetFocus(self)
Activates the current notebook page.
.. method:: SetIcon(self, icon)
Dummy method since the icon of tabbed frames are managed by the notebook.
.. method:: SetTitle(self, title)
Sets the frame's title.
.. method:: SetView(self, view)
Sets the view for this frame.