Updated note about wxWANTS_CHARS

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

diff --git a/docs/latex/wx/docmanag.tex b/docs/latex/wx/docmanag.tex
index 1cfbfbe0b7b565b6b201955f7cd705c0dc2a3cd7..c1d1161a07efdbd698de5cf984cf52edace2b4ca 100644 (file)
--- 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}
 
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/docview.h>
+

 \wxheading{See also}
 
 \helpref{wxDocManager overview}{wxdocmanageroverview}, \helpref{wxDocument}{wxdocument},\rtfsp
 \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}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 


@@ -54,6 +58,12 @@ A list of all documents.
 
 Stores the flags passed to the constructor.
 
 
 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}
 \membersection{wxDocManager::m\_templates}
 
 \member{wxList}{mnTemplates}


@@ -62,16 +72,16 @@ A list of all document templates.
 
 \membersection{wxDocManager::wxDocManager}
 
 
 \membersection{wxDocManager::wxDocManager}
 

-\func{void}{wxDocManager}{\param{long}{ flags = wxDEFAULT\_DOCMAN\_FLAGS}, \param{bool}{ initialize = TRUE}}
+\func{void}{wxDocManager}{\param{long}{ flags = wxDEFAULT\_DOCMAN\_FLAGS}, \param{bool}{ initialize = true}}

 
 Constructor. Create a document manager instance dynamically near the start of your application
 before doing any document or view operations.
 
 {\it flags} is currently unused.
 
 
 Constructor. Create a document manager instance dynamically near the start of your application
 before doing any document or view operations.
 
 {\it flags} is currently unused.
 

-If {\it initialize} is TRUE, the \helpref{Initialize}{wxdocmanagerinitialize} function will be called
+If {\it initialize} is true, the \helpref{Initialize}{wxdocmanagerinitialize} function will be called

 to create a default history list object. If you derive from wxDocManager, you may wish to call the
 to create a default history list object. If you derive from wxDocManager, you may wish to call the

-base constructor with FALSE, and then call Initialize in your own constructor, to allow
+base constructor with false, and then call Initialize in your own constructor, to allow

 your own Initialize or OnCreateFileHistory functions to be called.
 
 \membersection{wxDocManager::\destruct{wxDocManager}}
 your own Initialize or OnCreateFileHistory functions to be called.
 
 \membersection{wxDocManager::\destruct{wxDocManager}}


@@ -104,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.
 
 
 Adds the template to the document manager's template list.
 

+\membersection{wxDocManager::CloseDocuments}
+
+\func{bool}{CloseDocuments}{\param{bool }{force = true}}
+
+Closes all currently opened documents.
+

 \membersection{wxDocManager::CreateDocument}
 
 \func{wxDocument*}{CreateDocument}{\param{const wxString\& }{path}, \param{long}{ flags}}
 \membersection{wxDocManager::CreateDocument}
 
 \func{wxDocument*}{CreateDocument}{\param{const wxString\& }{path}, \param{long}{ flags}}


@@ -139,28 +155,54 @@ of view is presented to the user.
 
 Removes the template from the list of templates.
 
 
 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}
+
+\func{void}{FileHistoryRemoveMenu}{\param{wxMenu*}{ menu}}
+
+Removes the given menu from the list of menus managed by the file history object.

 
 

-\membersection{wxDocManager::FileHistorySave}
+\membersection{wxDocManager::FileHistorySave}\label{wxdocmanagerfilehistorysave}

 
 

-\func{void}{FileHistorySave}{\param{const wxString\& }{resourceFile}, \param{const wxString\& }{sectionName}}
+\func{void}{FileHistorySave}{\param{wxConfigBase\& }{resourceFile}}

 
 

-Saves the file history into a resource file, using the given section. This must be called
+Saves the file history into a config object. This must be called

 explicitly by the application.
 
 explicitly by the application.
 

-\membersection{wxDocManager::FileHistoryUseMenu}
+\wxheading{See also}
+
+\helpref{wxConfig}{wxconfigbase}
+
+\membersection{wxDocManager::FileHistoryUseMenu}\label{wxdocmanagerfilehistoryusemenu}

 
 

