revision contributed by Utensil Candel

[wxWidgets.git] / interface / docview.h

diff --git a/interface/docview.h b/interface/docview.h
index b8b9e66d4db9ca822b6e803c3355ea0f09ee0c07..c7c8334f166d995c57f8b5a69338597070004d8c 100644 (file)
--- a/interface/docview.h
+++ b/interface/docview.h
@@ -52,23 +52,23 @@ public:
          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
         )
-        
+
          will construct document and view objects from the class information
-        
+
         @b Wx::DocTemplate-new( docmgr, descr, filter, dir,
         ext, docTypeName, viewTypeName, docClassName, viewClassName, flags
         )
-        
+
          will construct document and view objects from perl packages
-        
+
         @b Wx::DocTemplate-new( docmgr, descr, filter, dir,
         ext, docTypeName, viewTypeName )
-        
+
         @c Wx::DocTemplate::CreateDocument() and
         @c Wx::DocTemplate::CreateView() must be overridden
     */
@@ -367,7 +367,7 @@ public:
 
     /**
         Loads the file history from a config object.
-        
+
         @see wxConfig()
     */
     void FileHistoryLoad(wxConfigBase& config);
@@ -381,7 +381,7 @@ public:
     /**
         Saves the file history into a config object. This must be called
         explicitly by the application.
-        
+
         @see wxConfig()
     */
     void FileHistorySave(wxConfigBase& resourceFile);
@@ -533,7 +533,7 @@ public:
         Returns a document template by asking the user (if there is more than one
         template).
         This function is used in CreateDocument().
-        
+
         @param templates
             Pointer to an array of templates from which to choose a desired template.
         @param noTemplates
@@ -542,7 +542,7 @@ public:
             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,
@@ -556,7 +556,7 @@ 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.
-        
+
         @param templates
             Pointer to an array of templates from which to choose a desired template.
         @param noTemplates
@@ -565,7 +565,7 @@ public:
             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,
@@ -1248,6 +1248,28 @@ public:
     */
     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
         A pointer to the command processor associated with this document.
@@ -1372,7 +1394,7 @@ public:
 
     /**
         Returns the list of menus that are managed by this file history object.
-        
+
         @see UseMenu()
     */
     const wxList GetMenus() const;
@@ -1380,7 +1402,7 @@ public:
     /**
         Loads the file history from the given config object. This function should be
         called explicitly by the application.
-        
+
         @see wxConfig()
     */
     void Load(wxConfigBase& config);
@@ -1398,7 +1420,7 @@ public:
     /**
         Saves the file history into the given config object. This must be called
         explicitly by the application.
-        
+
         @see wxConfig()
     */
     void Save(wxConfigBase& config);
@@ -1448,10 +1470,28 @@ public:
 // 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);
 
+/**
+    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);
+
+//@}
+