]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/view.tex
Added wxRect::Intersect() documentation (patch 1868322 from Laurent Humbertclaude).
[wxWidgets.git] / docs / latex / wx / view.tex
index fc6c64b7a75b9a06303fb364ec2d26fabbdc9961..d2f90a297c8b84144203681e35bbb72fbdb41d60 100644 (file)
@@ -1,8 +1,19 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name:        view.tex
+%% Purpose:     wxView documentation
+%% Author:      wxWidgets Team
+%% Modified by:
+%% Created:
+%% RCS-ID:      $Id$
+%% Copyright:   (c) wxWidgets Team
+%% License:     wxWindows license
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
 \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 wxWidgets,
-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}
@@ -14,6 +25,10 @@ and \helpref{wxDocManager}{wxdocmanager} classes.
 
 <wx/docview.h>
 
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{wxView overview}{wxviewoverview}, \helpref{wxDocument}{wxdocument}, \helpref{wxDocTemplate}{wxdoctemplate},\rtfsp
@@ -60,11 +75,10 @@ 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
+call this function from 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.
+The prepackaged view frame wxDocChildFrame calls wxView::Activate from its OnActivate member.
 
 This function calls wxView::OnActivateView.
 
@@ -83,7 +97,7 @@ Gets a pointer to the document associated with the view.
 
 \membersection{wxView::GetDocumentManager}\label{wxviewgetdocumentmanager}
 
-\constfunc{wxDocumentManager*}{GetDocumentManager}{\void}
+\constfunc{wxDocManager*}{GetDocumentManager}{\void}
 
 Returns a pointer to the document manager instance associated with this view.
 
@@ -124,14 +138,14 @@ suitable title and sets the title of the view frame (if any).
 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
+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 {\it deleteWindow} is true, delete the
 frame associated with the view.
 
 \membersection{wxView::OnClosingDocument}\label{wxviewonclosingdocument}
 
-\func{virtual void}{OnClosingDoocument}{\void}
+\func{virtual void}{OnClosingDocument}{\void}
 
 Override this to clean up the view when the document is being
 closed.
@@ -162,6 +176,12 @@ and previews one page by calling wxView::OnDraw.
 
 Override to return an instance of a class other than wxDocPrintout.
 
+\membersection{wxView::OnDraw}\label{onviewondraw}
+
+\func{virtual void}{OnDraw}{\param{wxDC* }{dc}}
+
+Override this function to render the view on the given device context.
+
 \membersection{wxView::OnUpdate}\label{onviewonupdate}
 
 \func{virtual void}{OnUpdate}{\param{wxView* }{sender}, \param{wxObject* }{hint}}
@@ -194,4 +214,3 @@ 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.
 
-