Generalized wxScrolledWindow into wxScrolled<T> that can derive from

[wxWidgets.git] / interface / docview.h

diff --git a/interface/docview.h b/interface/docview.h
index 2cbade4595556fb1066def274a5e3315096e61a5..0cbe2a7e46df554ae33617737cdd650706ccf614 100644 (file)
--- a/interface/docview.h
+++ b/interface/docview.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        docview.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        docview.h

-// Purpose:     documentation for wxDocTemplate class
+// Purpose:     interface of wxDocTemplate

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -16,8 +16,8 @@
     @library{wxcore}
     @category{dvf}
 
     @library{wxcore}
     @category{dvf}
 

-    @seealso
-    @ref overview_wxdoctemplateoverview "wxDocTemplate overview", wxDocument, wxView
+    @see @ref overview_wxdoctemplateoverview "wxDocTemplate overview", wxDocument,
+    wxView

 */
 class wxDocTemplate : public wxObject
 {
 */
 class wxDocTemplate : public wxObject
 {


@@ -26,64 +26,49 @@ public:
         Constructor. Create instances dynamically near the start of your application
         after creating
         a wxDocManager instance, and before doing any document or view operations.
         Constructor. Create instances dynamically near the start of your application
         after creating
         a wxDocManager instance, and before doing any document or view operations.

-        
-        @e manager is the document manager object which manages this template.
-        
-        @e descr is a short description of what the template is for. This string will
+        @a manager is the document manager object which manages this template.
+        @a descr is a short description of what the template is for. This string will

         be displayed in the
         file filter list of Windows file selectors.
         be displayed in the
         file filter list of Windows file selectors.

-        
-        @e filter is an appropriate file filter such as @c *.txt.
-        
-        @e dir is the default directory to use for file selectors.
-        
-        @e ext is the default file extension (such as txt).
-        
-        @e docTypeName is a name that should be unique for a given type of document,
+        @a filter is an appropriate file filter such as @c *.txt.
+        @a dir is the default directory to use for file selectors.
+        @a ext is the default file extension (such as txt).
+        @a docTypeName is a name that should be unique for a given type of document,

         used for
         gathering a list of views relevant to a particular document.
         used for
         gathering a list of views relevant to a particular document.

-        
-        @e viewTypeName is a name that should be unique for a given view.
-        
-        @e docClassInfo is a pointer to the run-time document class information as
+        @a viewTypeName is a name that should be unique for a given view.
+        @a docClassInfo is a pointer to the run-time document class information as

         returned
         by the CLASSINFO macro, e.g. CLASSINFO(MyDocumentClass). If this is not
         supplied,
         you will need to derive a new wxDocTemplate class and override the
         CreateDocument
         member to return a new document instance on demand.
         returned
         by the CLASSINFO macro, e.g. CLASSINFO(MyDocumentClass). If this is not
         supplied,
         you will need to derive a new wxDocTemplate class and override the
         CreateDocument
         member to return a new document instance on demand.

-        
-        @e viewClassInfo is a pointer to the run-time view class information as returned
+        @a viewClassInfo is a pointer to the run-time view class information as returned

         by the CLASSINFO macro, e.g. CLASSINFO(MyViewClass). If this is not supplied,
         you will need to derive a new wxDocTemplate class and override the CreateView
         member to return a new view instance on demand.
         by the CLASSINFO macro, e.g. CLASSINFO(MyViewClass). If this is not supplied,
         you will need to derive a new wxDocTemplate class and override the CreateView
         member to return a new view instance on demand.

-        
-        @e flags is a bit list of the following:
-        
+        @a flags is a bit list of the following:

          wxTEMPLATE_VISIBLE The template may be displayed to the user in dialogs.
          wxTEMPLATE_INVISIBLE The template may not be displayed to the user in dialogs.
          wxDEFAULT_TEMPLATE_FLAGS Defined as wxTEMPLATE_VISIBLE.
          wxTEMPLATE_VISIBLE The template may be displayed to the user in dialogs.
          wxTEMPLATE_INVISIBLE The template may not be displayed to the user in dialogs.
          wxDEFAULT_TEMPLATE_FLAGS Defined as wxTEMPLATE_VISIBLE.

-        
-        
-        
+
+

         @b Wx::DocTemplate-new( docmgr, descr, filter, dir,
         ext, docTypeName, viewTypeName, docClassInfo, viewClassInfo, flags
         )
         @b Wx::DocTemplate-new( docmgr, descr, filter, dir,
         ext, docTypeName, viewTypeName, docClassInfo, viewClassInfo, flags
         )

-        
-        
+

          will construct document and view objects from the class information
          will construct document and view objects from the class information

-        
+

         @b Wx::DocTemplate-new( docmgr, descr, filter, dir,
         ext, docTypeName, viewTypeName, docClassName, viewClassName, flags
         )
         @b Wx::DocTemplate-new( docmgr, descr, filter, dir,
         ext, docTypeName, viewTypeName, docClassName, viewClassName, flags
         )

-        
-        
+

          will construct document and view objects from perl packages
          will construct document and view objects from perl packages

-        
+

         @b Wx::DocTemplate-new( docmgr, descr, filter, dir,
         ext, docTypeName, viewTypeName )
         @b Wx::DocTemplate-new( docmgr, descr, filter, dir,
         ext, docTypeName, viewTypeName )

-        
-        
+

         @c Wx::DocTemplate::CreateDocument() and
         @c Wx::DocTemplate::CreateView() must be overridden
     */
         @c Wx::DocTemplate::CreateDocument() and
         @c Wx::DocTemplate::CreateView() must be overridden
     */


@@ -93,8 +78,8 @@ public:
                   const wxString& ext,
                   const wxString& docTypeName,
                   const wxString& viewTypeName,
                   const wxString& ext,
                   const wxString& docTypeName,
                   const wxString& viewTypeName,

-                  wxClassInfo* docClassInfo = @NULL,
-                  wxClassInfo* viewClassInfo = @NULL,
+                  wxClassInfo* docClassInfo = NULL,
+                  wxClassInfo* viewClassInfo = NULL,

                   long flags = wxDEFAULT_TEMPLATE_FLAGS);
 
     /**
                   long flags = wxDEFAULT_TEMPLATE_FLAGS);
 
     /**


@@ -108,11 +93,10 @@ public:
         a wxClassInfo parameter to the template constructor, you will need to override
         this
         function to return an appropriate document instance.
         a wxClassInfo parameter to the template constructor, you will need to override
         this
         function to return an appropriate document instance.

-        

         This function calls InitDocument() which in turns
         calls wxDocument::OnCreate.
     */
         This function calls InitDocument() which in turns
         calls wxDocument::OnCreate.
     */

-    wxDocument * CreateDocument(const wxString& path, long flags = 0);
+    wxDocument* CreateDocument(const wxString& path, long flags = 0);

 
     /**
         Creates a new instance of the associated view class. If you have not supplied
 
     /**
         Creates a new instance of the associated view class. If you have not supplied


@@ -120,7 +104,7 @@ public:
         this
         function to return an appropriate view instance.
     */
         this
         function to return an appropriate view instance.
     */

-    wxView * CreateView(wxDocument * doc, long flags = 0);
+    wxView* CreateView(wxDocument* doc, long flags = 0);

 
     /**
         Returns the default file extension for the document data, as passed to the
 
     /**
         Returns the default file extension for the document data, as passed to the


@@ -143,7 +127,7 @@ public:
         Returns a pointer to the document manager instance for which this template was
         created.
     */
         Returns a pointer to the document manager instance for which this template was
         created.
     */

-    wxDocManager * GetDocumentManager();
+    wxDocManager* GetDocumentManager();

 
     /**
         Returns the document type name, as passed to the document template constructor.
 
     /**
         Returns the document type name, as passed to the document template constructor.


@@ -198,7 +182,7 @@ public:
         created.
         Should not be called by the application.
     */
         created.
         Should not be called by the application.
     */

-    void SetDocumentManager(wxDocManager * manager);
+    void SetDocumentManager(wxDocManager* manager);

 
     /**
         Sets the file filter.
 
     /**
         Sets the file filter.


@@ -213,28 +197,24 @@ public:
 
     /**
         wxString m_defaultExt
 
     /**
         wxString m_defaultExt

-        

         The default extension for files of this type.
     */
 
 
     /**
         wxString m_description
         The default extension for files of this type.
     */
 
 
     /**
         wxString m_description

-        

         A short description of this template.
     */
 
 
     /**
         wxString m_directory
         A short description of this template.
     */
 
 
     /**
         wxString m_directory

-        

         The default directory for files of this type.
     */
 
 
     /**
         wxClassInfo*  m_docClassInfo
         The default directory for files of this type.
     */
 
 
     /**
         wxClassInfo*  m_docClassInfo

-        

         Run-time class information that allows document instances to be constructed
         dynamically.
     */
         Run-time class information that allows document instances to be constructed
         dynamically.
     */


@@ -242,35 +222,30 @@ public:
 
     /**
         wxString m_docTypeName
 
     /**
         wxString m_docTypeName

-        

         The named type of the document associated with this template.
     */
 
 
     /**
         wxDocTemplate* m_documentManager
         The named type of the document associated with this template.
     */
 
 
     /**
         wxDocTemplate* m_documentManager

-        

         A pointer to the document manager for which this template was created.
     */
 
 
     /**
         wxString m_fileFilter
         A pointer to the document manager for which this template was created.
     */
 
 
     /**
         wxString m_fileFilter

-        

         The file filter (such as @c *.txt) to be used in file selector dialogs.
     */
 
 
     /**
         long m_flags
         The file filter (such as @c *.txt) to be used in file selector dialogs.
     */
 
 
     /**
         long m_flags

-        

         The flags passed to the constructor.
     */
 
 
     /**
         wxClassInfo* m_viewClassInfo
         The flags passed to the constructor.
     */
 
 
     /**
         wxClassInfo* m_viewClassInfo

-        

         Run-time class information that allows view instances to be constructed
         dynamically.
     */
         Run-time class information that allows view instances to be constructed
         dynamically.
     */


@@ -278,12 +253,12 @@ public:
 
     /**
         wxString m_viewTypeName
 
     /**
         wxString m_viewTypeName

-        

         The named type of the view associated with this template.
     */
 };
 
 
         The named type of the view associated with this template.
     */
 };
 
 

