fixed another return FALSE in a function returning a pointer (patch 545046)

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

diff --git a/docs/latex/wx/document.tex b/docs/latex/wx/document.tex
index dd7eada3507475eaa4456a694f75c0a7f0179938..03b3b82240883aa8ec819002144eaa15f7580935 100644 (file)
--- a/docs/latex/wx/document.tex
+++ b/docs/latex/wx/document.tex
@@ -144,7 +144,7 @@ dialog boxes. By default, uses the frame associated with the first view.
 Gets the filename associated with this document, or "" if none is
 associated.
 
-\membersection{wxDocument::GetFirstView}{wxdocumentgetfirstview}
+\membersection{wxDocument::GetFirstView}\label{wxdocumentgetfirstview}
 
 \constfunc{wxView *}{GetFirstView}{\void}
 
@@ -169,7 +169,7 @@ Gets the title for this document. The document title is used for an associated
 frame (if any), and is usually constructed by the framework from
 the filename.
 
-\membersection{wxDocument::GetViews}{wxdocumentgetviews}
+\membersection{wxDocument::GetViews}\label{wxdocumentgetviews}
 
 \constfunc{wxList \&}{GetViews}{\void}
 
@@ -177,7 +177,6 @@ Returns the list whose elements are the views on the document.
 
 See also: \helpref{GetFirstView}{wxdocumentgetfirstview}
 
-
 \membersection{wxDocument::IsModified}\label{wxdocumentismodified}
 
 \constfunc{virtual bool}{IsModified}{\void}
@@ -192,10 +191,15 @@ See also \helpref{Modify}{wxdocumentmodify}.
 
 \func{virtual istream\&}{LoadObject}{\param{istream\& }{stream}}
 
+\func{virtual wxInputStream\&}{LoadObject}{\param{wxInputStream\& }{stream}}
+
 Override this function and call it from your own LoadObject before
 streaming your own data. LoadObject is called by the framework
 automatically when the document contents need to be loaded.
 
+Note that only one of these forms exists, depending on how wxWindows
+was configured.
+
 \membersection{wxDocument::Modify}\label{wxdocumentmodify}
 
 \func{virtual void}{Modify}{\param{bool}{ modify}}
@@ -298,10 +302,15 @@ Prompts the user for a file to save to, and then calls OnSaveDocument.
 
 \func{virtual ostream\&}{SaveObject}{\param{ostream\& }{stream}}
 
+\func{virtual wxOutputStream\&}{SaveObject}{\param{wxOutputStream\& }{stream}}
+
 Override this function and call it from your own SaveObject before
 streaming your own data. SaveObject is called by the framework
 automatically when the document contents need to be saved.
 
+Note that only one of these forms exists, depending on how wxWindows
+was configured.
+
 \membersection{wxDocument::SetCommandProcessor}
 
 \func{virtual void}{SetCommandProcessor}{\param{wxCommandProcessor *}{processor}}
@@ -327,10 +336,12 @@ framework.
 
 \membersection{wxDocument::SetFilename}
 
-\func{void}{SetFilename}{\param{const wxString\& }{filename}}
+\func{void}{SetFilename}{\param{const wxString\& }{filename}, \param{bool}{ notifyViews = FALSE}}
 
 Sets the filename for this document. Usually called by the framework.
 
+If {\it notifyViews} is TRUE, wxView::OnChangeFilename is called for all views.
+
 \membersection{wxDocument::SetTitle}
 
 \func{void}{SetTitle}{\param{const wxString\& }{title}}
@@ -341,7 +352,9 @@ the filename.
 
 \membersection{wxDocument::UpdateAllViews}\label{wxdocumentupdateallviews}
 
-\func{void}{UpdateAllViews}{\param{wxView* }{sender = NULL}}
+\func{void}{UpdateAllViews}{\param{wxView* }{sender = NULL}, \param{wxObject*}{ hint = NULL}}
 
 Updates all views. If {\it sender} is non-NULL, does not update this view.
 
+{\it hint} represents optional information to allow a view to optimize its update.
+