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 Widgets,
and cooperates with the Document, DocTemplate
and DocManager classes.
View overview, Document, DocTemplate, DocManager
Document*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.
Frame*m_viewFrame
Frame associated with the view, if any.
Stringm_viewTypeName
The view type name given to the DocTemplate constructor, copied to this
variable when the view is created. Not currently used by the framework.
Destructor. Removes itself from the document’s list of views.
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 DocChildFrame calls View::Activate from its OnActivate member
and from its OnMenuCommand member.
This function calls View::OnActivateView.
Closes the view by calling OnClose. If deleteWindow is true, this function should
delete the window associated with the view.
Gets a pointer to the document associated with the view.
Returns a pointer to the document manager instance associated with this view.
Gets the frame associated with the view (if any). Note that this ``frame’’ is
not a Frame at all in the generic MDI implementation which uses the notebook
pages instead of the frames and this is why this method returns a Window and
not a Frame.
Gets the name associated with the view (passed to the DocTemplate constructor).
Not currently used by the framework.
Called when a view is activated by means of View::Activate. The default implementation does
nothing.
Called when the filename has changed. The default implementation constructs a
suitable title and sets the title of the view frame (if any).
Implements closing behaviour. The default implementation calls Document::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 Document::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.
Override this to clean up the view when the document is being
closed.
DocManager or Document creates a View via a DocTemplate.
Just after the DocTemplate creates the View, it calls
View::OnCreate. In its OnCreate member function, the View can create a DocChildFrame
or a derived class. This DocChildFrame provides user interface
elements to view and/or edit the contents of the Document.
By default, simply returns true. If the function returns false, the
view will be deleted.
If the printing framework is enabled in the library, this function returns a
Printout 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 DocPrintout, which prints
and previews one page by calling View::OnDraw.
Override to return an instance of a class other than DocPrintout.
Override this function to render the view on the given device context.
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.
Associates the given document with the view. Normally called by the
framework.
Sets the frame associated with this view. The application should call this
if possible, to tell the view about the frame.
See get_frame for the explanation about the mismatch
between the ``Frame’’ in the method name and the type of its parameter.
Sets the view type name. Should only be called by the framework.
[This page automatically generated from the Textile source at 2023-06-13 21:31:33 +0000]