+

 /**
     @class wxDocManager
     @wxheader{docview.h}
 /**
     @class wxDocManager
     @wxheader{docview.h}


@@ -296,9 +271,8 @@ public:
     @library{wxcore}
     @category{dvf}
 
     @library{wxcore}
     @category{dvf}
 

-    @seealso
-    @ref overview_wxdocmanageroverview "wxDocManager overview", wxDocument, wxView,
-    wxDocTemplate, wxFileHistory
+    @see @ref overview_wxdocmanageroverview "wxDocManager overview", wxDocument,
+    wxView, wxDocTemplate, wxFileHistory

 */
 class wxDocManager : public wxEvtHandler
 {
 */
 class wxDocManager : public wxEvtHandler
 {


@@ -307,10 +281,8 @@ public:
         Constructor. Create a document manager instance dynamically near the start of
         your application
         before doing any document or view operations.
         Constructor. Create a document manager instance dynamically near the start of
         your application
         before doing any document or view operations.

-        
-        @e flags is currently unused.
-        
-        If @e initialize is @true, the Initialize() function will be called
+        @a flags is currently unused.
+        If @a initialize is @true, the Initialize() function will be called

         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 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,


@@ -318,7 +290,7 @@ public:
         your own Initialize or OnCreateFileHistory functions to be called.
     */
     wxDocManager(long flags = wxDEFAULT_DOCMAN_FLAGS,
         your own Initialize or OnCreateFileHistory functions to be called.
     */
     wxDocManager(long flags = wxDEFAULT_DOCMAN_FLAGS,

-                 bool initialize = @true);
+                 bool initialize = true);

 
     /**
         Destructor.
 
     /**
         Destructor.


@@ -328,12 +300,12 @@ public:
     /**
         Sets the current view.
     */
     /**
         Sets the current view.
     */

-    void ActivateView(wxView* doc, bool activate = @true);
+    void ActivateView(wxView* doc, bool activate = true);

 
     /**
         Adds the document to the list of documents.
     */
 
     /**
         Adds the document to the list of documents.
     */

-    void AddDocument(wxDocument * doc);
+    void AddDocument(wxDocument* doc);

 
     /**
         Adds a file to the file history list, if we have a pointer to an appropriate
 
     /**
         Adds a file to the file history list, if we have a pointer to an appropriate


@@ -344,20 +316,18 @@ public:
     /**
         Adds the template to the document manager's template list.
     */
     /**
         Adds the template to the document manager's template list.
     */

-    void AssociateTemplate(wxDocTemplate * temp);
+    void AssociateTemplate(wxDocTemplate* temp);

 
     /**
         Closes all currently opened documents.
     */
 
     /**
         Closes all currently opened documents.
     */

-    bool CloseDocuments(bool force = @true);
+    bool CloseDocuments(bool force = true);

 
     /**
 
     /**

-        Creates a new document in a manner determined by the @e flags parameter, which
+        Creates a new document in a manner determined by the @a flags parameter, which

         can be:
         can be:

-        

          wxDOC_NEW Creates a fresh document.
          wxDOC_SILENT Silently loads the given document file.
          wxDOC_NEW Creates a fresh document.
          wxDOC_SILENT Silently loads the given document file.

-        

         If wxDOC_NEW is present, a new document will be created and returned, possibly
         after
         asking the user for a template to use if there is more than one document
         If wxDOC_NEW is present, a new document will be created and returned, possibly
         after
         asking the user for a template to use if there is more than one document


@@ -368,7 +338,6 @@ public:
         a file selector for the file to load, and the template to use will be
         determined by the
         extension (Windows) or by popping up a template choice list (other platforms).
         a file selector for the file to load, and the template to use will be
         determined by the
         extension (Windows) or by popping up a template choice list (other platforms).

-        

         If the maximum number of documents has been reached, this function
         will delete the oldest currently loaded document before creating a new one.
     */
         If the maximum number of documents has been reached, this function
         will delete the oldest currently loaded document before creating a new one.
     */


@@ -386,7 +355,7 @@ public:
     /**
         Removes the template from the list of templates.
     */
     /**
         Removes the template from the list of templates.
     */

-    void DisassociateTemplate(wxDocTemplate * temp);
+    void DisassociateTemplate(wxDocTemplate* temp);

 
     //@{
     /**
 
     //@{
     /**


@@ -398,8 +367,8 @@ public:
 
     /**
         Loads the file history from a config object.
 
     /**
         Loads the file history from a config object.

-        
-        @sa wxConfig
+
+        @see wxConfig()

     */
     void FileHistoryLoad(wxConfigBase& config);
 
     */
     void FileHistoryLoad(wxConfigBase& config);
 


@@ -412,8 +381,8 @@ public:
     /**
         Saves the file history into a config object. This must be called
         explicitly by the application.
     /**
         Saves the file history into a config object. This must be called
         explicitly by the application.

-        
-        @sa wxConfig
+
+        @see wxConfig()

     */
     void FileHistorySave(wxConfigBase& resourceFile);
 
     */
     void FileHistorySave(wxConfigBase& resourceFile);
 


@@ -421,7 +390,6 @@ public:
         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.
     */
         Note that you can add multiple menus using this function, to be managed by the
         file history object.
     */


@@ -431,17 +399,17 @@ public:
         Given a path, try to find template that matches the extension. This is only
         an approximate method of finding a template for creating a document.
     */
         Given a path, try to find template that matches the extension. This is only
         an approximate method of finding a template for creating a document.
     */

-    wxDocTemplate * FindTemplateForPath(const wxString& path);
+    wxDocTemplate* FindTemplateForPath(const wxString& path);

 
     /**
         Returns the document associated with the currently active view (if any).
     */
 
     /**
         Returns the document associated with the currently active view (if any).
     */

-    wxDocument * GetCurrentDocument();
+    wxDocument* GetCurrentDocument();

 
     /**
         Returns the currently active view
     */
 
     /**
         Returns the currently active view
     */

-    wxView * GetCurrentView();
+    wxView* GetCurrentView();

 
     /**
         Returns a reference to the list of documents.
 
     /**
         Returns a reference to the list of documents.


@@ -451,7 +419,7 @@ public:
     /**
         Returns a pointer to file history.
     */
     /**
         Returns a pointer to file history.
     */

-    wxFileHistory * GetFileHistory();
+    wxFileHistory* GetFileHistory();

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


@@ -462,7 +430,7 @@ public:
         Returns the directory last selected by the user when opening a file. Initially
         empty.
     */
         Returns the directory last selected by the user when opening a file. Initially
         empty.
     */

-    wxString GetLastDirectory();
+    wxString GetLastDirectory() const;

 
     /**
         Returns the number of documents that can be open simultaneously.
 
     /**
         Returns the number of documents that can be open simultaneously.


@@ -484,7 +452,6 @@ public:
         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.
         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.

-        

         The bottom line: if you're not deriving from Initialize, forget it and
         construct wxDocManager with no arguments.
     */
         The bottom line: if you're not deriving from Initialize, forget it and
         construct wxDocManager with no arguments.
     */


@@ -503,7 +470,7 @@ public:
         Called
         from Initialize().
     */
         Called
         from Initialize().
     */

-    wxFileHistory * OnCreateFileHistory();
+    wxFileHistory* OnCreateFileHistory();

 
     /**
         Closes and deletes the currently active document.
 
     /**
         Closes and deletes the currently active document.


@@ -544,47 +511,43 @@ public:
     /**
         Removes the document from the list of documents.
     */
     /**
         Removes the document from the list of documents.
     */

-    void RemoveDocument(wxDocument * doc);
+    void RemoveDocument(wxDocument* doc);

 
     /**
         Under Windows, pops up a file selector with a list of filters corresponding to
         document templates.
         The wxDocTemplate corresponding to the selected file's extension is returned.
 
     /**
         Under Windows, pops up a file selector with a list of filters corresponding to
         document templates.
         The wxDocTemplate corresponding to the selected file's extension is returned.

-        

         On other platforms, if there is more than one document template a choice list
         is popped up,
         followed by a file selector.
         On other platforms, if there is more than one document template a choice list
         is popped up,
         followed by a file selector.

-        

         This function is used in CreateDocument().
         This function is used in CreateDocument().

-        

           (doctemplate, path) = My::DocManager-SelectDocumentPath( ... );
     */
           (doctemplate, path) = My::DocManager-SelectDocumentPath( ... );
     */

-    wxDocTemplate * SelectDocumentPath(wxDocTemplate ** templates,
-                                       int noTemplates,
-                                       wxString& path,
-                                       long flags,
-                                       bool save);
+    wxDocTemplate* SelectDocumentPath(wxDocTemplate** templates,
+                                      int noTemplates,
+                                      wxString& path,
+                                      long flags,
+                                      bool save);

 
     /**
         Returns a document template by asking the user (if there is more than one
         template).
         This function is used in CreateDocument().
 
     /**
         Returns a document template by asking the user (if there is more than one
         template).
         This function is used in CreateDocument().

-        
+

         @param templates
         @param templates

-        Pointer to an array of templates from which to choose a desired template.
-        
+            Pointer to an array of templates from which to choose a desired template.

         @param noTemplates
         @param noTemplates

-        Number of templates being pointed to by the templates pointer.
-        
+            Number of templates being pointed to by the templates pointer.

         @param sort
         @param sort

-        If more than one template is passed in in 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.
+            If more than one template is passed in in 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.

     */
     */

-    wxDocTemplate * SelectDocumentType(wxDocTemplate ** templates,
-                                       int noTemplates,
-                                       bool sort=@false);
+    wxDocTemplate* SelectDocumentType(wxDocTemplate** templates,
+                                      int noTemplates,
+                                      bool sort = false);

 
     /**
         Returns a document template by asking the user (if there is more than one
 
     /**
         Returns a document template by asking the user (if there is more than one


@@ -593,22 +556,21 @@ public:
         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.
         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.

-        
+

         @param templates
         @param templates

-        Pointer to an array of templates from which to choose a desired template.
-        
+            Pointer to an array of templates from which to choose a desired template.

         @param noTemplates
         @param noTemplates

-        Number of templates being pointed to by the templates pointer.
-        
+            Number of templates being pointed to by the templates pointer.

         @param sort
         @param sort

-        If more than one template is passed in in 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.
+            If more than one template is passed in in 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.

     */
     */

-    wxDocTemplate * SelectViewType(wxDocTemplate ** templates,
-                                   int noTemplates,
-                                   bool sort=@false);
+    wxDocTemplate* SelectViewType(wxDocTemplate** templates,
+                                  int noTemplates,
+                                  bool sort = false);

 
     /**
         Sets the directory to be displayed to the user when opening a file. Initially
 
     /**
         Sets the directory to be displayed to the user when opening a file. Initially


@@ -628,28 +590,24 @@ public:
 
     /**
         wxView* m_currentView
 
     /**
         wxView* m_currentView

-        

         The currently active view.
     */
 
 
     /**
         int m_defaultDocumentNameCounter
         The currently active view.
     */
 
 
     /**
         int m_defaultDocumentNameCounter

-        

         Stores the integer to be used for the next default document name.
     */
 
 
     /**
         wxList m_docs
         Stores the integer to be used for the next default document name.
     */
 
 
     /**
         wxList m_docs

-        

         A list of all documents.
     */
 
 
     /**
         wxFileHistory* m_fileHistory
         A list of all documents.
     */
 
 
     /**
         wxFileHistory* m_fileHistory

-        

         A pointer to an instance of wxFileHistory,
         which manages the history of recently-visited files on the File menu.
     */
         A pointer to an instance of wxFileHistory,
         which manages the history of recently-visited files on the File menu.
     */


@@ -657,27 +615,25 @@ public:
 
     /**
         long m_flags
 
     /**
         long m_flags

-        

         Stores the flags passed to the constructor.
     */
 
 
     /**
         The directory last selected by the user when opening a file.
         Stores the flags passed to the constructor.
     */
 
 
     /**
         The directory last selected by the user when opening a file.

-        

         wxFileHistory* m_fileHistory
     */
 
 
     /**
         int m_maxDocsOpen
         wxFileHistory* m_fileHistory
     */
 
 
     /**
         int m_maxDocsOpen

-        

         Stores the maximum number of documents that can be opened before
         existing documents are closed. By default, this is 10,000.
     */
 };
 
 
         Stores the maximum number of documents that can be opened before
         existing documents are closed. By default, this is 10,000.
     */
 };
 
 

