MF_BYCOMMAND is zero so don't try to test it

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

diff --git a/docs/latex/wx/document.tex b/docs/latex/wx/document.tex
index 462d6365b66187f7742f9773534e85f8e5e25926..413dc2e7e551f0abcfd94571edd0c0b7a4451b19 100644 (file)
--- a/docs/latex/wx/document.tex
+++ b/docs/latex/wx/document.tex
@@ -1,7 +1,7 @@
 \section{\class{wxDocument}}\label{wxdocument}
 
 The document class can be used to model an application's file-based
 \section{\class{wxDocument}}\label{wxdocument}
 
 The document class can be used to model an application's file-based

-data. It is part of the document/view framework supported by wxWindows,
+data. It is part of the document/view framework supported by wxWidgets,

 and cooperates with the \helpref{wxView}{wxview}, \helpref{wxDocTemplate}{wxdoctemplate}\rtfsp
 and \helpref{wxDocManager}{wxdocmanager} classes.
 
 and cooperates with the \helpref{wxView}{wxview}, \helpref{wxDocTemplate}{wxdoctemplate}\rtfsp
 and \helpref{wxDocManager}{wxdocmanager} classes.
 


@@ -21,31 +21,31 @@ and \helpref{wxDocManager}{wxdocmanager} classes.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxDocument::m\_commandProcessor}
+\membersection{wxDocument::m\_commandProcessor}\label{wxdocumentmcommandprocessor}

 
 \member{wxCommandProcessor*}{m\_commandProcessor}
 
 A pointer to the command processor associated with this document.
 
 
 \member{wxCommandProcessor*}{m\_commandProcessor}
 
 A pointer to the command processor associated with this document.
 

