X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ac0ac8241f5ea7249ea01c04452efc0b72f49b1f..9ef63a4a59eccce6cd8787f0ed966bfa8365a22e:/docs/latex/wx/docmanag.tex diff --git a/docs/latex/wx/docmanag.tex b/docs/latex/wx/docmanag.tex index b2eecb5e39..7194f9e0a8 100644 --- a/docs/latex/wx/docmanag.tex +++ b/docs/latex/wx/docmanag.tex @@ -114,6 +114,12 @@ Adds a file to the file history list, if we have a pointer to an appropriate fil Adds the template to the document manager's template list. +\membersection{wxDocManager::CloseDocuments} + +\func{bool}{CloseDocuments}{\param{bool }{force = TRUE}} + +Closes all currentled opened documents. + \membersection{wxDocManager::CreateDocument} \func{wxDocument*}{CreateDocument}{\param{const wxString\& }{path}, \param{long}{ flags}} @@ -284,6 +290,12 @@ from \helpref{Initialize}{wxdocmanagerinitialize}. Closes and deletes the currently active document. +\membersection{wxDocManager::OnFileCloseAll} + +\func{void}{OnFileCloseAll}{\void} + +Closes and deletes all the currently opened documents. + \membersection{wxDocManager::OnFileNew} \func{void}{OnFileNew}{\void} @@ -318,6 +330,7 @@ with the following predefined menu item identifiers: \begin{itemize}\itemsep=0pt \item wxID\_OPEN Creates a new document and opens a file into it. \item wxID\_CLOSE Closes the current document. +\item wxID\_CLOSE\_ALL Closes all documents. \item wxID\_NEW Creates a new document. \item wxID\_SAVE Saves the document. \item wxID\_SAVE\_AS Saves the document into a specified filename. @@ -348,21 +361,39 @@ This function is used in wxDocManager::CreateDocument. \membersection{wxDocManager::SelectDocumentType} \func{wxDocTemplate *}{SelectDocumentType}{\param{wxDocTemplate **}{templates}, - \param{int}{ noTemplates}} + \param{int}{ noTemplates}, \param{bool}{ sort=FALSE}} Returns a document template by asking the user (if there is more than one template). This function is used in wxDocManager::CreateDocument. +\wxheading{Parameters} + +\docparam{templates}{Pointer to an array of templates from which to choose a desired template.} +\docparam{noTemplates}{Number of templates being pointed to by the {\it templates} pointer.} +\docparam{sort}{If more than one template is passed in in {\it templates}, +then this parameter indicates whether the list of templates that the user +will have to choose from is sorted or not when shown the choice box dialog. +Default is FALSE.} + \membersection{wxDocManager::SelectViewType} \func{wxDocTemplate *}{SelectViewType}{\param{wxDocTemplate **}{templates}, - \param{int}{ noTemplates}} + \param{int}{ noTemplates}, \param{bool}{ sort=FALSE}} Returns a document template by asking the user (if there is more than one template), displaying a list of valid views. This function is used in wxDocManager::CreateView. -The dialog normally won't appear because the array of templates only contains +The dialog normally will not appear because the array of templates only contains those relevant to the document in question, and often there will only be one such. +\wxheading{Parameters} + +\docparam{templates}{Pointer to an array of templates from which to choose a desired template.} +\docparam{noTemplates}{Number of templates being pointed to by the {\it templates} pointer.} +\docparam{sort}{If more than one template is passed in in {\it templates}, +then this parameter indicates whether the list of templates that the user +will have to choose from is sorted or not when shown the choice box dialog. +Default is FALSE.} + \membersection{wxDocManager::SetLastDirectory}\label{wxdocmanagersetlastdirectory} \func{void}{SetLastDirectory}{\param{const wxString\&}{ dir}}