+

 /**
     @class wxView
     @wxheader{docview.h}
 /**
     @class wxView
     @wxheader{docview.h}


@@ -691,8 +647,7 @@ public:
     @library{wxcore}
     @category{dvf}
 
     @library{wxcore}
     @category{dvf}
 

-    @seealso
-    @ref overview_wxviewoverview "wxView overview", wxDocument, wxDocTemplate,
+    @see @ref overview_wxviewoverview "wxView overview", wxDocument, wxDocTemplate,

     wxDocManager
 */
 class wxView : public wxEvtHandler
     wxDocManager
 */
 class wxView : public wxEvtHandler


@@ -717,53 +672,51 @@ public:
         need to
         call this function from any place where you know the view must
         be active, and the framework will need to get the current view.
         need to
         call this function from any place where you know the view must
         be active, and the framework will need to get the current view.

-        

         The prepackaged view frame wxDocChildFrame calls Activate() from its OnActivate
         member.
         The prepackaged view frame wxDocChildFrame calls Activate() from its OnActivate
         member.

-        

         This function calls OnActivateView().
     */
     virtual void Activate(bool activate);
 
     /**
         This function calls OnActivateView().
     */
     virtual void Activate(bool activate);
 
     /**

-        Closes the view by calling OnClose. If @e deleteWindow is @true, this function
+        Closes the view by calling OnClose. If @a deleteWindow is @true, this function

         should
         delete the window associated with the view.
     */
         should
         delete the window associated with the view.
     */

