Package wx :: Package lib :: Module pydocview :: Class DocTabbedParentFrame

[frames | no frames]

## Type DocTabbedParentFrame

                 DocFrameMixIn --+
                                 |
        DocMDIParentFrameMixIn --+
                                 |
    object --+                   |
             |                   |
        Object --+               |
                 |               |
        EvtHandler --+           |
                     |           |
                Window --+       |
                         |       |
            TopLevelWindow --+   |
                             |   |
                         Frame --+
                                 |
                                DocTabbedParentFrame

The DocTabbedParentFrame class provides a default top-level frame for applications using the document/view framework. This class can only be used for MDI parent frames that use a tabbed interface.

It cooperates with the wxView, wxDocument, wxDocManager and wxDocTemplate classes.

Method Summary
| ``__init__`(self, docManager, frame, id, title, pos, size, style, name, embeddedWindows, minSize)` Constructor.
| ``ActivateNotebookPage`(self, panel)` Sets the notebook to the specified panel.
| ``AddNotebookPage`(self, panel, title)` Adds a document page to the notebook.
| ``CreateNotebook`(self)` Creates the notebook to use for the tabbed document interface.
| ``GetActiveChild`(self)` Returns the active notebook page, which to the framework is treated as a document frame.
| ``GetNotebook`(self)` Returns the notebook used by the tabbed document interface.
| ``GetNotebookPageIndex`(self, panel)` Returns the index of particular notebook panel.
| `GetNotebookPageTitle(self, panel)`
| ``OnCloseWindow`(self, event)` Called when the frame is closed.
| ``OnExit`(self, event)` Called when File/Exit is chosen and closes the window.
| ``OnMRUFile`(self, event)` Opens the appropriate file when it is selected from the file history menu.
| ``OnNotebookMiddleClick`(self, event)` Handles middle clicks for the notebook, closing the document whose tab was clicked on.
| `OnNotebookMouseOver(self, event)`
| ``OnNotebookPageChanged`(self, event)` Activates a notebook page's view when it is selected.
| ``OnNotebookRightClick`(self, event)` Handles right clicks for the notebook, enabling users to either close a tab or select from the available documents if the user clicks on the notebook's white space.
| ``OnSize`(self, event)` Called when the frame is resized and lays out the client window.
| ``ProcessEvent`(self, event)` Processes an event, searching event tables and calling zero or more suitable event handler function(s).
| ``ProcessUpdateUIEvent`(self, event)` Processes a UI event, searching event tables and calling zero or more suitable event handler function(s).
| ``RemoveNotebookPage`(self, panel)` Removes a document page from the notebook.
| `SetNotebookPageTitle(self, panel, title)`

Property Summary

Instance Method Details

### __init__(self, docManager, frame, id, title, pos=wx.Point(-1, -1), size=wx.Size(-1, -1), style=541072960, name='DocTabbedParentFrame', embeddedWindows=0, minSize=20)
(Constructor)

Constructor. Note that the event table must be rebuilt for the frame since the EvtHandler is not virtual.

  Overrides:
    `wx.Frame.__init__`

### ActivateNotebookPage(self, panel)

Sets the notebook to the specified panel.

### AddNotebookPage(self, panel, title)

Adds a document page to the notebook.

### CreateNotebook(self)

Creates the notebook to use for the tabbed document interface.

### GetActiveChild(self)

Returns the active notebook page, which to the framework is treated as a document frame.

### GetNotebook(self)

Returns the notebook used by the tabbed document interface.

### GetNotebookPageIndex(self, panel)

Returns the index of particular notebook panel.

### OnCloseWindow(self, event)

Called when the frame is closed. Remembers the frame size.

### OnExit(self, event)

Called when File/Exit is chosen and closes the window.

### OnMRUFile(self, event)

Opens the appropriate file when it is selected from the file history menu.

### OnNotebookMiddleClick(self, event)

Handles middle clicks for the notebook, closing the document whose tab was clicked on.

### OnNotebookPageChanged(self, event)

Activates a notebook page's view when it is selected.

### OnNotebookRightClick(self, event)

Handles right clicks for the notebook, enabling users to either close a tab or select from the available documents if the user clicks on the notebook's white space.

### OnSize(self, event)

Called when the frame is resized and lays out the client window.

### ProcessEvent(self, 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.

  Overrides:
    `wx.EvtHandler.ProcessEvent`

### ProcessUpdateUIEvent(self, event)

Processes a UI 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.

  Overrides:
    `wx.lib.pydocview.DocMDIParentFrameMixIn.ProcessUpdateUIEvent`

### RemoveNotebookPage(self, panel)

Removes a document page from the notebook.

Generated by Epydoc 2.1.20050511.rpd on Thu Mar 22 12:08:31 2007 | http://epydoc.sf.net