mention Watcom makefile for wxBase

[wxWidgets.git] / docs / latex / wx / view.tex

diff --git a/docs/latex/wx/view.tex b/docs/latex/wx/view.tex
index a38bbbb813ad677f889c60890acbd9753f0947b5..b7810be68fb30d0ea56dd277057efdf0ab66e84b 100644 (file)
--- a/docs/latex/wx/view.tex
+++ b/docs/latex/wx/view.tex
@@ -2,7 +2,7 @@
 
 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,
 
 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 \helpref{wxDocument}{wxdocument}, \helpref{wxDocTemplate}{wxdoctemplate}
+and cooperates with the \helpref{wxDocument}{wxdocument}, \helpref{wxDocTemplate}{wxdoctemplate} 

 and \helpref{wxDocManager}{wxdocmanager} classes.
 
 \wxheading{Derived from}
 and \helpref{wxDocManager}{wxdocmanager} classes.
 
 \wxheading{Derived from}


@@ -10,6 +10,10 @@ and \helpref{wxDocManager}{wxdocmanager} classes.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/docview.h>
+

 \wxheading{See also}
 
 \helpref{wxView overview}{wxviewoverview}, \helpref{wxDocument}{wxdocument}, \helpref{wxDocTemplate}{wxdoctemplate},\rtfsp
 \wxheading{See also}
 
 \helpref{wxView overview}{wxviewoverview}, \helpref{wxDocument}{wxdocument}, \helpref{wxDocTemplate}{wxdoctemplate},\rtfsp


@@ -39,7 +43,7 @@ variable when the view is created. Not currently used by the framework.
 
 \membersection{wxView::wxView}
 
 
 \membersection{wxView::wxView}
 

-\func{}{wxView}{\param{wxDocument* }{doc = NULL}}
+\func{}{wxView}{\void}

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


@@ -66,9 +70,9 @@ This function calls wxView::OnActivateView.
 
 \membersection{wxView::Close}
 
 
 \membersection{wxView::Close}
 

-\func{virtual bool}{Close}{\param{bool}{ deleteWindow = TRUE}}
+\func{virtual bool}{Close}{\param{bool}{ deleteWindow = true}}

 
 

-Closes the view by calling OnClose. If {\it deleteWindow} is TRUE, this function should
+Closes the view by calling OnClose. If {\it deleteWindow} is true, this function should

 delete the window associated with the view.
 
 \membersection{wxView::GetDocument}
 delete the window associated with the view.
 
 \membersection{wxView::GetDocument}


@@ -83,11 +87,14 @@ Gets a pointer to the document associated with the view.
 
 Returns a pointer to the document manager instance associated with this view.
 
 
 Returns a pointer to the document manager instance associated with this view.
 

-\membersection{wxView::GetFrame}
+\membersection{wxView::GetFrame}\label{wxviewgetframe}

 
 

-\func{wxFrame *}{GetFrame}{\void}
+\func{wxWindow *}{GetFrame}{\void}

 
 

-Gets the frame associated with the view (if any).
+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.

 
 \membersection{wxView::GetViewName}
 
 
 \membersection{wxView::GetViewName}
 


@@ -118,20 +125,29 @@ 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, {\it if} a
 call to wxDocument::Close succeeded. For example, if your application's
 to close the associated document. Does not delete the view. The application
 may wish to do some cleaning up operations in this function, {\it if} a
 call to wxDocument::Close succeeded. For example, if your application's

-all share the same canvas, you need to disassociate the canvas from the view
-and perhaps clear the canvas. If {\it deleteWindow} is TRUE, delete the
+all share the same window, you need to disassociate the window from the view
+and perhaps clear the window. If {\it deleteWindow} is true, delete the

 frame associated with the view.
 
 frame associated with the view.
 

+\membersection{wxView::OnClosingDocument}\label{wxviewonclosingdocument}
+
+\func{virtual void}{OnClosingDoocument}{\void}
+
+Override this to clean up the view when the document is being
+closed.
+

 \membersection{wxView::OnCreate}
 
 \func{virtual bool}{OnCreate}{\param{wxDocument* }{doc}, \param{long}{ flags}}
 
 \membersection{wxView::OnCreate}
 
 \func{virtual bool}{OnCreate}{\param{wxDocument* }{doc}, \param{long}{ flags}}
 

-Called just after view construction to give the view a chance to initialize
-itself based on the passed document and flags (unused). By default, simply
-returns TRUE. If the function returns FALSE, the view will be deleted.
+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.

 
 

-The predefined document child frame, wxDocChildFrame, calls this function
-automatically.
+By default, simply returns true. If the function returns false, the
+view will be deleted.

 
 \membersection{wxView::OnCreatePrintout}
 
 
 \membersection{wxView::OnCreatePrintout}
 


@@ -139,7 +155,7 @@ automatically.
 
 If the printing framework is enabled in the library, this function returns a
 \rtfsp\helpref{wxPrintout}{wxprintout} object for the purposes of printing. It should create a new object
 
 If the printing framework is enabled in the library, this function returns a
 \rtfsp\helpref{wxPrintout}{wxprintout} object for the purposes of printing. It should create a new object

-everytime it is called; the framework will delete objects it creates.
+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.
 
 By default, this function returns an instance of wxDocPrintout, which prints
 and previews one page by calling wxView::OnDraw.


@@ -164,11 +180,14 @@ framework.
 
 \membersection{wxView::SetFrame}
 
 
 \membersection{wxView::SetFrame}
 

-\func{void}{SetFrame}{\param{wxFrame* }{frame}}
+\func{void}{SetFrame}{\param{wxWindow* }{frame}}

 
 Sets the frame associated with this view. The application should call this
 if possible, to tell the view about the frame.
 
 
 Sets the frame associated with this view. The application should call this
 if possible, to tell the view about the frame.
 

+See \helpref{GetFrame}{wxviewgetframe} for the explanation about the mismatch
+between the ``Frame'' in the method name and the type of its parameter.
+

 \membersection{wxView::SetViewName}
 
 \func{void}{SetViewName}{\param{const wxString\& }{name}}
 \membersection{wxView::SetViewName}
 
 \func{void}{SetViewName}{\param{const wxString\& }{name}}