-    virtual bool Close(bool deleteWindow = @true);
+    virtual bool Close(bool deleteWindow = true);

 
     /**
         Gets a pointer to the document associated with the view.
     */
 
     /**
         Gets a pointer to the document associated with the view.
     */

-    wxDocument* GetDocument();
+    wxDocument* GetDocument() const;

 
     /**
         Returns a pointer to the document manager instance associated with this view.
     */
 
     /**
         Returns a pointer to the document manager instance associated with this view.
     */

-    wxDocManager* GetDocumentManager();
+    wxDocManager* GetDocumentManager() const;

 
     /**
 
     /**

-        Gets the frame associated with the view (if any). Note that this "frame'' is
+        Gets the frame associated with the view (if any). Note that this "frame" is

         not a wxFrame at all in the generic MDI implementation which uses the notebook
         pages instead of the frames and this is why this method returns a wxWindow and
         not a wxFrame.
     */
         not a wxFrame at all in the generic MDI implementation which uses the notebook
         pages instead of the frames and this is why this method returns a wxWindow and
         not a wxFrame.
     */

-    wxWindow * GetFrame();
+    wxWindow* GetFrame();

 
     /**
         Gets the name associated with the view (passed to the wxDocTemplate
         constructor).
         Not currently used by the framework.
     */
 
     /**
         Gets the name associated with the view (passed to the wxDocTemplate
         constructor).
         Not currently used by the framework.
     */