-\membersection{wxDocument::m\_documentFile}
+\membersection{wxDocument::m\_documentFile}\label{wxdocumentmdocumentfile}

 
 \member{wxString}{m\_documentFile}
 
 Filename associated with this document (``" if none).
 
 
 \member{wxString}{m\_documentFile}
 
 Filename associated with this document (``" if none).
 

-\membersection{wxDocument::m\_documentModified}
+\membersection{wxDocument::m\_documentModified}\label{wxdocumentmdocumentmodified}

 
 \member{bool}{m\_documentModified}
 
 
 \member{bool}{m\_documentModified}
 

-TRUE if the document has been modified, FALSE otherwise.
+true if the document has been modified, false otherwise.

 
 

-\membersection{wxDocument::m\_documentTemplate}
+\membersection{wxDocument::m\_documentTemplate}\label{wxdocumentmdocumenttemplate}

 
 \member{wxDocTemplate *}{m\_documentTemplate}
 
 A pointer to the template from which this document was created.
 
 
 \member{wxDocTemplate *}{m\_documentTemplate}
 
 A pointer to the template from which this document was created.
 

-\membersection{wxDocument::m\_documentTitle}
+\membersection{wxDocument::m\_documentTitle}\label{wxdocumentmdocumenttitle}

 
 \member{wxString}{m\_documentTitle}
 
 
 \member{wxString}{m\_documentTitle}
 


@@ -63,39 +63,39 @@ created that use the same document type, this variable is used in wxDocManager::
 to collate a list of alternative view types that can be used on this kind of
 document. Do not change the value of this variable.
 
 to collate a list of alternative view types that can be used on this kind of
 document. Do not change the value of this variable.
 

-\membersection{wxDocument::m\_documentViews}
+\membersection{wxDocument::m\_documentViews}\label{wxdocumentmdocumentviews}

 
 \member{wxList}{m\_documentViews}
 
 List of wxView instances associated with this document.
 
 
 \member{wxList}{m\_documentViews}
 
 List of wxView instances associated with this document.
 

-\membersection{wxDocument::wxDocument}
+\membersection{wxDocument::wxDocument}\label{wxdocumentctor}

 
 \func{}{wxDocument}{\void}
 
 Constructor. Define your own default constructor to initialize application-specific
 data.
 
 
 \func{}{wxDocument}{\void}
 
 Constructor. Define your own default constructor to initialize application-specific
 data.
 

-\membersection{wxDocument::\destruct{wxDocument}}
+\membersection{wxDocument::\destruct{wxDocument}}\label{wxdocumentdtor}

 
 \func{}{\destruct{wxDocument}}{\void}
 
 Destructor. Removes itself from the document manager.
 
 
 \func{}{\destruct{wxDocument}}{\void}
 
 Destructor. Removes itself from the document manager.
 

-\membersection{wxDocument::AddView}
+\membersection{wxDocument::AddView}\label{wxdocumentaddview}

 
 \func{virtual bool}{AddView}{\param{wxView *}{view}}
 
 If the view is not already in the list of views, adds the view and calls OnChangedViewList.
 
 
 \func{virtual bool}{AddView}{\param{wxView *}{view}}
 
 If the view is not already in the list of views, adds the view and calls OnChangedViewList.
 

-\membersection{wxDocument::Close}
+\membersection{wxDocument::Close}\label{wxdocumentclose}

 
 \func{virtual bool}{Close}{\void}
 
 
 \func{virtual bool}{Close}{\void}
 

-Closes the document, by calling OnSaveModified and then (if this returned TRUE) OnCloseDocument.
+Closes the document, by calling OnSaveModified and then (if this returned true) OnCloseDocument.

 This does not normally delete the document object: use DeleteAllViews to do this implicitly.
 
 This does not normally delete the document object: use DeleteAllViews to do this implicitly.
 

-\membersection{wxDocument::DeleteAllViews}
+\membersection{wxDocument::DeleteAllViews}\label{wxdocumentdeleteviews}

 
 \func{virtual bool}{DeleteAllViews}{\void}
 
 
 \func{virtual bool}{DeleteAllViews}{\void}
 


@@ -104,7 +104,7 @@ delete the document itself, because the wxView destructor calls RemoveView. This
 in turns calls wxDocument::OnChangedViewList, whose default implemention is to
 save and delete the document if no views exist.
 
 in turns calls wxDocument::OnChangedViewList, whose default implemention is to
 save and delete the document if no views exist.
 

-\membersection{wxDocument::GetCommandProcessor}
+\membersection{wxDocument::GetCommandProcessor}\label{wxdocumentgetcommandprocessor}

 
 \constfunc{wxCommandProcessor*}{GetCommandProcessor}{\void}
 
 
 \constfunc{wxCommandProcessor*}{GetCommandProcessor}{\void}
 


@@ -112,32 +112,32 @@ Returns a pointer to the command processor associated with this document.
 
 See \helpref{wxCommandProcessor}{wxcommandprocessor}.
 
 
 See \helpref{wxCommandProcessor}{wxcommandprocessor}.
 

-\membersection{wxDocument::GetDocumentTemplate}
+\membersection{wxDocument::GetDocumentTemplate}\label{wxdocumentgetdocumenttemplate}

 
 \constfunc{wxDocTemplate*}{GetDocumentTemplate}{\void}
 
 Gets a pointer to the template that created the document.
 
 
 \constfunc{wxDocTemplate*}{GetDocumentTemplate}{\void}
 
 Gets a pointer to the template that created the document.
 

-\membersection{wxDocument::GetDocumentManager}
+\membersection{wxDocument::GetDocumentManager}\label{wxdocumentgetdocumentmanager}

 
 \constfunc{wxDocManager*}{GetDocumentManager}{\void}
 
 Gets a pointer to the associated document manager.
 
 
 \constfunc{wxDocManager*}{GetDocumentManager}{\void}
 
 Gets a pointer to the associated document manager.
 

-\membersection{wxDocument::GetDocumentName}
+\membersection{wxDocument::GetDocumentName}\label{wxdocumentgetdocumentname}

 
 \constfunc{wxString}{GetDocumentName}{\void}
 
 Gets the document type name for this document. See the comment for \helpref{documentTypeName}{documenttypename}.
 
 
 \constfunc{wxString}{GetDocumentName}{\void}
 
 Gets the document type name for this document. See the comment for \helpref{documentTypeName}{documenttypename}.
 

-\membersection{wxDocument::GetDocumentWindow}
+\membersection{wxDocument::GetDocumentWindow}\label{wxdocumentgetdocumentwindow}

 
 \constfunc{wxWindow*}{GetDocumentWindow}{\void}
 
 Intended to return a suitable window for using as a parent for document-related
 dialog boxes. By default, uses the frame associated with the first view.
 
 
 \constfunc{wxWindow*}{GetDocumentWindow}{\void}
 
 Intended to return a suitable window for using as a parent for document-related
 dialog boxes. By default, uses the frame associated with the first view.
 

-\membersection{wxDocument::GetFilename}
+\membersection{wxDocument::GetFilename}\label{wxdocumentgetfilename}

 
 \constfunc{wxString}{GetFilename}{\void}
 
 
 \constfunc{wxString}{GetFilename}{\void}
 


@@ -153,7 +153,7 @@ in many cases a document will only have a single view.
 
 See also: \helpref{GetViews}{wxdocumentgetviews}
 
 
 See also: \helpref{GetViews}{wxdocumentgetviews}
 

-\membersection{wxDocument::GetPrintableName}
+\membersection{wxDocument::GetPrintableName}\label{wxdocumentgetprintablename}

 
 \constfunc{virtual void}{GetPrintableName}{\param{wxString\& }{name}}
 
 
 \constfunc{virtual void}{GetPrintableName}{\param{wxString\& }{name}}
 


@@ -161,7 +161,10 @@ Copies a suitable document name into the supplied {\it name} buffer. The default
 function uses the title, or if there is no title, uses the filename; or if no
 filename, the string {\bf unnamed}. 
 
 function uses the title, or if there is no title, uses the filename; or if no
 filename, the string {\bf unnamed}. 
 

-\membersection{wxDocument::GetTitle}
+\perlnote{In wxPerl this function must return the modified name rather
+than just modifying the argument.}
+
+\membersection{wxDocument::GetTitle}\label{wxdocumentgettitle}

 
 \constfunc{wxString}{GetTitle}{\void}
 
 
 \constfunc{wxString}{GetTitle}{\void}
 


@@ -181,13 +184,13 @@ See also: \helpref{GetFirstView}{wxdocumentgetfirstview}
 
 \constfunc{virtual bool}{IsModified}{\void}
 
 
 \constfunc{virtual bool}{IsModified}{\void}
 

-Returns TRUE if the document has been modified since the last save, FALSE otherwise.
+Returns true if the document has been modified since the last save, false otherwise.

 You may need to override this if your document view maintains its own
 record of being modified (for example if using wxTextWindow to view and edit the document).
 
 See also \helpref{Modify}{wxdocumentmodify}.
 
 You may need to override this if your document view maintains its own
 record of being modified (for example if using wxTextWindow to view and edit the document).
 
 See also \helpref{Modify}{wxdocumentmodify}.
 

-\membersection{wxDocument::LoadObject}
+\membersection{wxDocument::LoadObject}\label{wxdocumentloadobject}

 
 \func{virtual istream\&}{LoadObject}{\param{istream\& }{stream}}
 
 
 \func{virtual istream\&}{LoadObject}{\param{istream\& }{stream}}
 


@@ -197,20 +200,20 @@ 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.
 
 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
+Note that only one of these forms exists, depending on how wxWidgets

 was configured.
 
 \membersection{wxDocument::Modify}\label{wxdocumentmodify}
 
 \func{virtual void}{Modify}{\param{bool}{ modify}}
 
 was configured.
 
 \membersection{wxDocument::Modify}\label{wxdocumentmodify}
 
 \func{virtual void}{Modify}{\param{bool}{ modify}}
 

-Call with TRUE to mark the document as modified since the last save, FALSE otherwise.
+Call with true to mark the document as modified since the last save, false otherwise.

 You may need to override this if your document view maintains its own
 record of being modified (for example if using wxTextWindow to view and edit the document).
 
 See also \helpref{IsModified}{wxdocumentismodified}.
 
 You may need to override this if your document view maintains its own
 record of being modified (for example if using wxTextWindow to view and edit the document).
 
 See also \helpref{IsModified}{wxdocumentismodified}.
 

-\membersection{wxDocument::OnChangedViewList}
+\membersection{wxDocument::OnChangedViewList}\label{wxdocumentonchangedviewlist}

 
 \func{virtual void}{OnChangedViewList}{\void}
 
 
 \func{virtual void}{OnChangedViewList}{\void}
 


@@ -218,24 +221,24 @@ Called when a view is added to or deleted from this document. The default
 implementation saves and deletes the document if no views exist (the last
 one has just been removed).
 
 implementation saves and deletes the document if no views exist (the last
 one has just been removed).
 

-\membersection{wxDocument::OnCloseDocument}
+\membersection{wxDocument::OnCloseDocument}\label{wxdocumentonclosedocument}

 
 \func{virtual bool}{OnCloseDocument}{\void}
 
 The default implementation calls DeleteContents (an empty implementation)
 
 \func{virtual bool}{OnCloseDocument}{\void}
 
 The default implementation calls DeleteContents (an empty implementation)

-sets the modified flag to FALSE. Override this to
+sets the modified flag to false. Override this to

 supply additional behaviour when the document is closed with Close.
 
 supply additional behaviour when the document is closed with Close.
 

-\membersection{wxDocument::OnCreate}
+\membersection{wxDocument::OnCreate}\label{wxdocumentoncreate}

 
 \func{virtual bool}{OnCreate}{\param{const wxString\& }{path}, \param{long}{ flags}}
 
 Called just after the document object is created to give it a chance
 to initialize itself. The default implementation uses the
 template associated with the document to create an initial view.
 
 \func{virtual bool}{OnCreate}{\param{const wxString\& }{path}, \param{long}{ flags}}
 
 Called just after the document object is created to give it a chance
 to initialize itself. The default implementation uses the
 template associated with the document to create an initial view.

-If this function returns FALSE, the document is deleted.
+If this function returns false, the document is deleted.

 
 

-\membersection{wxDocument::OnCreateCommandProcessor}
+\membersection{wxDocument::OnCreateCommandProcessor}\label{wxdocumentoncreatecommandprocessor}

 
 \func{virtual wxCommandProcessor*}{OnCreateCommandProcessor}{\void}
 
 
 \func{virtual wxCommandProcessor*}{OnCreateCommandProcessor}{\void}
 


@@ -245,32 +248,32 @@ an instance of wxCommandProcessor.
 
 See \helpref{wxCommandProcessor}{wxcommandprocessor}.
 
 
 See \helpref{wxCommandProcessor}{wxcommandprocessor}.
 

-\membersection{wxDocument::OnNewDocument}
+\membersection{wxDocument::OnNewDocument}\label{wxdocumentonnewdocument}

 
 \func{virtual bool}{OnNewDocument}{\void}
 
 The default implementation calls OnSaveModified and DeleteContents, makes a default title for the
 document, and notifies the views that the filename (in fact, the title) has changed.
 
 
 \func{virtual bool}{OnNewDocument}{\void}
 
 The default implementation calls OnSaveModified and DeleteContents, makes a default title for the
 document, and notifies the views that the filename (in fact, the title) has changed.
 

-\membersection{wxDocument::OnOpenDocument}
+\membersection{wxDocument::OnOpenDocument}\label{wxdocumentonopendocument}

 
 \func{virtual bool}{OnOpenDocument}{\param{const wxString\& }{filename}}
 
 Constructs an input file stream for the given filename (which must not be empty),
 
 \func{virtual bool}{OnOpenDocument}{\param{const wxString\& }{filename}}
 
 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
+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
 to update their titles. All of the document's views are then updated.
 
 unmodified; otherwise, an error message box is displayed. The document's
 views are notified that the filename has changed, to give windows an opportunity
 to update their titles. All of the document's views are then updated.
 

-\membersection{wxDocument::OnSaveDocument}
+\membersection{wxDocument::OnSaveDocument}\label{wxdocumentonsavedocument}

 
 \func{virtual bool}{OnSaveDocument}{\param{const wxString\& }{filename}}
 
 Constructs an output file stream for the given filename (which must not be empty),
 
 \func{virtual bool}{OnSaveDocument}{\param{const wxString\& }{filename}}
 
 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
+and calls SaveObject. If SaveObject returns true, the document is set to

 unmodified; otherwise, an error message box is displayed.
 
 unmodified; otherwise, an error message box is displayed.
 

-\membersection{wxDocument::OnSaveModified}
+\membersection{wxDocument::OnSaveModified}\label{wxdocumentonsavemodified}

 
 \func{virtual bool}{OnSaveModified}{\void}
 
 
 \func{virtual bool}{OnSaveModified}{\void}
 


@@ -279,26 +282,26 @@ be changed. If the user replies Yes, the Save function is called. If No, the
 document is marked as unmodified and the function succeeds. If Cancel, the
 function fails.
 
 document is marked as unmodified and the function succeeds. If Cancel, the
 function fails.
 

-\membersection{wxDocument::RemoveView}
+\membersection{wxDocument::RemoveView}\label{wxdocumentremoveview}

 
 \func{virtual bool}{RemoveView}{\param{wxView* }{view}}
 
 Removes the view from the document's list of views, and calls OnChangedViewList.
 
 
 \func{virtual bool}{RemoveView}{\param{wxView* }{view}}
 
 Removes the view from the document's list of views, and calls OnChangedViewList.
 

-\membersection{wxDocument::Save}
+\membersection{wxDocument::Save}\label{wxdocumentsave}

 
 \func{virtual bool}{Save}{\void}
 
 Saves the document by calling OnSaveDocument if there is an associated filename,
 or SaveAs if there is no filename.
 
 
 \func{virtual bool}{Save}{\void}
 
 Saves the document by calling OnSaveDocument if there is an associated filename,
 or SaveAs if there is no filename.
 

-\membersection{wxDocument::SaveAs}
+\membersection{wxDocument::SaveAs}\label{wxdocumentsaveas}

 
 \func{virtual bool}{SaveAs}{\void}
 
 Prompts the user for a file to save to, and then calls OnSaveDocument.
 
 
 \func{virtual bool}{SaveAs}{\void}
 
 Prompts the user for a file to save to, and then calls OnSaveDocument.
 

-\membersection{wxDocument::SaveObject}
+\membersection{wxDocument::SaveObject}\label{wxdocumentsaveobject}

 
 \func{virtual ostream\&}{SaveObject}{\param{ostream\& }{stream}}
 
 
 \func{virtual ostream\&}{SaveObject}{\param{ostream\& }{stream}}
 


@@ -308,10 +311,10 @@ 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.
 
 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
+Note that only one of these forms exists, depending on how wxWidgets

 was configured.
 
 was configured.
 

-\membersection{wxDocument::SetCommandProcessor}
+\membersection{wxDocument::SetCommandProcessor}\label{wxdocumentsetcommandprocessor}

 
 \func{virtual void}{SetCommandProcessor}{\param{wxCommandProcessor *}{processor}}
 
 
 \func{virtual void}{SetCommandProcessor}{\param{wxCommandProcessor *}{processor}}
 


@@ -321,28 +324,28 @@ instead.
 
 See \helpref{wxCommandProcessor}{wxcommandprocessor}.
 
 
 See \helpref{wxCommandProcessor}{wxcommandprocessor}.
 

-\membersection{wxDocument::SetDocumentName}
+\membersection{wxDocument::SetDocumentName}\label{wxdocumentsetdocumentname}

 
 \func{void}{SetDocumentName}{\param{const wxString\& }{name}}
 
 Sets the document type name for this document. See the comment for \helpref{documentTypeName}{documenttypename}.
 
 
 \func{void}{SetDocumentName}{\param{const wxString\& }{name}}
 
 Sets the document type name for this document. See the comment for \helpref{documentTypeName}{documenttypename}.
 

-\membersection{wxDocument::SetDocumentTemplate}
+\membersection{wxDocument::SetDocumentTemplate}\label{wxdocumentsetdocumenttemplate}

 
 \func{void}{SetDocumentTemplate}{\param{wxDocTemplate* }{templ}}
 
 Sets the pointer to the template that created the document. Should only be called by the
 framework.
 
 
 \func{void}{SetDocumentTemplate}{\param{wxDocTemplate* }{templ}}
 
 Sets the pointer to the template that created the document. Should only be called by the
 framework.
 

-\membersection{wxDocument::SetFilename}
+\membersection{wxDocument::SetFilename}\label{wxdocumentsetfilename}

 
 

-\func{void}{SetFilename}{\param{const wxString\& }{filename}, \param{bool}{ notifyViews = FALSE}}
+\func{void}{SetFilename}{\param{const wxString\& }{filename}, \param{bool}{ notifyViews = false}}

 
 Sets the filename for this document. Usually called by the framework.
 
 
 Sets the filename for this document. Usually called by the framework.
 

-If {\it notifyViews} is TRUE, wxView::OnChangeFilename is called for all views.
+If {\it notifyViews} is true, wxView::OnChangeFilename is called for all views.

 
 

-\membersection{wxDocument::SetTitle}
+\membersection{wxDocument::SetTitle}\label{wxdocumentsettitle}

 
 \func{void}{SetTitle}{\param{const wxString\& }{title}}
 
 
 \func{void}{SetTitle}{\param{const wxString\& }{title}}
 


@@ -352,7 +355,9 @@ the filename.
 
 \membersection{wxDocument::UpdateAllViews}\label{wxdocumentupdateallviews}
 
 
 \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.
 
 
 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.
+