wx.lib.pydocview.DocMDIParentFrame

Package wx :: Package lib :: Module pydocview :: Class DocMDIParentFrame

Type DocMDIParentFrame

object --+                            
         |                            
    Object --+                        
             |                        
    EvtHandler --+                    
                 |                    
            Window --+                
                     |                
        TopLevelWindow --+            
                         |            
                     Frame --+        
                             |        
                MDIParentFrame --+    
                                 |    
                 DocMDIParentFrame --+
                                     |
                                    DocMDIParentFrame

The DocMDIParentFrame is the primary frame which the DocApp uses to host MDI child windows. It offers features such as a default menubar, toolbar, and status bar, and a mechanism to manage embedded windows on the edges of the DocMDIParentFrame.

Method Summary
	`__init__(self, docManager, parent, id, title, pos, size, style, name, embeddedWindows)` Initializes the DocMDIParentFrame with the default menubar, toolbar, and status bar.
	`CreateDefaultMenuBar(self)` Creates the default MenuBar.
	`CreateDefaultStatusBar(self)` Creates the default StatusBar.
	`CreateDefaultToolBar(self)` Creates the default ToolBar.
	`CreateEmbeddedWindows(self, windows)` Create the specified embedded windows around the edges of the DocMDIParentFrame.
	`GetDocumentManager(self)` Returns the document manager associated with the DocMDIParentFrame.
	`GetEmbeddedWindow(self, loc)` Returns the instance of the embedded window specified by the embedded window location constant.
	`HideEmbeddedWindow(self)` Hides the embedded window specified by the embedded window location constant.
	`InitializePrintData(self)` Initializes the PrintData that is used when printing.
	`OnAbout(self, event)` Invokes the about dialog.
	`OnCloseWindow(self, event)` Called when the DocMDIParentFrame is closed.
	`OnFileSaveAll(self, event)` Saves all of the currently open documents.
	`OnSize(self, event)` Called when the DocMDIParentFrame is resized and lays out the MDI client window.
	`OnUpdateViewStatusBar(self, event)` Updates the View StatusBar menu item.
	`OnUpdateViewToolBar(self, event)` Updates the View ToolBar menu item.
	`OnViewStatusBar(self, event)` Toggles whether the StatusBar is visible.
	`OnViewToolBar(self, event)` Toggles whether the ToolBar is visible.
	`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).
	`SaveEmbeddedWindowSizes(self)` Saves the sizes of the embedded windows.
	`ShowEmbeddedWindow(self, window, show)` Shows or hides the embedded window specified by the embedded window location constant.
	`UpdateStatus(self, message)` Updates the StatusBar.
	`UpdateWindowMenu(self)` Updates the WindowMenu on Windows platforms.

Instance Method Details

init(self, docManager, parent, id, title, pos=wx.Point(-1, -1), size=wx.Size(-1, -1), style=541072960, name='DocMDIFrame', embeddedWindows=0)
(Constructor)

Initializes the DocMDIParentFrame with the default menubar, toolbar, and status bar. Use the optional embeddedWindows parameter with the embedded window constants to create embedded windows around the edges of the DocMDIParentFrame.

Overrides:: wx.lib.docview.DocMDIParentFrame.__init__

CreateDefaultMenuBar(self)

Creates the default MenuBar. Contains File, Edit, View, Tools, and Help menus.

CreateDefaultStatusBar(self)

Creates the default StatusBar.

CreateDefaultToolBar(self)

Creates the default ToolBar.

CreateEmbeddedWindows(self, windows=0)

Create the specified embedded windows around the edges of the DocMDIParentFrame.

GetDocumentManager(self)

Returns the document manager associated with the DocMDIParentFrame.

GetEmbeddedWindow(self, loc)

Returns the instance of the embedded window specified by the embedded window location constant.

HideEmbeddedWindow(self)

Hides the embedded window specified by the embedded window location constant.

InitializePrintData(self)

Initializes the PrintData that is used when printing.

OnAbout(self, event)

Invokes the about dialog.

OnCloseWindow(self, event)

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

Overrides:: wx.lib.docview.DocMDIParentFrame.OnCloseWindow

OnFileSaveAll(self, event)

Saves all of the currently open documents.

OnSize(self, event)

Called when the DocMDIParentFrame is resized and lays out the MDI client window.

OnUpdateViewStatusBar(self, event)

Updates the View StatusBar menu item.

OnUpdateViewToolBar(self, event)

Updates the View ToolBar menu item.

OnViewStatusBar(self, event)

Toggles whether the StatusBar is visible.

OnViewToolBar(self, event)

Toggles whether the ToolBar is visible.

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.lib.docview.DocMDIParentFrame.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.docview.DocMDIParentFrame.ProcessUpdateUIEvent

SaveEmbeddedWindowSizes(self)

Saves the sizes of the embedded windows.

ShowEmbeddedWindow(self, window, show=True)

Shows or hides the embedded window specified by the embedded window location constant.

UpdateStatus(self, message=u'Ready')

Updates the StatusBar.

UpdateWindowMenu(self)

Updates the WindowMenu on Windows platforms.

Generated by Epydoc 2.1.20040428.rpd on Tue Mar 15 17:15:27 2005

http://epydoc.sf.net