-    wxString GetViewName();
+    wxString GetViewName() const;

 
     /**
         Called when a view is activated by means of Activate(). The default
         implementation does
         nothing.
     */
 
     /**
         Called when a view is activated by means of Activate(). The default
         implementation does
         nothing.
     */

-    virtual void OnActivateView(bool activate, wxView * activeView,
-                                wxView * deactiveView);
+    virtual void OnActivateView(bool activate, wxView* activeView,
+                                wxView* deactiveView);

 
     /**
         Called when the filename has changed. The default implementation constructs a
 
     /**
         Called when the filename has changed. The default implementation constructs a


@@ -777,7 +730,7 @@ public:
         may wish to do some cleaning up operations in this function, @e if a
         call to wxDocument::Close succeeded. For example, if your views
         all share the same window, you need to disassociate the window from the view
         may wish to do some cleaning up operations in this function, @e if a
         call to wxDocument::Close succeeded. For example, if your views
         all share the same window, you need to disassociate the window from the view

-        and perhaps clear the window. If @e deleteWindow is @true, delete the
+        and perhaps clear the window. If @a deleteWindow is @true, delete the

         frame associated with the view.
     */
     virtual bool OnClose(bool deleteWindow);
         frame associated with the view.
     */
     virtual bool OnClose(bool deleteWindow);


@@ -795,7 +748,6 @@ public:
         wxDocChildFrame
         or a derived class. This wxDocChildFrame provides user interface
         elements to view and/or edit the contents of the wxDocument.
         wxDocChildFrame
         or a derived class. This wxDocChildFrame provides user interface
         elements to view and/or edit the contents of the wxDocument.

-        

         By default, simply returns @true. If the function returns @false, the
         view will be deleted.
     */
         By default, simply returns @true. If the function returns @false, the
         view will be deleted.
     */


@@ -805,10 +757,8 @@ public:
         If the printing framework is enabled in the library, this function returns a
         wxPrintout object for the purposes of printing. It should create a new object
         every time it is called; the framework will delete objects it creates.
         If the printing framework is enabled in the library, this function returns a
         wxPrintout object for the purposes of printing. It should create a new object
         every time it is called; the framework will delete objects it creates.

-        

         By default, this function returns an instance of wxDocPrintout, which prints
         and previews one page by calling OnDraw().
         By default, this function returns an instance of wxDocPrintout, which prints
         and previews one page by calling OnDraw().

-        

         Override to return an instance of a class other than wxDocPrintout.
     */
     virtual wxPrintout* OnCreatePrintout();
         Override to return an instance of a class other than wxDocPrintout.
     */
     virtual wxPrintout* OnCreatePrintout();


@@ -819,10 +769,10 @@ public:
     virtual void OnDraw(wxDC* dc);
 
     /**
     virtual void OnDraw(wxDC* dc);
 
     /**

-        Called when the view should be updated. @e sender is a pointer to the view
+        Called when the view should be updated. @a sender is a pointer to the view

         that sent the update request, or @NULL if no single view requested the update
         (for instance,
         that sent the update request, or @NULL if no single view requested the update
         (for instance,

-        when the document is opened). @e hint is as yet unused but may in future contain
+        when the document is opened). @a hint is as yet unused but may in future contain

         application-specific information for making updating more efficient.
     */
     virtual void OnUpdate(wxView* sender, wxObject* hint);
         application-specific information for making updating more efficient.
     */
     virtual void OnUpdate(wxView* sender, wxObject* hint);


@@ -836,9 +786,8 @@ public:
     /**
         Sets the frame associated with this view. The application should call this
         if possible, to tell the view about the frame.
     /**
         Sets the frame associated with this view. The application should call this
         if possible, to tell the view about the frame.

-        

         See GetFrame() for the explanation about the mismatch
         See GetFrame() for the explanation about the mismatch

-        between the "Frame'' in the method name and the type of its parameter.
+        between the "Frame" in the method name and the type of its parameter.

     */
     void SetFrame(wxWindow* frame);
 
     */
     void SetFrame(wxWindow* frame);
 


@@ -849,7 +798,6 @@ public:
 
     /**
         wxDocument* m_viewDocument
 
     /**
         wxDocument* m_viewDocument

-        

         The document associated with this view. There may be more than one view per
         document, but there can never be more than one document for one view.
     */
         The document associated with this view. There may be more than one view per
         document, but there can never be more than one document for one view.
     */


@@ -857,20 +805,19 @@ public:
 
     /**
         wxFrame* m_viewFrame
 
     /**
         wxFrame* m_viewFrame

-        

         Frame associated with the view, if any.
     */
 
 
     /**
         wxString m_viewTypeName
         Frame associated with the view, if any.
     */
 
 
     /**
         wxString m_viewTypeName

-        

         The view type name given to the wxDocTemplate constructor, copied to this
         variable when the view is created. Not currently used by the framework.
     */
 };
 
 
         The view type name given to the wxDocTemplate constructor, copied to this
         variable when the view is created. Not currently used by the framework.
     */
 };
 
 