-\func{void}{FileHistoryUseMenu}{\param{wxMenu *}{menu}}
+\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.
 
 
 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}}
 \membersection{wxDocManager::FindTemplateForPath}
 
 \func{wxDocTemplate *}{FindTemplateForPath}{\param{const wxString\& }{path}}


@@ -192,15 +234,21 @@ Returns a reference to the list of documents.
 
 Returns a pointer to file history.
 
 
 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}
 
 Returns the number of documents that can be open simultaneously.
 
 \membersection{wxDocManager::GetMaxDocsOpen}
 
 \func{int}{GetMaxDocsOpen}{\void}
 
 Returns the number of documents that can be open simultaneously.
 

-\membersection{wxDocManager::GetNoHistoryFiles}
+\membersection{wxDocManager::GetHistoryFilesCount}

 
 

-\func{int}{GetNoHistoryFiles}{\void}
+\func{size\_t}{GetHistoryFilesCount}{\void}

 
 Returns the number of files currently stored in the file history.
 
 
 Returns the number of files currently stored in the file history.
 


@@ -214,7 +262,7 @@ the opportunity to override functionality. If OnCreateFileHistory was called
 from the constructor, an overridden virtual OnCreateFileHistory would not be
 called due to C++'s `interesting' constructor semantics. In fact Initialize
 \rtfsp{\it is} called from the wxDocManager constructor, but this can be
 from the constructor, an overridden virtual OnCreateFileHistory would not be
 called due to C++'s `interesting' constructor semantics. In fact Initialize
 \rtfsp{\it is} called from the wxDocManager constructor, but this can be

-vetoed by passing FALSE to the second argument, allowing the derived class's
+vetoed by passing false to the second argument, allowing the derived class's

 constructor to call Initialize, possibly calling a different OnCreateFileHistory
 from the default.
 
 constructor to call Initialize, possibly calling a different OnCreateFileHistory
 from the default.
 


@@ -229,6 +277,9 @@ Copies a suitable default name into {\it buf}. This is implemented by
 appending an integer counter to the string {\bf unnamed} and incrementing
 the counter.
 
 appending an integer counter to the string {\bf unnamed} and incrementing
 the counter.
 

+\perlnote{In wxPerl this function must return the modified name rather
+than just modifying the argument.}
+

 \membersection{wxDocManager::OnCreateFileHistory}
 
 \func{wxFileHistory *}{OnCreateFileHistory}{\void}
 \membersection{wxDocManager::OnCreateFileHistory}
 
 \func{wxFileHistory *}{OnCreateFileHistory}{\void}


@@ -242,6 +293,12 @@ from \helpref{Initialize}{wxdocmanagerinitialize}.
 
 Closes and deletes the currently active document.
 
 
 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}
 \membersection{wxDocManager::OnFileNew}
 
 \func{void}{OnFileNew}{\void}


@@ -276,6 +333,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.
 \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.
 \item wxID\_NEW Creates a new document.
 \item wxID\_SAVE Saves the document.
 \item wxID\_SAVE\_AS Saves the document into a specified filename.


@@ -303,24 +361,58 @@ followed by a file selector.
 
 This function is used in wxDocManager::CreateDocument.
 
 
 This function is used in wxDocManager::CreateDocument.
 

+\perlnote{In wxPerl {\tt templates} is a reference to a list of templates.
+If you override this method in your document manager it must return
+two values, eg:\par
+  (doctemplate, path) = My::DocManager->SelectDocumentPath( ... );
+}
+

 \membersection{wxDocManager::SelectDocumentType}
 
 \func{wxDocTemplate *}{SelectDocumentType}{\param{wxDocTemplate **}{templates},
 \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.
 
 
 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.}
+
+\perlnote{In wxPerl {\tt templates} is a reference to a list of templates.}
+

 \membersection{wxDocManager::SelectViewType}
 
 \func{wxDocTemplate *}{SelectViewType}{\param{wxDocTemplate **}{templates},
 \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.
 
 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.
 
 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.}
+
+\perlnote{In wxPerl {\tt templates} is a reference to a list of templates.}
+
+\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}}
 \membersection{wxDocManager::SetMaxDocsOpen}
 
 \func{void}{SetMaxDocsOpen}{\param{int}{ n}}