Package wx :: Package lib :: Module docview :: Class View

[frames | no frames]

## Type View

    object --+
             |
        Object --+
                 |
        EvtHandler --+
                     |
                    View

The view class can be used to model the viewing and editing component of an application's file-based data. It is part of the document/view framework supported by wxWindows, and cooperates with the wxDocument, wxDocTemplate and wxDocManager classes.

Method Summary
| ``__init__`(self)` Constructor.
| ``Activate`(self, activate)` Call this from your view frame's OnActivate member to tell the framework which view is currently active.
| ``Close`(self, deleteWindow)` Closes the view by calling OnClose.
| ``Destroy`(self)` Destructor.
| ``GetDocument`(self)` Returns the document associated with the view.
| ``GetDocumentManager`(self)` Returns the document manager instance associated with this view.
| ``GetFrame`(self)` Gets the frame associated with the view (if any).
| ``GetViewName`(self)` Gets the name associated with the view (passed to the wxDocTemplate constructor).
| ``OnActivateView`(self, activate, activeView, deactiveView)` Called when a view is activated by means of wxView::Activate.
| ``OnChangeFilename`(self)` Called when the filename has changed.
| ``OnClose`(self, deleteWindow)` Implements closing behaviour.
| ``OnClosingDocument`(self)` Override this to clean up the view when the document is being closed.
| ``OnCreate`(self, doc, flags)` wxDocManager or wxDocument creates a wxView via a wxDocTemplate.
| ``OnCreatePrintout`(self)` Returns a wxPrintout object for the purposes of printing.
| ``OnDraw`(self, dc)` Override this to draw the view for the printing framework.
| ``OnPrint`(self, dc, info)` Override this to print the view for the printing framework.
| ``OnUpdate`(self, sender, hint)` Called when the view should be updated.
| ``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).
| ``SetDocument`(self, doc)` Associates the given document with the view.
| ``SetFrame`(self, frame)` Sets the frame associated with this view.
| ``SetViewName`(self, name)` Sets the view type name.

Property Summary

Method Details

### __init__(self)
(Constructor)

Constructor. Define your own default constructor to initialize application-specific data.

  Overrides:
    `wx.EvtHandler.__init__`

### Activate(self, activate=True)

Call this from your view frame's OnActivate member to tell the framework which view is currently active. If your windowing system doesn't call OnActivate, you may need to call this function from OnMenuCommand or any place where you know the view must be active, and the framework will need to get the current view.

The prepackaged view frame wxDocChildFrame calls wxView.Activate from its OnActivate member and from its OnMenuCommand member.

### Close(self, deleteWindow=True)

Closes the view by calling OnClose. If deleteWindow is true, this function should delete the window associated with the view.

### Destroy(self)

Destructor. Removes itself from the document's list of views.

  Overrides:
    `wx.Object.Destroy`

### GetDocument(self)

Returns the document associated with the view.

### GetDocumentManager(self)

Returns the document manager instance associated with this view.

### GetFrame(self)

Gets the frame associated with the view (if any). Note that this "frame" is not a wxFrame at all in the generic MDI implementation which uses the notebook pages instead of the frames and this is why this method returns a wxWindow and not a wxFrame.

### GetViewName(self)

Gets the name associated with the view (passed to the wxDocTemplate constructor). Not currently used by the framework.

### OnActivateView(self, activate, activeView, deactiveView)

Called when a view is activated by means of wxView::Activate. The default implementation does nothing.

### OnChangeFilename(self)

Called when the filename has changed. The default implementation constructs a suitable title and sets the title of the view frame (if any).

### OnClose(self, deleteWindow=True)

Implements closing behaviour. The default implementation calls wxDocument.Close to close the associated document. Does not delete the view. The application may wish to do some cleaning up operations in this function, if a call to wxDocument::Close succeeded. For example, if your application's all share the same window, you need to disassociate the window from the view and perhaps clear the window. If deleteWindow is true, delete the frame associated with the view.

### OnClosingDocument(self)

Override this to clean up the view when the document is being closed. The default implementation does nothing.

### OnCreate(self, doc, flags)

wxDocManager or wxDocument creates a wxView via a wxDocTemplate. Just after the wxDocTemplate creates the wxView, it calls wxView::OnCreate. In its OnCreate member function, the wxView can create a wxDocChildFrame or a derived class. This wxDocChildFrame provides user interface elements to view and/or edit the contents of the wxDocument.

By default, simply returns true. If the function returns false, the view will be deleted.

### OnCreatePrintout(self)

Returns a wxPrintout object for the purposes of printing. It should create a new object every time it is called; the framework will delete objects it creates.

By default, this function returns an instance of wxDocPrintout, which prints and previews one page by calling wxView.OnDraw.

Override to return an instance of a class other than wxDocPrintout.

### OnDraw(self, dc)

Override this to draw the view for the printing framework. The default implementation does nothing.

### OnPrint(self, dc, info)

Override this to print the view for the printing framework. The default implementation calls View.OnDraw.

### OnUpdate(self, sender, hint)

Called when the view should be updated. sender is a pointer to the view that sent the update request, or NULL if no single view requested the update (for instance, when the document is opened). hint is as yet unused but may in future contain application-specific information for making updating more efficient.

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

### SetDocument(self, doc)

Associates the given document with the view. Normally called by the framework.

### SetFrame(self, frame)

Sets the frame associated with this view. The application should call this if possible, to tell the view about the frame. See GetFrame for the explanation about the mismatch between the "Frame" in the method name and the type of its parameter.

### SetViewName(self, name)

Sets the view type name. Should only be called by the framework.

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