+

 /**
     @class wxDocChildFrame
     @wxheader{docview.h}
 /**
     @class wxDocChildFrame
     @wxheader{docview.h}


@@ -887,8 +834,7 @@ public:
     @library{wxcore}
     @category{dvf}
 
     @library{wxcore}
     @category{dvf}
 

-    @seealso
-    @ref overview_docviewoverview "Document/view overview", wxFrame
+    @see @ref overview_docviewoverview, wxFrame

 */
 class wxDocChildFrame : public wxFrame
 {
 */
 class wxDocChildFrame : public wxFrame
 {


@@ -912,12 +858,12 @@ public:
     /**
         Returns the document associated with this frame.
     */
     /**
         Returns the document associated with this frame.
     */

-    wxDocument* GetDocument();
+    wxDocument* GetDocument() const;

 
     /**
         Returns the view associated with this frame.
     */
 
     /**
         Returns the view associated with this frame.
     */

-    wxView* GetView();
+    wxView* GetView() const;

 
     /**
         Sets the currently active view to be the frame's view. You may need
 
     /**
         Sets the currently active view to be the frame's view. You may need


@@ -934,28 +880,27 @@ public:
     /**
         Sets the document for this frame.
     */
     /**
         Sets the document for this frame.
     */

-    void SetDocument(wxDocument * doc);
+    void SetDocument(wxDocument* doc);

 
     /**
         Sets the view for this frame.
     */
 
     /**
         Sets the view for this frame.
     */

-    void SetView(wxView * view);
+    void SetView(wxView* view);

 
     /**
         wxDocument* m_childDocument
 
     /**
         wxDocument* m_childDocument

-        

         The document associated with the frame.
     */
 
 
     /**
         wxView* m_childView
         The document associated with the frame.
     */
 
 
     /**
         wxView* m_childView

-        

         The view associated with the frame.
     */
 };
 
 
         The view associated with the frame.
     */
 };
 
 

