reSWIGged

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

diff --git a/docs/latex/wx/view.tex b/docs/latex/wx/view.tex
index d9fa115fdf33c84e931f003b8e39cb113e67fea5..78c78385cc8ca1153303deded2c756a391a99c63 100644 (file)
--- a/docs/latex/wx/view.tex
+++ b/docs/latex/wx/view.tex
@@ -1,7 +1,7 @@
 \section{\class{wxView}}\label{wxview}
 
 The view class can be used to model the viewing and editing component of
 \section{\class{wxView}}\label{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 wxWindows,
+an application's file-based data. It is part of the document/view framework supported by wxWidgets,

 and cooperates with the \helpref{wxDocument}{wxdocument}, \helpref{wxDocTemplate}{wxdoctemplate} 
 and \helpref{wxDocManager}{wxdocmanager} classes.
 
 and cooperates with the \helpref{wxDocument}{wxdocument}, \helpref{wxDocTemplate}{wxdoctemplate} 
 and \helpref{wxDocManager}{wxdocmanager} classes.
 


@@ -70,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}


@@ -87,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}
 


@@ -123,9 +126,16 @@ 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 window, you need to disassociate the window from the view
 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 window, you need to disassociate the window from the view

-and perhaps clear the window. If {\it deleteWindow} is TRUE, delete the
+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}}


@@ -136,7 +146,7 @@ wxView::OnCreate. In its OnCreate member function, the wxView can create a wxDoc
 or a derived class. This wxDocChildFrame provides user interface
 elements to view and/or edit the contents of the wxDocument.
 
 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
+By default, simply returns true. If the function returns false, the

 view will be deleted.
 
 \membersection{wxView::OnCreatePrintout}
 view will be deleted.
 
 \membersection{wxView::OnCreatePrintout}


@@ -170,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}}