X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..a9249b2eb2a40d8c71f828669045c4ddaa8dc5ff:/docs/latex/wx/docmanag.tex diff --git a/docs/latex/wx/docmanag.tex b/docs/latex/wx/docmanag.tex index 1cfbfbe0b7..4f501d1708 100644 --- a/docs/latex/wx/docmanag.tex +++ b/docs/latex/wx/docmanag.tex @@ -9,10 +9,14 @@ and \helpref{wxDocTemplate}{wxdoctemplate} classes. \helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \wxheading{See also} \helpref{wxDocManager overview}{wxdocmanageroverview}, \helpref{wxDocument}{wxdocument},\rtfsp -\helpref{wxView}{wxview}, \helpref{wxDocTemplate}{wxdoctemplate} +\helpref{wxView}{wxview}, \helpref{wxDocTemplate}{wxdoctemplate}, \helpref{wxFileHistory}{wxfilehistory} \latexignore{\rtfignore{\wxheading{Members}}} @@ -54,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} @@ -139,28 +149,54 @@ of view is presented to the user. Removes the template from the list of templates. -\membersection{wxDocManager::FileHistoryLoad} +\membersection{wxDocManager::FileHistoryAddFilesToMenu}\label{wxdocmanagerfilehistoryaddfilestomenu} -\func{void}{FileHistoryLoad}{\param{const wxString\& }{resourceFile}, \param{const wxString\& }{sectionName}} +\func{void}{FileHistoryAddFilesToMenu}{\void} -Loads the file history from a resource file, using the given section. This must be called -explicitly by the application. +Appends the files in the history list, to all menus managed by the file history object. + +\func{void}{FileHistoryAddFilesToMenu}{\param{wxMenu*}{ menu}} + +Appends the files in the history list, to the given menu only. + +\membersection{wxDocManager::FileHistoryLoad}\label{wxdocmanagerfilehistoryload} + +\func{void}{FileHistoryLoad}{\param{wxConfigBase\& }{config}} + +Loads the file history from a config object. + +\wxheading{See also} + +\helpref{wxConfig}{wxconfigbase} + +\membersection{wxDocManager::FileHistoryRemoveMenu}\label{wxdocmanagerfilehistoryremovemenu} -\membersection{wxDocManager::FileHistorySave} +\func{void}{FileHistoryRemoveMenu}{\param{wxMenu*}{ menu}} -\func{void}{FileHistorySave}{\param{const wxString\& }{resourceFile}, \param{const wxString\& }{sectionName}} +Removes the given menu from the list of menus managed by the file history object. -Saves the file history into a resource file, using the given section. This must be called +\membersection{wxDocManager::FileHistorySave}\label{wxdocmanagerfilehistorysave} + +\func{void}{FileHistorySave}{\param{wxConfigBase\& }{resourceFile}} + +Saves the file history into a config object. This must be called explicitly by the application. -\membersection{wxDocManager::FileHistoryUseMenu} +\wxheading{See also} + +\helpref{wxConfig}{wxconfigbase} -\func{void}{FileHistoryUseMenu}{\param{wxMenu *}{menu}} +\membersection{wxDocManager::FileHistoryUseMenu}\label{wxdocmanagerfilehistoryusemenu} + +\func{void}{FileHistoryUseMenu}{\param{wxMenu*}{ menu}} Use this menu for appending recently-visited document filenames, for convenient access. Calling this function with a valid menu pointer enables the history list functionality. +Note that you can add multiple menus using this function, to be managed by the +file history object. + \membersection{wxDocManager::FindTemplateForPath} \func{wxDocTemplate *}{FindTemplateForPath}{\param{const wxString\& }{path}} @@ -192,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} @@ -306,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}}