X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..d9c8e68e58c5d6b0debc5df02b8fa6dba719e12e:/docs/latex/wx/document.tex?ds=sidebyside diff --git a/docs/latex/wx/document.tex b/docs/latex/wx/document.tex index 99a4553c03..7bb4d774d2 100644 --- a/docs/latex/wx/document.tex +++ b/docs/latex/wx/document.tex @@ -10,6 +10,10 @@ and \helpref{wxDocManager}{wxdocmanager} classes. \helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \wxheading{See also} \helpref{wxDocument overview}{wxdocumentoverview}, \helpref{wxView}{wxview},\rtfsp @@ -137,16 +141,18 @@ dialog boxes. By default, uses the frame associated with the first view. \constfunc{wxString}{GetFilename}{\void} -Gets the filename associated with this document, or NULL if none is +Gets the filename associated with this document, or "" if none is associated. -\membersection{wxDocument::GetFirstView} +\membersection{wxDocument::GetFirstView}\label{wxdocumentgetfirstview} -\constfunc{wxView*}{GetFirstView}{\void} +\constfunc{wxView *}{GetFirstView}{\void} A convenience function to get the first view for a document, because in many cases a document will only have a single view. +See also: \helpref{GetViews}{wxdocumentgetviews} + \membersection{wxDocument::GetPrintableName} \constfunc{virtual void}{GetPrintableName}{\param{wxString\& }{name}} @@ -163,6 +169,14 @@ 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}\label{wxdocumentgetviews} + +\constfunc{wxList \&}{GetViews}{\void} + +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} @@ -237,7 +251,7 @@ document, and notifies the views that the filename (in fact, the title) has chan \func{virtual bool}{OnOpenDocument}{\param{const wxString\& }{filename}} -Constructs an input file stream for the given filename (which must not be NULL), +Constructs an input file stream for the given filename (which must not be empty), and calls LoadObject. If LoadObject returns TRUE, the document is set to unmodified; otherwise, an error message box is displayed. The document's views are notified that the filename has changed, to give windows an opportunity @@ -247,7 +261,7 @@ to update their titles. All of the document's views are then updated. \func{virtual bool}{OnSaveDocument}{\param{const wxString\& }{filename}} -Constructs an output file stream for the given filename (which must not be NULL), +Constructs an output file stream for the given filename (which must not be empty), and calls SaveObject. If SaveObject returns TRUE, the document is set to unmodified; otherwise, an error message box is displayed. @@ -324,4 +338,9 @@ Sets 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::UpdateAllViews}\label{wxdocumentupdateallviews} + +\func{void}{UpdateAllViews}{\param{wxView* }{sender = NULL}} + +Updates all views. If {\it sender} is non-NULL, does not update this view.