X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/954b8ae60391d18b87a604e7919c87c0c6ae208b..bf7945cef10c0844a32e95695c544d829da9293a:/docs/latex/wx/docmanag.tex?ds=sidebyside diff --git a/docs/latex/wx/docmanag.tex b/docs/latex/wx/docmanag.tex index f49e353689..4f501d1708 100644 --- a/docs/latex/wx/docmanag.tex +++ b/docs/latex/wx/docmanag.tex @@ -58,6 +58,12 @@ A list of all documents. Stores the flags passed to the constructor. +\membersection{wxDocManager::m\_lastDirectory} + +The directory last selected by the user when opening a file. + +\member{wxFileHistory*}{m\_fileHistory} + \membersection{wxDocManager::m\_templates} \member{wxList}{mnTemplates} @@ -222,6 +228,12 @@ Returns a reference to the list of documents. Returns a pointer to file history. +\membersection{wxDocManager::GetLastDirectory}\label{wxdocmanagergetlastdirectory} + +\constfunc{wxString}{GetLastDirectory}{\void} + +Returns the directory last selected by the user when opening a file. Initially empty. + \membersection{wxDocManager::GetMaxDocsOpen} \func{int}{GetMaxDocsOpen}{\void} @@ -336,21 +348,45 @@ 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}} + +Sets the directory to be displayed to the user when opening a file. Initially this is empty. + \membersection{wxDocManager::SetMaxDocsOpen} \func{void}{SetMaxDocsOpen}{\param{int}{ n}}