corrected Get/SetFrame() parameter/return type

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@18744 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/docs/latex/wx/view.tex b/docs/latex/wx/view.tex
index acb0fc49343ea8c5fc391f418e1c4dd6e2d269a2..82d2a1c357357f7bd99d622e4b8384caa82903b3 100644 (file)
--- a/docs/latex/wx/view.tex
+++ b/docs/latex/wx/view.tex
@@ -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}
 


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