## wxView

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 wxWidgets, and cooperates with the wxDocument, wxDocTemplate and wxDocManager classes.

Derived from

wxEvtHandler
wxObject

Include files

<wx/docview.h>

See also

wxView overview, wxDocument, wxDocTemplate, wxDocManager

Members

wxView::m_viewDocument
wxView::m_viewFrame
wxView::m_viewTypeName
wxView::wxView
wxView::~wxView
wxView::Activate
wxView::Close
wxView::GetDocument
wxView::GetDocumentManager
wxView::GetFrame
wxView::GetViewName
wxView::OnActivateView
wxView::OnChangeFilename
wxView::OnClose
wxView::OnClosingDocument
wxView::OnCreate
wxView::OnCreatePrintout
wxView::OnDraw
wxView::OnUpdate
wxView::SetDocument
wxView::SetFrame
wxView::SetViewName

### wxView::m_viewDocument

wxDocument* m_viewDocument

The document associated with this view. There may be more than one view per document, but there can never be more than one document for one view.

### wxView::m_viewFrame

wxFrame* m_viewFrame

Frame associated with the view, if any.

### wxView::m_viewTypeName

wxString m_viewTypeName

The view type name given to the wxDocTemplate constructor, copied to this variable when the view is created. Not currently used by the framework.

### wxView::wxView

wxView()

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

### wxView::~wxView

~wxView()

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

### wxView::Activate

virtual void Activate(bool activate)

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.

This function calls wxView::OnActivateView.

### wxView::Close

virtual bool Close(bool deleteWindow = true)

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

### wxView::GetDocument

wxDocument* GetDocument() const

Gets a pointer to the document associated with the view.

### wxView::GetDocumentManager

wxDocManager* GetDocumentManager() const

Returns a pointer to the document manager instance associated with this view.

### wxView::GetFrame

wxWindow * GetFrame()

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.

### wxView::GetViewName

wxString GetViewName() const

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

### wxView::OnActivateView

virtual void OnActivateView(bool activate, wxView *activeView, wxView *deactiveView)

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

### wxView::OnChangeFilename

virtual void OnChangeFilename()

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

### wxView::OnClose

virtual bool OnClose(bool deleteWindow)

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

### wxView::OnClosingDocument

virtual void OnClosingDoocument()

Override this to clean up the view when the document is being closed.

### wxView::OnCreate

virtual bool OnCreate(wxDocument* doc, long 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.

### wxView::OnCreatePrintout

virtual wxPrintout* OnCreatePrintout()

If the printing framework is enabled in the library, this function 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.

### wxView::OnDraw

virtual void OnDraw(wxDC& dc)

Override this function to render the view on the given device context.

### wxView::OnUpdate

virtual void OnUpdate(wxView* sender, wxObject* 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.

### wxView::SetDocument

void SetDocument(wxDocument* doc)

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

### wxView::SetFrame

void SetFrame(wxWindow* 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.

### wxView::SetViewName

void SetViewName(const wxString& name)

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