+

 /**
     @class wxDocParentFrame
     @wxheader{docview.h}
 /**
     @class wxDocParentFrame
     @wxheader{docview.h}


@@ -965,15 +910,14 @@ public:
     SDI (not MDI) parent frames.
 
     It cooperates with the wxView, wxDocument,
     SDI (not MDI) parent frames.
 
     It cooperates with the wxView, wxDocument,

-    wxDocManager and wxDocTemplates classes.
+    wxDocManager and wxDocTemplates() classes.

 
     See the example application in @c samples/docview.
 
     @library{wxcore}
     @category{dvf}
 
 
     See the example application in @c samples/docview.
 
     @library{wxcore}
     @category{dvf}
 

-    @seealso
-    @ref overview_docviewoverview "Document/view overview", wxFrame
+    @see @ref overview_docviewoverview, wxFrame

 */
 class wxDocParentFrame : public wxFrame
 {
 */
 class wxDocParentFrame : public wxFrame
 {


@@ -983,7 +927,7 @@ public:
         Constructor.
     */
     wxDocParentFrame();
         Constructor.
     */
     wxDocParentFrame();

-    wxDocParentFrame(wxDocManager* manager, wxFrame * parent,
+    wxDocParentFrame(wxDocManager* manager, wxFrame* parent,

                      wxWindowID id,
                      const wxString& title,
                      const wxPoint& pos = wxDefaultPosition,
                      wxWindowID id,
                      const wxString& title,
                      const wxPoint& pos = wxDefaultPosition,


@@ -1000,7 +944,7 @@ public:
     /**
         Used in two-step construction.
     */
     /**
         Used in two-step construction.
     */

-    bool Create(wxDocManager* manager, wxFrame * parent,
+    bool Create(wxDocManager* manager, wxFrame* parent,

                 wxWindowID id, const wxString& title,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 wxWindowID id, const wxString& title,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,


@@ -1010,12 +954,11 @@ public:
     /**
         Returns the associated @ref overview_wxdocmanager "document manager object".
     */
     /**
         Returns the associated @ref overview_wxdocmanager "document manager object".
     */

-    wxDocManager * GetDocumentManager();
+    wxDocManager* GetDocumentManager() const;

 
     /**
         Deletes all views and documents. If no user input cancelled the
         operation, the frame will be destroyed and the application will exit.
 
     /**
         Deletes all views and documents. If no user input cancelled the
         operation, the frame will be destroyed and the application will exit.

-        

         Since understanding how document/view clean-up takes place can be difficult,
         the implementation of this function is shown below.
     */
         Since understanding how document/view clean-up takes place can be difficult,
         the implementation of this function is shown below.
     */


@@ -1023,6 +966,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxDocument
     @wxheader{docview.h}
 /**
     @class wxDocument
     @wxheader{docview.h}


@@ -1035,9 +979,8 @@ public:
     @library{wxcore}
     @category{dvf}
 
     @library{wxcore}
     @category{dvf}
 

-    @seealso
-    @ref overview_wxdocumentoverview "wxDocument overview", wxView, wxDocTemplate,
-    wxDocManager
+    @see @ref overview_wxdocumentoverview "wxDocument overview", wxView,
+    wxDocTemplate, wxDocManager

 */
 class wxDocument : public wxEvtHandler
 {
 */
 class wxDocument : public wxEvtHandler
 {


@@ -1058,7 +1001,7 @@ public:
         If the view is not already in the list of views, adds the view and calls
         OnChangedViewList.
     */
         If the view is not already in the list of views, adds the view and calls
         OnChangedViewList.
     */

-    virtual bool AddView(wxView * view);
+    virtual bool AddView(wxView* view);

 
     /**
         Closes the document, by calling OnSaveModified and then (if this returned @true)
 
     /**
         Closes the document, by calling OnSaveModified and then (if this returned @true)


@@ -1079,67 +1022,64 @@ public:
 
     /**
         Returns a pointer to the command processor associated with this document.
 
     /**
         Returns a pointer to the command processor associated with this document.

-        

         See wxCommandProcessor.
     */
         See wxCommandProcessor.
     */

-    wxCommandProcessor* GetCommandProcessor();
+    wxCommandProcessor* GetCommandProcessor() const;

 
     /**
         Gets a pointer to the associated document manager.
     */
 
     /**
         Gets a pointer to the associated document manager.
     */

-    wxDocManager* GetDocumentManager();
+    wxDocManager* GetDocumentManager() const;

 
     /**
         Gets the document type name for this document. See the comment for
 
     /**
         Gets the document type name for this document. See the comment for

-        documentTypeName.
+        documentTypeName().

     */
     */

-    wxString GetDocumentName();
+    wxString GetDocumentName() const;

 
     /**
         Gets a pointer to the template that created the document.
     */
 
     /**
         Gets a pointer to the template that created the document.
     */

-    wxDocTemplate* GetDocumentTemplate();
+    wxDocTemplate* GetDocumentTemplate() const;

 
     /**
         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.
     */
 
     /**
         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.
     */

-    wxWindow* GetDocumentWindow();
+    wxWindow* GetDocumentWindow() const;

 
     /**
         Gets the filename associated with this document, or "" if none is
         associated.
     */
 
     /**
         Gets the filename associated with this document, or "" if none is
         associated.
     */

-    wxString GetFilename();
+    wxString GetFilename() const;

 
     /**
         A convenience function to get the first view for a document, because
         in many cases a document will only have a single view.
 
     /**
         A convenience function to get the first view for a document, because
         in many cases a document will only have a single view.

-        

         See also: GetViews()
     */
         See also: GetViews()
     */

-    wxView * GetFirstView();
+    wxView* GetFirstView() const;

 
     /**
         Gets the title for this document. The document title is used for an associated
         frame (if any), and is usually constructed by the framework from
         the filename.
     */
 
     /**
         Gets the title for this document. The document title is used for an associated
         frame (if any), and is usually constructed by the framework from
         the filename.
     */

-    wxString GetTitle();
+    wxString GetTitle() const;

 
     /**
         Return the document name suitable to be shown to the user. The default
         implementation uses the document title, if any, of the name part of the
         document filename if it was set or, otherwise, the string @b unnamed.
     */
 
     /**
         Return the document name suitable to be shown to the user. The default
         implementation uses the document title, if any, of the name part of the
         document filename if it was set or, otherwise, the string @b unnamed.
     */

-    virtual wxString GetUserReadableName();
+    virtual wxString GetUserReadableName() const;

 
     /**
         Returns the list whose elements are the views on the document.
 
     /**
         Returns the list whose elements are the views on the document.

-        

         See also: GetFirstView()
     */
         See also: GetFirstView()
     */

-    wxList GetViews();
+    wxList GetViews() const;

 
     /**
         Returns @true if the document has been modified since the last save, @false
 
     /**
         Returns @true if the document has been modified since the last save, @false


@@ -1147,17 +1087,15 @@ public:
         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).
         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 Modify().
     */
         See also Modify().
     */

-    virtual bool IsModified();
+    virtual bool IsModified() const;

 
     //@{
     /**
         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.
 
     //@{
     /**
         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.

-        

         Note that only one of these forms exists, depending on how wxWidgets
         was configured.
     */
         Note that only one of these forms exists, depending on how wxWidgets
         was configured.
     */


@@ -1171,7 +1109,6 @@ public:
         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).
         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 IsModified().
     */
     virtual void Modify(bool modify);
         See also IsModified().
     */
     virtual void Modify(bool modify);


@@ -1202,7 +1139,6 @@ public:
         Override this function if you want a different (or no) command processor
         to be created when the document is created. By default, it returns
         an instance of wxCommandProcessor.
         Override this function if you want a different (or no) command processor
         to be created when the document is created. By default, it returns
         an instance of wxCommandProcessor.

-        

         See wxCommandProcessor.
     */
     virtual wxCommandProcessor* OnCreateCommandProcessor();
         See wxCommandProcessor.
     */
     virtual wxCommandProcessor* OnCreateCommandProcessor();


@@ -1262,7 +1198,6 @@ public:
         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.
         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.

-        

         Note that only one of these forms exists, depending on how wxWidgets
         was configured.
     */
         Note that only one of these forms exists, depending on how wxWidgets
         was configured.
     */


@@ -1276,14 +1211,13 @@ public:
         for its deletion. Normally you should not call this; override
         OnCreateCommandProcessor
         instead.
         for its deletion. Normally you should not call this; override
         OnCreateCommandProcessor
         instead.

-        

         See wxCommandProcessor.
     */
         See wxCommandProcessor.
     */

-    virtual void SetCommandProcessor(wxCommandProcessor * processor);
+    virtual void SetCommandProcessor(wxCommandProcessor* processor);

 
     /**
         Sets the document type name for this document. See the comment for
 
     /**
         Sets the document type name for this document. See the comment for

-        documentTypeName.
+        documentTypeName().

     */
     void SetDocumentName(const wxString& name);
 
     */
     void SetDocumentName(const wxString& name);
 


@@ -1296,11 +1230,10 @@ public:
 
     /**
         Sets the filename for this document. Usually called by the framework.
 
     /**
         Sets the filename for this document. Usually called by the framework.

-        
-        If @e notifyViews is @true, wxView::OnChangeFilename is called for all views.
+        If @a notifyViews is @true, wxView::OnChangeFilename is called for all views.

     */
     void SetFilename(const wxString& filename,
     */
     void SetFilename(const wxString& filename,

-                     bool notifyViews = @false);
+                     bool notifyViews = false);

 
     /**
         Sets the title for this document. The document title is used for an associated
 
     /**
         Sets the title for this document. The document title is used for an associated


@@ -1310,43 +1243,59 @@ public:
     void SetTitle(const wxString& title);
 
     /**
     void SetTitle(const wxString& title);
 
     /**

-        Updates all views. If @e sender is non-@NULL, does not update this view.
-        
-        @e hint represents optional information to allow a view to optimize its update.
+        Updates all views. If @a sender is non-@NULL, does not update this view.
+        @a hint represents optional information to allow a view to optimize its update.

     */
     */

-    void UpdateAllViews(wxView* sender = @NULL, wxObject* hint = @NULL);
+    void UpdateAllViews(wxView* sender = NULL, wxObject* hint = NULL);
+
+protected:
+    /**
+        This method is called by OnSaveDocument() to really save the document
+        contents to the specified file.
+
+        Base class version creates a file-based stream and calls SaveObject().
+        Override this if you need to do something else or prefer not to use
+        SaveObject() at all.
+     */
+    virtual bool DoSaveDocument(const wxString& file);
+
+    /**
+        This method is called by OnOpenDocument() to really load the document
+        contents from the specified file.
+
+        Base class version creates a file-based stream and calls LoadObject().
+        Override this if you need to do something else or prefer not to use
+        LoadObject() at all.
+     */
+    virtual bool DoOpenDocument(const wxString& file);
+

 
     /**
         wxCommandProcessor* m_commandProcessor
 
     /**
         wxCommandProcessor* m_commandProcessor

-        

         A pointer to the command processor associated with this document.
     */
 
 
     /**
         wxString m_documentFile
         A pointer to the command processor associated with this document.
     */
 
 
     /**
         wxString m_documentFile

-        

         Filename associated with this document ("" if none).
     */
 
 
     /**
         bool m_documentModified
         Filename associated with this document ("" if none).
     */
 
 
     /**
         bool m_documentModified

-        

         @true if the document has been modified, @false otherwise.
     */
 
 
     /**
         wxDocTemplate * m_documentTemplate
         @true if the document has been modified, @false otherwise.
     */
 
 
     /**
         wxDocTemplate * m_documentTemplate

-        

         A pointer to the template from which this document was created.
     */
 
 
     /**
         wxString m_documentTitle
         A pointer to the template from which this document was created.
     */
 
 
     /**
         wxString m_documentTitle

-        

         Document title. The document title is used for an associated
         frame (if any), and is usually constructed by the framework from
         the filename.
         Document title. The document title is used for an associated
         frame (if any), and is usually constructed by the framework from
         the filename.


@@ -1355,7 +1304,6 @@ public:
 
     /**
         wxString m_documentTypeName
 
     /**
         wxString m_documentTypeName

-        

         The document type name given to the wxDocTemplate constructor, copied to this
         variable when the document is created. If several document templates are
         created that use the same document type, this variable is used in
         The document type name given to the wxDocTemplate constructor, copied to this
         variable when the document is created. If several document templates are
         created that use the same document type, this variable is used in


@@ -1367,12 +1315,12 @@ public:
 
     /**
         wxList m_documentViews
 
     /**
         wxList m_documentViews

-        

         List of wxView instances associated with this document.
     */
 };
 
 
         List of wxView instances associated with this document.
     */
 };
 
 

+

 /**
     @class wxFileHistory
     @wxheader{docview.h}
 /**
     @class wxFileHistory
     @wxheader{docview.h}


@@ -1389,8 +1337,7 @@ public:
     @library{wxcore}
     @category{FIXME}
 
     @library{wxcore}
     @category{FIXME}
 

-    @seealso
-    @ref overview_wxfilehistoryoverview "wxFileHistory overview", wxDocManager
+    @see @ref overview_wxfilehistoryoverview "wxFileHistory overview", wxDocManager

 */
 class wxFileHistory : public wxObject
 {
 */
 class wxFileHistory : public wxObject
 {


@@ -1398,8 +1345,7 @@ public:
     /**
         Constructor. Pass the maximum number of files that should be stored and
         displayed.
     /**
         Constructor. Pass the maximum number of files that should be stored and
         displayed.

-        
-        @e idBase defaults to wxID_FILE1 and represents the id given to the first
+        @a idBase defaults to wxID_FILE1 and represents the id given to the first

         history menu item.  Since menu items can't share the same ID you should change
         idBase (To one of your own defined IDs) when using more than one wxFileHistory
         in your application.
         history menu item.  Since menu items can't share the same ID you should change
         idBase (To one of your own defined IDs) when using more than one wxFileHistory
         in your application.


@@ -1429,35 +1375,35 @@ public:
     /**
         Returns the base identifier for the range used for appending items.
     */
     /**
         Returns the base identifier for the range used for appending items.
     */

-    wxWindowID GetBaseId();
+    wxWindowID GetBaseId() const;

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

-    size_t GetCount();
+    size_t GetCount() const;

 
     /**
         Returns the file at this index (zero-based).
     */
 
     /**
         Returns the file at this index (zero-based).
     */

-    wxString GetHistoryFile(size_t index);
+    wxString GetHistoryFile(size_t index) const;

 
     /**
         Returns the maximum number of files that can be stored.
     */
 
     /**
         Returns the maximum number of files that can be stored.
     */

-    int GetMaxFiles();
+    int GetMaxFiles() const;

 
     /**
         Returns the list of menus that are managed by this file history object.
 
     /**
         Returns the list of menus that are managed by this file history object.

-        
-        @sa UseMenu()
+
+        @see UseMenu()

     */
     */

-    const wxList GetMenus();
+    const wxList GetMenus() const;

 
     /**
         Loads the file history from the given config object. This function should be
         called explicitly by the application.
 
     /**
         Loads the file history from the given config object. This function should be
         called explicitly by the application.

-        
-        @sa wxConfig
+
+        @see wxConfig()

     */
     void Load(wxConfigBase& config);
 
     */
     void Load(wxConfigBase& config);
 


@@ -1474,8 +1420,8 @@ public:
     /**
         Saves the file history into the given config object. This must be called
         explicitly by the application.
     /**
         Saves the file history into the given config object. This must be called
         explicitly by the application.

-        
-        @sa wxConfig
+
+        @see wxConfig()

     */
     void Save(wxConfigBase& config);
 
     */
     void Save(wxConfigBase& config);
 


@@ -1495,7 +1441,6 @@ public:
 
     /**
         char** m_fileHistory
 
     /**
         char** m_fileHistory

-        

         A character array of strings corresponding to the most recently opened
         files.
     */
         A character array of strings corresponding to the most recently opened
         files.
     */


@@ -1503,34 +1448,50 @@ public:
 
     /**
         size_t m_fileHistoryN
 
     /**
         size_t m_fileHistoryN

-        

         The number of files stored in the history array.
     */
 
 
     /**
         size_t m_fileMaxFiles
         The number of files stored in the history array.
     */
 
 
     /**
         size_t m_fileMaxFiles

-        

         The maximum number of files to be stored and displayed on the menu.
     */
 
 
     /**
         wxMenu* m_fileMenu
         The maximum number of files to be stored and displayed on the menu.
     */
 
 
     /**
         wxMenu* m_fileMenu

-        

         The file menu used to display the file history list (if enabled).
     */
 };
 
 
         The file menu used to display the file history list (if enabled).
     */
 };
 
 

+

 // ============================================================================
 // Global functions/macros
 // ============================================================================
 
 // ============================================================================
 // Global functions/macros
 // ============================================================================
 

+/** @ingroup group_funcmacro_file */
+//@{
+

 /**
 /**

-    Copies the given file to @e stream. Useful when converting an old application to
-    use streams (within the document/view framework, for example).
+    Copies the given file to @a stream. Useful when converting an old
+    application to use streams (within the document/view framework, for
+    example).
+
+    @header{wx/docview.h}

 */
 bool wxTransferFileToStream(const wxString& filename,
                             ostream& stream);
 
 */
 bool wxTransferFileToStream(const wxString& filename,
                             ostream& stream);
 

+/**
+    Copies the given stream to the file @a filename. Useful when converting an
+    old application to use streams (within the document/view framework, for
+    example).
+
+    @header{wx/docview.h}
+*/
+bool wxTransferStreamToFile(istream& stream,
+                             const wxString& filename);
+
+//@}
+