Support using GetTextExtent() with empty string to get descent in wxOSX.

[wxWidgets.git] / include / wx / docview.h

diff --git a/include/wx/docview.h b/include/wx/docview.h
index beac80fc73d025d14e9ceeb4f318c61d0655c8e3..c8b034721501de66a2b0b7f8e143b9588f8d54ae 100644 (file)
--- a/include/wx/docview.h
+++ b/include/wx/docview.h
@@ -17,8 +17,11 @@
 #if wxUSE_DOC_VIEW_ARCHITECTURE
 
 #include "wx/list.h"
 #if wxUSE_DOC_VIEW_ARCHITECTURE
 
 #include "wx/list.h"

+#include "wx/dlist.h"

 #include "wx/string.h"
 #include "wx/frame.h"
 #include "wx/string.h"
 #include "wx/frame.h"

+#include "wx/filehistory.h"
+#include "wx/vector.h"

 
 #if wxUSE_PRINTING_ARCHITECTURE
     #include "wx/print.h"
 
 #if wxUSE_PRINTING_ARCHITECTURE
     #include "wx/print.h"


@@ -31,9 +34,10 @@ class WXDLLIMPEXP_FWD_CORE wxDocTemplate;
 class WXDLLIMPEXP_FWD_CORE wxDocManager;
 class WXDLLIMPEXP_FWD_CORE wxPrintInfo;
 class WXDLLIMPEXP_FWD_CORE wxCommandProcessor;
 class WXDLLIMPEXP_FWD_CORE wxDocManager;
 class WXDLLIMPEXP_FWD_CORE wxPrintInfo;
 class WXDLLIMPEXP_FWD_CORE wxCommandProcessor;

-class WXDLLIMPEXP_FWD_CORE wxFileHistory;

 class WXDLLIMPEXP_FWD_BASE wxConfigBase;
 
 class WXDLLIMPEXP_FWD_BASE wxConfigBase;
 

+class wxDocChildFrameAnyBase;
+

 #if wxUSE_STD_IOSTREAM
   #include "wx/iosfwrap.h"
 #else
 #if wxUSE_STD_IOSTREAM
   #include "wx/iosfwrap.h"
 #else


@@ -51,12 +55,16 @@ enum
 enum
 {
     wxTEMPLATE_VISIBLE = 1,
 enum
 {
     wxTEMPLATE_VISIBLE = 1,

-    wxTEMPLATE_INVISIBLE,
+    wxTEMPLATE_INVISIBLE = 2,

     wxDEFAULT_TEMPLATE_FLAGS = wxTEMPLATE_VISIBLE
 };
 
 #define wxMAX_FILE_HISTORY 9
 
     wxDEFAULT_TEMPLATE_FLAGS = wxTEMPLATE_VISIBLE
 };
 
 #define wxMAX_FILE_HISTORY 9
 

+typedef wxVector<wxDocument*> wxDocVector;
+typedef wxVector<wxView*> wxViewVector;
+typedef wxVector<wxDocTemplate*> wxDocTemplateVector;
+

 class WXDLLIMPEXP_CORE wxDocument : public wxEvtHandler
 {
 public:
 class WXDLLIMPEXP_CORE wxDocument : public wxEvtHandler
 {
 public:


@@ -73,9 +81,19 @@ public:
     void SetDocumentName(const wxString& name) { m_documentTypeName = name; }
     wxString GetDocumentName() const { return m_documentTypeName; }
 
     void SetDocumentName(const wxString& name) { m_documentTypeName = name; }
     wxString GetDocumentName() const { return m_documentTypeName; }
 

+    // access the flag indicating whether this document had been already saved,
+    // SetDocumentSaved() is only used internally, don't call it

     bool GetDocumentSaved() const { return m_savedYet; }
     void SetDocumentSaved(bool saved = true) { m_savedYet = saved; }
 
     bool GetDocumentSaved() const { return m_savedYet; }
     void SetDocumentSaved(bool saved = true) { m_savedYet = saved; }
 

+    // activate the first view of the document if any
+    void Activate();
+
+    // return true if the document hasn't been modified since the last time it
+    // was saved (implying that it returns false if it was never saved, even if
+    // the document is not modified)
+    bool AlreadySaved() const { return !IsModified() && GetDocumentSaved(); }
+

     virtual bool Close();
     virtual bool Save();
     virtual bool SaveAs();
     virtual bool Close();
     virtual bool Save();
     virtual bool SaveAs();


@@ -100,6 +118,10 @@ public:
     // modified to false)
     virtual bool OnSaveModified();
 
     // modified to false)
     virtual bool OnSaveModified();
 

+    // if you override, remember to call the default
+    // implementation (wxDocument::OnChangeFilename)
+    virtual void OnChangeFilename(bool notifyViews);
+

     // Called by framework if created automatically by the default document
     // manager: gives document a chance to initialise and (usually) create a
     // view
     // Called by framework if created automatically by the default document
     // manager: gives document a chance to initialise and (usually) create a
     // view


@@ -107,23 +129,33 @@ public:
 
     // By default, creates a base wxCommandProcessor.
     virtual wxCommandProcessor *OnCreateCommandProcessor();
 
     // By default, creates a base wxCommandProcessor.
     virtual wxCommandProcessor *OnCreateCommandProcessor();

-    virtual wxCommandProcessor *GetCommandProcessor() const { return m_commandProcessor; }
-    virtual void SetCommandProcessor(wxCommandProcessor *proc) { m_commandProcessor = proc; }
+    virtual wxCommandProcessor *GetCommandProcessor() const
+        { return m_commandProcessor; }
+    virtual void SetCommandProcessor(wxCommandProcessor *proc)
+        { m_commandProcessor = proc; }

 
     // Called after a view is added or removed. The default implementation
     // deletes the document if this is there are no more views.
     virtual void OnChangedViewList();
 
 
     // Called after a view is added or removed. The default implementation
     // deletes the document if this is there are no more views.
     virtual void OnChangedViewList();
 

+    // Called from OnCloseDocument(), does nothing by default but may be
+    // overridden. Return value is ignored.

     virtual bool DeleteContents();
 
     virtual bool Draw(wxDC&);
     virtual bool IsModified() const { return m_documentModified; }
     virtual bool DeleteContents();
 
     virtual bool Draw(wxDC&);
     virtual bool IsModified() const { return m_documentModified; }

-    virtual void Modify(bool mod) { m_documentModified = mod; }
+    virtual void Modify(bool mod);

 
     virtual bool AddView(wxView *view);
     virtual bool RemoveView(wxView *view);
 
     virtual bool AddView(wxView *view);
     virtual bool RemoveView(wxView *view);

+
+#ifndef __VISUALC6__
+    wxViewVector GetViewsVector() const;
+#endif // !__VISUALC6__
+

     wxList& GetViews() { return m_documentViews; }
     const wxList& GetViews() const { return m_documentViews; }
     wxList& GetViews() { return m_documentViews; }
     const wxList& GetViews() const { return m_documentViews; }

+

     wxView *GetFirstView() const;
 
     virtual void UpdateAllViews(wxView *sender = NULL, wxObject *hint = NULL);
     wxView *GetFirstView() const;
 
     virtual void UpdateAllViews(wxView *sender = NULL, wxObject *hint = NULL);


@@ -134,8 +166,10 @@ public:
 
     // Other stuff
     virtual wxDocManager *GetDocumentManager() const;
 
     // Other stuff
     virtual wxDocManager *GetDocumentManager() const;

-    virtual wxDocTemplate *GetDocumentTemplate() const { return m_documentTemplate; }
-    virtual void SetDocumentTemplate(wxDocTemplate *temp) { m_documentTemplate = temp; }
+    virtual wxDocTemplate *GetDocumentTemplate() const
+        { return m_documentTemplate; }
+    virtual void SetDocumentTemplate(wxDocTemplate *temp)
+        { m_documentTemplate = temp; }

 
     // Get the document name to be shown to the user: the title if there is
     // any, otherwise the filename if the document was saved and, finally,
 
     // Get the document name to be shown to the user: the title if there is
     // any, otherwise the filename if the document was saved and, finally,


@@ -153,6 +187,10 @@ public:
     // dialogs. Override if necessary.
     virtual wxWindow *GetDocumentWindow() const;
 
     // dialogs. Override if necessary.
     virtual wxWindow *GetDocumentWindow() const;
 

+    // Returns true if this document is a child document corresponding to a
+    // part of the parent document and not a disk file as usual.
+    bool IsChildDocument() const { return m_documentParent != NULL; }
+

 protected:
     wxList                m_documentViews;
     wxString              m_documentFile;
 protected:
     wxList                m_documentViews;
     wxString              m_documentFile;


@@ -160,13 +198,18 @@ protected:
     wxString              m_documentTypeName;
     wxDocTemplate*        m_documentTemplate;
     bool                  m_documentModified;
     wxString              m_documentTypeName;
     wxDocTemplate*        m_documentTemplate;
     bool                  m_documentModified;

+
+    // if the document parent is non-NULL, it's a pseudo-document corresponding
+    // to a part of the parent document which can't be saved or loaded
+    // independently of its parent and is always closed when its parent is

     wxDocument*           m_documentParent;
     wxDocument*           m_documentParent;

+

     wxCommandProcessor*   m_commandProcessor;
     bool                  m_savedYet;
 
     // Called by OnSaveDocument and OnOpenDocument to implement standard
     wxCommandProcessor*   m_commandProcessor;
     bool                  m_savedYet;
 
     // Called by OnSaveDocument and OnOpenDocument to implement standard

-    // Save/Load behavior. Re-implement in derived class for custom
-    // behavior.
+    // Save/Load behaviour. Re-implement in derived class for custom
+    // behaviour.

     virtual bool DoSaveDocument(const wxString& file);
     virtual bool DoOpenDocument(const wxString& file);
 
     virtual bool DoSaveDocument(const wxString& file);
     virtual bool DoOpenDocument(const wxString& file);
 


@@ -174,8 +217,12 @@ protected:
     wxString DoGetUserReadableName() const;
 
 private:
     wxString DoGetUserReadableName() const;
 
 private:

+    // list of all documents whose m_documentParent is this one
+    typedef wxDList<wxDocument> DocsList;
+    DocsList m_childDocuments;
+

     DECLARE_ABSTRACT_CLASS(wxDocument)
     DECLARE_ABSTRACT_CLASS(wxDocument)

-    DECLARE_NO_COPY_CLASS(wxDocument)
+    wxDECLARE_NO_COPY_CLASS(wxDocument);

 };
 
 class WXDLLIMPEXP_CORE wxView: public wxEvtHandler
 };
 
 class WXDLLIMPEXP_CORE wxView: public wxEvtHandler


@@ -193,7 +240,9 @@ public:
     wxWindow *GetFrame() const { return m_viewFrame ; }
     void SetFrame(wxWindow *frame) { m_viewFrame = frame; }
 
     wxWindow *GetFrame() const { return m_viewFrame ; }
     void SetFrame(wxWindow *frame) { m_viewFrame = frame; }
 

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

     virtual void OnDraw(wxDC *dc) = 0;
     virtual void OnPrint(wxDC *dc, wxObject *info);
     virtual void OnUpdate(wxView *sender, wxObject *hint = NULL);
     virtual void OnDraw(wxDC *dc) = 0;
     virtual void OnPrint(wxDC *dc, wxObject *info);
     virtual void OnUpdate(wxView *sender, wxObject *hint = NULL);


@@ -224,17 +273,26 @@ public:
     virtual wxPrintout *OnCreatePrintout();
 #endif
 
     virtual wxPrintout *OnCreatePrintout();
 #endif
 

+    // implementation only
+    // -------------------
+
+    // set the associated frame, it is used to reset its view when we're
+    // destroyed
+    void SetDocChildFrame(wxDocChildFrameAnyBase *docChildFrame);
+

 protected:
     // hook the document into event handlers chain here
 protected:
     // hook the document into event handlers chain here

-    virtual bool TryValidator(wxEvent& event);
+    virtual bool TryBefore(wxEvent& event);

 
     wxDocument*       m_viewDocument;
     wxString          m_viewTypeName;
     wxWindow*         m_viewFrame;
 
 
     wxDocument*       m_viewDocument;
     wxString          m_viewTypeName;
     wxWindow*         m_viewFrame;
 

+    wxDocChildFrameAnyBase *m_docChildFrame;
+

 private:
     DECLARE_ABSTRACT_CLASS(wxView)
 private:
     DECLARE_ABSTRACT_CLASS(wxView)

-    DECLARE_NO_COPY_CLASS(wxView)
+    wxDECLARE_NO_COPY_CLASS(wxView);

 };
 
 // Represents user interface (and other) properties of documents and views
 };
 
 // Represents user interface (and other) properties of documents and views


@@ -267,13 +325,16 @@ public:
 
     // Helper method for CreateDocument; also allows you to do your own document
     // creation
 
     // Helper method for CreateDocument; also allows you to do your own document
     // creation

-    virtual bool InitDocument(wxDocument* doc, const wxString& path, long flags = 0);
+    virtual bool InitDocument(wxDocument* doc,
+                              const wxString& path,
+                              long flags = 0);

 
     wxString GetDefaultExtension() const { return m_defaultExt; }
     wxString GetDescription() const { return m_description; }
     wxString GetDirectory() const { return m_directory; }
     wxDocManager *GetDocumentManager() const { return m_documentManager; }
 
     wxString GetDefaultExtension() const { return m_defaultExt; }
     wxString GetDescription() const { return m_description; }
     wxString GetDirectory() const { return m_directory; }
     wxDocManager *GetDocumentManager() const { return m_documentManager; }

-    void SetDocumentManager(wxDocManager *manager) { m_documentManager = manager; }
+    void SetDocumentManager(wxDocManager *manager)
+        { m_documentManager = manager; }

     wxString GetFileFilter() const { return m_fileFilter; }
     long GetFlags() const { return m_flags; }
     virtual wxString GetViewName() const { return m_viewTypeName; }
     wxString GetFileFilter() const { return m_fileFilter; }
     long GetFlags() const { return m_flags; }
     virtual wxString GetViewName() const { return m_viewTypeName; }


@@ -285,7 +346,7 @@ public:
     void SetDefaultExtension(const wxString& ext) { m_defaultExt = ext; }
     void SetFlags(long flags) { m_flags = flags; }
 
     void SetDefaultExtension(const wxString& ext) { m_defaultExt = ext; }
     void SetFlags(long flags) { m_flags = flags; }
 

-    bool IsVisible() const { return ((m_flags & wxTEMPLATE_VISIBLE) == wxTEMPLATE_VISIBLE); }
+    bool IsVisible() const { return (m_flags & wxTEMPLATE_VISIBLE) != 0; }

 
     wxClassInfo* GetDocClassInfo() const { return m_docClassInfo; }
     wxClassInfo* GetViewClassInfo() const { return m_viewClassInfo; }
 
     wxClassInfo* GetDocClassInfo() const { return m_docClassInfo; }
     wxClassInfo* GetViewClassInfo() const { return m_viewClassInfo; }


@@ -306,15 +367,17 @@ protected:
     wxClassInfo*      m_docClassInfo;
     wxClassInfo*      m_viewClassInfo;
 
     wxClassInfo*      m_docClassInfo;
     wxClassInfo*      m_viewClassInfo;
 

-    // Called by CreateDocument and CreateView to create the actual document/view object.
-    // By default uses the ClassInfo provided to the constructor. Override these functions
-    // to provide a different method of creation.
+    // Called by CreateDocument and CreateView to create the actual
+    // document/view object.
+    //
+    // By default uses the ClassInfo provided to the constructor. Override
+    // these functions to provide a different method of creation.

     virtual wxDocument *DoCreateDocument();
     virtual wxView *DoCreateView();
 
 private:
     DECLARE_CLASS(wxDocTemplate)
     virtual wxDocument *DoCreateDocument();
     virtual wxView *DoCreateView();
 
 private:
     DECLARE_CLASS(wxDocTemplate)

-    DECLARE_NO_COPY_CLASS(wxDocTemplate)
+    wxDECLARE_NO_COPY_CLASS(wxDocTemplate);

 };
 
 // One object of this class may be created in an application, to manage all
 };
 
 // One object of this class may be created in an application, to manage all


@@ -336,16 +399,22 @@ public:
     void OnFileRevert(wxCommandEvent& event);
     void OnFileSave(wxCommandEvent& event);
     void OnFileSaveAs(wxCommandEvent& event);
     void OnFileRevert(wxCommandEvent& event);
     void OnFileSave(wxCommandEvent& event);
     void OnFileSaveAs(wxCommandEvent& event);

+    void OnMRUFile(wxCommandEvent& event);
+#if wxUSE_PRINTING_ARCHITECTURE

     void OnPrint(wxCommandEvent& event);
     void OnPreview(wxCommandEvent& event);
     void OnPrint(wxCommandEvent& event);
     void OnPreview(wxCommandEvent& event);

+    void OnPageSetup(wxCommandEvent& event);
+#endif // wxUSE_PRINTING_ARCHITECTURE

     void OnUndo(wxCommandEvent& event);
     void OnRedo(wxCommandEvent& event);
 
     // Handlers for UI update commands
     void OnUpdateFileOpen(wxUpdateUIEvent& event);
     void OnUpdateDisableIfNoDoc(wxUpdateUIEvent& event);
     void OnUndo(wxCommandEvent& event);
     void OnRedo(wxCommandEvent& event);
 
     // Handlers for UI update commands
     void OnUpdateFileOpen(wxUpdateUIEvent& event);
     void OnUpdateDisableIfNoDoc(wxUpdateUIEvent& event);

+    void OnUpdateFileRevert(wxUpdateUIEvent& event);

     void OnUpdateFileNew(wxUpdateUIEvent& event);
     void OnUpdateFileSave(wxUpdateUIEvent& event);
     void OnUpdateFileNew(wxUpdateUIEvent& event);
     void OnUpdateFileSave(wxUpdateUIEvent& event);

+    void OnUpdateFileSaveAs(wxUpdateUIEvent& event);

     void OnUpdateUndo(wxUpdateUIEvent& event);
     void OnUpdateRedo(wxUpdateUIEvent& event);
 
     void OnUpdateUndo(wxUpdateUIEvent& event);
     void OnUpdateRedo(wxUpdateUIEvent& event);
 


@@ -354,6 +423,11 @@ public:
     virtual void OnOpenFileFailure() { }
 
     virtual wxDocument *CreateDocument(const wxString& path, long flags = 0);
     virtual void OnOpenFileFailure() { }
 
     virtual wxDocument *CreateDocument(const wxString& path, long flags = 0);

+
+    // wrapper around CreateDocument() with a more clear name
+    wxDocument *CreateNewDocument()
+        { return CreateDocument(wxString(), wxDOC_NEW); }
+

     virtual wxView *CreateView(wxDocument *doc, long flags = 0);
     virtual void DeleteTemplate(wxDocTemplate *temp, long flags = 0);
     virtual bool FlushDoc(wxDocument *doc);
     virtual wxView *CreateView(wxDocument *doc, long flags = 0);
     virtual void DeleteTemplate(wxDocTemplate *temp, long flags = 0);
     virtual bool FlushDoc(wxDocument *doc);


@@ -369,6 +443,12 @@ public:
     void AssociateTemplate(wxDocTemplate *temp);
     void DisassociateTemplate(wxDocTemplate *temp);
 
     void AssociateTemplate(wxDocTemplate *temp);
     void DisassociateTemplate(wxDocTemplate *temp);
 

+    // Find template from document class info, may return NULL.
+    wxDocTemplate* FindTemplate(const wxClassInfo* documentClassInfo);
+
+    // Find document from file name, may return NULL.
+    wxDocument* FindDocumentByPath(const wxString& path) const;
+

     wxDocument *GetCurrentDocument() const;
 
     void SetMaxDocsOpen(int n) { m_maxDocsOpen = n; }
     wxDocument *GetCurrentDocument() const;
 
     void SetMaxDocsOpen(int n) { m_maxDocsOpen = n; }


@@ -390,7 +470,18 @@ public:
     // Views or windows should inform the document manager
     // when a view is going in or out of focus
     virtual void ActivateView(wxView *view, bool activate = true);
     // Views or windows should inform the document manager
     // when a view is going in or out of focus
     virtual void ActivateView(wxView *view, bool activate = true);

-    virtual wxView *GetCurrentView() const;
+    virtual wxView *GetCurrentView() const { return m_currentView; }
+
+    // This method tries to find an active view harder than GetCurrentView():
+    // if the latter is NULL, it also checks if we don't have just a single
+    // view and returns it then.
+    wxView *GetAnyUsableView() const;
+
+
+#ifndef __VISUALC6__
+    wxDocVector GetDocumentsVector() const;
+    wxDocTemplateVector GetTemplatesVector() const;
+#endif // !__VISUALC6__

 
     wxList& GetDocuments() { return m_docs; }
     wxList& GetTemplates() { return m_templates; }
 
     wxList& GetDocuments() { return m_docs; }
     wxList& GetTemplates() { return m_templates; }


@@ -420,12 +511,19 @@ public:
     virtual void FileHistoryAddFilesToMenu();
     virtual void FileHistoryAddFilesToMenu(wxMenu* menu);
 
     virtual void FileHistoryAddFilesToMenu();
     virtual void FileHistoryAddFilesToMenu(wxMenu* menu);
 

-    wxString GetLastDirectory() const { return m_lastDirectory; }
+    wxString GetLastDirectory() const;

     void SetLastDirectory(const wxString& dir) { m_lastDirectory = dir; }
 
     // Get the current document manager
     static wxDocManager* GetDocumentManager() { return sm_docManager; }
 
     void SetLastDirectory(const wxString& dir) { m_lastDirectory = dir; }
 
     // Get the current document manager
     static wxDocManager* GetDocumentManager() { return sm_docManager; }
 

+#if wxUSE_PRINTING_ARCHITECTURE
+    wxPageSetupDialogData& GetPageSetupDialogData()
+        { return m_pageSetupDialogData; }
+    const wxPageSetupDialogData& GetPageSetupDialogData() const
+        { return m_pageSetupDialogData; }
+#endif // wxUSE_PRINTING_ARCHITECTURE
+

 #if WXWIN_COMPATIBILITY_2_8
     // deprecated, override GetDefaultName() instead
     wxDEPRECATED_BUT_USED_INTERNALLY(
 #if WXWIN_COMPATIBILITY_2_8
     // deprecated, override GetDefaultName() instead
     wxDEPRECATED_BUT_USED_INTERNALLY(


@@ -438,9 +536,26 @@ public:
     wxDEPRECATED( size_t GetNoHistoryFiles() const );
 #endif // WXWIN_COMPATIBILITY_2_6
 
     wxDEPRECATED( size_t GetNoHistoryFiles() const );
 #endif // WXWIN_COMPATIBILITY_2_6
 

+

 protected:
 protected:

+    // Called when a file selected from the MRU list doesn't exist any more.
+    // The default behaviour is to remove the file from the MRU and notify the
+    // user about it but this method can be overridden to customize it.
+    virtual void OnMRUFileNotExist(unsigned n, const wxString& filename);
+
+    // Open the MRU file with the given index in our associated file history.
+    void DoOpenMRUFile(unsigned n);
+#if wxUSE_PRINTING_ARCHITECTURE
+    virtual wxPreviewFrame* CreatePreviewFrame(wxPrintPreviewBase* preview,
+                                               wxWindow *parent,
+                                               const wxString& title);
+#endif // wxUSE_PRINTING_ARCHITECTURE
+

     // hook the currently active view into event handlers chain here
     // hook the currently active view into event handlers chain here

-    virtual bool TryValidator(wxEvent& event);
+    virtual bool TryBefore(wxEvent& event);
+
+    // return the command processor for the current document, if any
+    wxCommandProcessor *GetCurrentCommandProcessor() const;

 
     int               m_defaultDocumentNameCounter;
     int               m_maxDocsOpen;
 
     int               m_defaultDocumentNameCounter;
     int               m_maxDocsOpen;


@@ -451,9 +566,13 @@ protected:
     wxString          m_lastDirectory;
     static wxDocManager* sm_docManager;
 
     wxString          m_lastDirectory;
     static wxDocManager* sm_docManager;
 

+#if wxUSE_PRINTING_ARCHITECTURE
+    wxPageSetupDialogData m_pageSetupDialogData;
+#endif // wxUSE_PRINTING_ARCHITECTURE
+

     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxDocManager)
     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxDocManager)

-    DECLARE_NO_COPY_CLASS(wxDocManager)
+    wxDECLARE_NO_COPY_CLASS(wxDocManager);

 };
 
 #if WXWIN_COMPATIBILITY_2_6
 };
 
 #if WXWIN_COMPATIBILITY_2_6


@@ -464,197 +583,435 @@ inline size_t wxDocManager::GetNoHistoryFiles() const
 #endif // WXWIN_COMPATIBILITY_2_6
 
 // ----------------------------------------------------------------------------
 #endif // WXWIN_COMPATIBILITY_2_6
 
 // ----------------------------------------------------------------------------

-// A default child frame
+// Base class for child frames -- this is what wxView renders itself into
+//
+// Notice that this is a mix-in class so it doesn't derive from wxWindow, only
+// wxDocChildFrameAny does

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-class WXDLLIMPEXP_CORE wxDocChildFrame : public wxFrame
+class WXDLLIMPEXP_CORE wxDocChildFrameAnyBase

 {
 public:
 {
 public:

-    wxDocChildFrame(wxDocument *doc,
-                    wxView *view,
-                    wxFrame *frame,
-                    wxWindowID id,
-                    const wxString& title,
-                    const wxPoint& pos = wxDefaultPosition,
-                    const wxSize& size = wxDefaultSize,
-                    long type = wxDEFAULT_FRAME_STYLE,
-                    const wxString& name = wxT("frame"));
-    virtual ~wxDocChildFrame(){}
-
-    void OnActivate(wxActivateEvent& event);
-    void OnCloseWindow(wxCloseEvent& event);
+    // default ctor, use Create() after it
+    wxDocChildFrameAnyBase()
+    {
+        m_childDocument = NULL;
+        m_childView = NULL;
+        m_win = NULL;
+    }
+
+    // full ctor equivalent to using the default one and Create(0
+    wxDocChildFrameAnyBase(wxDocument *doc, wxView *view, wxWindow *win)
+    {
+        Create(doc, view, win);
+    }
+
+    // method which must be called for an object created using the default ctor
+    //
+    // note that it returns bool just for consistency with Create() methods in
+    // other classes, we never return false from here
+    bool Create(wxDocument *doc, wxView *view, wxWindow *win)
+    {
+        m_childDocument = doc;
+        m_childView = view;
+        m_win = win;
+
+        if ( view )
+            view->SetDocChildFrame(this);
+
+        return true;
+    }
+
+    // dtor doesn't need to be virtual, an object should never be destroyed via
+    // a pointer to this class
+    ~wxDocChildFrameAnyBase()
+    {
+        // prevent the view from deleting us if we're being deleted directly
+        // (and not via Close() + Destroy())
+        if ( m_childView )
+            m_childView->SetDocChildFrame(NULL);
+    }

 
     wxDocument *GetDocument() const { return m_childDocument; }
     wxView *GetView() const { return m_childView; }
     void SetDocument(wxDocument *doc) { m_childDocument = doc; }
     void SetView(wxView *view) { m_childView = view; }
 
     wxDocument *GetDocument() const { return m_childDocument; }
     wxView *GetView() const { return m_childView; }
     void SetDocument(wxDocument *doc) { m_childDocument = doc; }
     void SetView(wxView *view) { m_childView = view; }

-    bool Destroy() { m_childView = NULL; return wxFrame::Destroy(); }
+
+    wxWindow *GetWindow() const { return m_win; }

 
 protected:
 
 protected:

-    // hook the child view into event handlers chain here
-    virtual bool TryValidator(wxEvent& event);
+    // we're not a wxEvtHandler but we provide this wxEvtHandler-like function
+    // which is called from TryBefore() of the derived classes to give our view
+    // a chance to process the message before the frame event handlers are used
+    bool TryProcessEvent(wxEvent& event);
+
+    // called from EVT_CLOSE handler in the frame: check if we can close and do
+    // cleanup if so; veto the event otherwise
+    bool CloseView(wxCloseEvent& event);
+

 
     wxDocument*       m_childDocument;
     wxView*           m_childView;
 
 
     wxDocument*       m_childDocument;
     wxView*           m_childView;
 

-private:
-    DECLARE_CLASS(wxDocChildFrame)
-    DECLARE_EVENT_TABLE()
-    DECLARE_NO_COPY_CLASS(wxDocChildFrame)
+    // the associated window: having it here is not terribly elegant but it
+    // allows us to avoid having any virtual functions in this class
+    wxWindow* m_win;
+
+
+    wxDECLARE_NO_COPY_CLASS(wxDocChildFrameAnyBase);

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------

-// A default parent frame
+// Template implementing child frame concept using the given wxFrame-like class
+//
+// This is used to define wxDocChildFrame and wxDocMDIChildFrame: ChildFrame is
+// a wxFrame or wxMDIChildFrame (although in theory it could be any wxWindow-
+// derived class as long as it provided a ctor with the same signature as
+// wxFrame and OnActivate() method) and ParentFrame is either wxFrame or
+// wxMDIParentFrame.

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-class WXDLLIMPEXP_CORE wxDocParentFrame : public wxFrame
+template <class ChildFrame, class ParentFrame>
+class WXDLLIMPEXP_CORE wxDocChildFrameAny : public ChildFrame,
+                                            public wxDocChildFrameAnyBase

 {
 public:
 {
 public:

-    wxDocParentFrame();
-    wxDocParentFrame(wxDocManager *manager,
-                     wxFrame *frame,
-                     wxWindowID id,
-                     const wxString& title,
-                     const wxPoint& pos = wxDefaultPosition,
-                     const wxSize& size = wxDefaultSize,
-                     long style = wxDEFAULT_FRAME_STYLE,
-                     const wxString& name = wxFrameNameStr);
-
-    bool Create(wxDocManager *manager,
-                wxFrame *frame,
+    typedef ChildFrame BaseClass;
+
+    // default ctor, use Create after it
+    wxDocChildFrameAny() { }
+
+    // ctor for a frame showing the given view of the specified document
+    wxDocChildFrameAny(wxDocument *doc,
+                       wxView *view,
+                       ParentFrame *parent,
+                       wxWindowID id,
+                       const wxString& title,
+                       const wxPoint& pos = wxDefaultPosition,
+                       const wxSize& size = wxDefaultSize,
+                       long style = wxDEFAULT_FRAME_STYLE,
+                       const wxString& name = wxFrameNameStr)
+    {
+        Create(doc, view, parent, id, title, pos, size, style, name);
+    }
+
+    bool Create(wxDocument *doc,
+                wxView *view,
+                ParentFrame *parent,

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

-                const wxString& name = wxFrameNameStr);
-
-    wxDocManager *GetDocumentManager() const { return m_docManager; }
-
-    void OnExit(wxCommandEvent& event);
-    void OnMRUFile(wxCommandEvent& event);
-    void OnCloseWindow(wxCloseEvent& event);
+                const wxString& name = wxFrameNameStr)
+    {
+        if ( !wxDocChildFrameAnyBase::Create(doc, view, this) )
+            return false;
+
+        if ( !BaseClass::Create(parent, id, title, pos, size, style, name) )
+            return false;
+
+        this->Connect(wxEVT_ACTIVATE,
+                      wxActivateEventHandler(wxDocChildFrameAny::OnActivate));
+        this->Connect(wxEVT_CLOSE_WINDOW,
+                      wxCloseEventHandler(wxDocChildFrameAny::OnCloseWindow));
+
+        return true;
+    }
+
+    virtual bool Destroy()
+    {
+        // FIXME: why exactly do we do this? to avoid activation events during
+        //        destructions maybe?
+        m_childView = NULL;
+        return BaseClass::Destroy();
+    }

 
 protected:
 
 protected:

-    // hook the document manager into event handling chain here
-    virtual bool TryValidator(wxEvent& event);
-
-    wxDocManager *m_docManager;
+    // hook the child view into event handlers chain here
+    virtual bool TryBefore(wxEvent& event)
+    {
+        return TryProcessEvent(event) || BaseClass::TryBefore(event);
+    }

 
 private:
 
 private:

-    typedef wxFrame base_type;
-    DECLARE_CLASS(wxDocParentFrame)
-    DECLARE_EVENT_TABLE()
-    DECLARE_NO_COPY_CLASS(wxDocParentFrame)
+    void OnActivate(wxActivateEvent& event)
+    {
+        BaseClass::OnActivate(event);
+
+        if ( m_childView )
+            m_childView->Activate(event.GetActive());
+    }
+
+    void OnCloseWindow(wxCloseEvent& event)
+    {
+        if ( CloseView(event) )
+            Destroy();
+        //else: vetoed
+    }
+
+    wxDECLARE_NO_COPY_TEMPLATE_CLASS_2(wxDocChildFrameAny,
+                                        ChildFrame, ParentFrame);

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------

-// Provide simple default printing facilities
+// A default child frame: we need to define it as a class just for wxRTTI,
+// otherwise we could simply typedef it

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-#if wxUSE_PRINTING_ARCHITECTURE
-class WXDLLIMPEXP_CORE wxDocPrintout : public wxPrintout
+#ifdef __VISUALC6__
+    // "non dll-interface class 'wxDocChildFrameAny<>' used as base interface
+    // for dll-interface class 'wxDocChildFrame'" -- this is bogus as the
+    // template will be DLL-exported but only once it is used as base class
+    // here!
+    #pragma warning (push)
+    #pragma warning (disable:4275)
+#endif
+
+typedef wxDocChildFrameAny<wxFrame, wxFrame> wxDocChildFrameBase;
+
+class WXDLLIMPEXP_CORE wxDocChildFrame : public wxDocChildFrameBase

 {
 public:
 {
 public:

-    wxDocPrintout(wxView *view = NULL, const wxString& title = wxT("Printout"));
-    bool OnPrintPage(int page);
-    bool HasPage(int page);
-    bool OnBeginDocument(int startPage, int endPage);
-    void GetPageInfo(int *minPage, int *maxPage, int *selPageFrom, int *selPageTo);
-
-    virtual wxView *GetView() { return m_printoutView; }
+    wxDocChildFrame()
+    {
+    }

 
 

-protected:
-    wxView*       m_printoutView;
+    wxDocChildFrame(wxDocument *doc,
+                    wxView *view,
+                    wxFrame *parent,
+                    wxWindowID id,
+                    const wxString& title,
+                    const wxPoint& pos = wxDefaultPosition,
+                    const wxSize& size = wxDefaultSize,
+                    long style = wxDEFAULT_FRAME_STYLE,
+                    const wxString& name = wxFrameNameStr)
+        : wxDocChildFrameBase(doc, view,
+                              parent, id, title, pos, size, style, name)
+    {
+    }
+
+    bool Create(wxDocument *doc,
+                wxView *view,
+                wxFrame *parent,
+                wxWindowID id,
+                const wxString& title,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = wxDEFAULT_FRAME_STYLE,
+                const wxString& name = wxFrameNameStr)
+    {
+        return wxDocChildFrameBase::Create
+               (
+                    doc, view,
+                    parent, id, title, pos, size, style, name
+               );
+    }

 
 private:
 
 private:

-    DECLARE_DYNAMIC_CLASS(wxDocPrintout)
-    DECLARE_NO_COPY_CLASS(wxDocPrintout)
+    DECLARE_CLASS(wxDocChildFrame)
+    wxDECLARE_NO_COPY_CLASS(wxDocChildFrame);

 };
 };

-#endif // wxUSE_PRINTING_ARCHITECTURE

 
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------

-// File history management
+// wxDocParentFrame and related classes.
+//
+// As with wxDocChildFrame we define a template base class used by both normal
+// and MDI versions

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-class WXDLLIMPEXP_CORE wxFileHistory : public wxObject
+// Base class containing type-independent code of wxDocParentFrameAny
+//
+// Similarly to wxDocChildFrameAnyBase, this class is a mix-in and doesn't
+// derive from wxWindow.
+class WXDLLIMPEXP_CORE wxDocParentFrameAnyBase

 {
 public:
 {
 public:

-    wxFileHistory(size_t maxFiles = 9, wxWindowID idBase = wxID_FILE1);
+    wxDocParentFrameAnyBase(wxWindow* frame)
+        : m_frame(frame)
+    {
+        m_docManager = NULL;
+    }

 
 

-    // Operations
-    virtual void AddFileToHistory(const wxString& file);
-    virtual void RemoveFileFromHistory(size_t i);
-    virtual int GetMaxFiles() const { return (int)m_fileMaxFiles; }
-    virtual void UseMenu(wxMenu *menu);
+    wxDocManager *GetDocumentManager() const { return m_docManager; }

 
 

-    // Remove menu from the list (MDI child may be closing)
-    virtual void RemoveMenu(wxMenu *menu);
+protected:
+    // This is similar to wxDocChildFrameAnyBase method with the same name:
+    // while we're not an event handler ourselves and so can't override
+    // TryBefore(), we provide a helper that the derived template class can use
+    // from its TryBefore() implementation.
+    bool TryProcessEvent(wxEvent& event);

 
 

-#if wxUSE_CONFIG
-    virtual void Load(const wxConfigBase& config);
-    virtual void Save(wxConfigBase& config);
-#endif // wxUSE_CONFIG
+    wxWindow* const m_frame;
+    wxDocManager *m_docManager;

 
 

-    virtual void AddFilesToMenu();
-    virtual void AddFilesToMenu(wxMenu* menu); // Single menu
+    wxDECLARE_NO_COPY_CLASS(wxDocParentFrameAnyBase);
+};

 
 

-    // Accessors
-    virtual wxString GetHistoryFile(size_t i) const { return m_fileHistory[i]; }
-    virtual size_t GetCount() const { return m_fileHistory.GetCount(); }
+// This is similar to wxDocChildFrameAny and is used to provide common
+// implementation for both wxDocParentFrame and wxDocMDIParentFrame
+template <class BaseFrame>
+class WXDLLIMPEXP_CORE wxDocParentFrameAny : public BaseFrame,
+                                             public wxDocParentFrameAnyBase
+{
+public:
+    wxDocParentFrameAny() : wxDocParentFrameAnyBase(this) { }
+    wxDocParentFrameAny(wxDocManager *manager,
+                        wxFrame *frame,
+                        wxWindowID id,
+                        const wxString& title,
+                        const wxPoint& pos = wxDefaultPosition,
+                        const wxSize& size = wxDefaultSize,
+                        long style = wxDEFAULT_FRAME_STYLE,
+                        const wxString& name = wxFrameNameStr)
+        : wxDocParentFrameAnyBase(this)
+    {
+        Create(manager, frame, id, title, pos, size, style, name);
+    }
+
+    bool Create(wxDocManager *manager,
+                wxFrame *frame,
+                wxWindowID id,
+                const wxString& title,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = wxDEFAULT_FRAME_STYLE,
+                const wxString& name = wxFrameNameStr)
+    {
+        m_docManager = manager;

 
 

-    const wxList& GetMenus() const { return m_fileMenus; }
+        if ( !BaseFrame::Create(frame, id, title, pos, size, style, name) )
+            return false;

 
 

-    // Set/get base id
-    void SetBaseId(wxWindowID baseId) { m_idBase = baseId; }
-    wxWindowID GetBaseId() const { return m_idBase; }
+        this->Connect(wxID_EXIT, wxEVT_MENU,
+                      wxCommandEventHandler(wxDocParentFrameAny::OnExit));
+        this->Connect(wxEVT_CLOSE_WINDOW,
+                      wxCloseEventHandler(wxDocParentFrameAny::OnCloseWindow));

 
 

-#if WXWIN_COMPATIBILITY_2_6
-    // deprecated, use GetCount() instead
-    wxDEPRECATED( size_t GetNoHistoryFiles() const );
-#endif // WXWIN_COMPATIBILITY_2_6
+        return true;
+    }

 
 protected:
 
 protected:

-    // Last n files
-    wxArrayString     m_fileHistory;
+    // hook the document manager into event handling chain here
+    virtual bool TryBefore(wxEvent& event)
+    {
+        return TryProcessEvent(event) || BaseFrame::TryBefore(event);
+    }

 
 

-    // Menus to maintain (may need several for an MDI app)
-    wxList            m_fileMenus;
+private:
+    void OnExit(wxCommandEvent& WXUNUSED(event))
+    {
+        this->Close();
+    }
+
+    void OnCloseWindow(wxCloseEvent& event)
+    {
+        if ( m_docManager && !m_docManager->Clear(!event.CanVeto()) )
+        {
+            // The user decided not to close finally, abort.
+            event.Veto();
+        }
+        else
+        {
+            // Just skip the event, base class handler will destroy the window.
+            event.Skip();
+        }
+    }
+
+
+    wxDECLARE_NO_COPY_CLASS(wxDocParentFrameAny);
+};

 
 

-    // Max files to maintain
-    size_t            m_fileMaxFiles;
+typedef wxDocParentFrameAny<wxFrame> wxDocParentFrameBase;

 
 

-private:
-    // The ID of the first history menu item (Doesn't have to be wxID_FILE1)
-    wxWindowID m_idBase;
+class WXDLLIMPEXP_CORE wxDocParentFrame : public wxDocParentFrameBase
+{
+public:
+    wxDocParentFrame() : wxDocParentFrameBase() { }
+
+    wxDocParentFrame(wxDocManager *manager,
+                     wxFrame *parent,
+                     wxWindowID id,
+                     const wxString& title,
+                     const wxPoint& pos = wxDefaultPosition,
+                     const wxSize& size = wxDefaultSize,
+                     long style = wxDEFAULT_FRAME_STYLE,
+                     const wxString& name = wxFrameNameStr)
+        : wxDocParentFrameBase(manager,
+                               parent, id, title, pos, size, style, name)
+    {
+    }
+
+    bool Create(wxDocManager *manager,
+                wxFrame *parent,
+                wxWindowID id,
+                const wxString& title,
+                const wxPoint& pos = wxDefaultPosition,
+                const wxSize& size = wxDefaultSize,
+                long style = wxDEFAULT_FRAME_STYLE,
+                const wxString& name = wxFrameNameStr)
+    {
+        return wxDocParentFrameBase::Create(manager,
+                                            parent, id, title,
+                                            pos, size, style, name);
+    }

 
 

-    DECLARE_DYNAMIC_CLASS(wxFileHistory)
-    DECLARE_NO_COPY_CLASS(wxFileHistory)
+private:
+    DECLARE_CLASS(wxDocParentFrame)
+    wxDECLARE_NO_COPY_CLASS(wxDocParentFrame);

 };
 
 };
 

-#if WXWIN_COMPATIBILITY_2_6
-inline size_t wxFileHistory::GetNoHistoryFiles() const
+#ifdef __VISUALC6__
+    // reenable warning 4275
+    #pragma warning (pop)
+#endif
+
+// ----------------------------------------------------------------------------
+// Provide simple default printing facilities
+// ----------------------------------------------------------------------------
+
+#if wxUSE_PRINTING_ARCHITECTURE
+class WXDLLIMPEXP_CORE wxDocPrintout : public wxPrintout

 {
 {

-    return m_fileHistory.GetCount();
-}
-#endif // WXWIN_COMPATIBILITY_2_6
+public:
+    wxDocPrintout(wxView *view = NULL, const wxString& title = wxString());
+
+    // implement wxPrintout methods
+    virtual bool OnPrintPage(int page);
+    virtual bool HasPage(int page);
+    virtual bool OnBeginDocument(int startPage, int endPage);
+    virtual void GetPageInfo(int *minPage, int *maxPage,
+                             int *selPageFrom, int *selPageTo);
+
+    virtual wxView *GetView() { return m_printoutView; }
+
+protected:
+    wxView*       m_printoutView;
+
+private:
+    DECLARE_DYNAMIC_CLASS(wxDocPrintout)
+    wxDECLARE_NO_COPY_CLASS(wxDocPrintout);
+};
+#endif // wxUSE_PRINTING_ARCHITECTURE

 
 

-#if wxUSE_STD_IOSTREAM

 // For compatibility with existing file formats:
 // converts from/to a stream to/from a temporary file.
 // For compatibility with existing file formats:
 // converts from/to a stream to/from a temporary file.

-bool WXDLLIMPEXP_CORE wxTransferFileToStream(const wxString& filename, wxSTD ostream& stream);
-bool WXDLLIMPEXP_CORE wxTransferStreamToFile(wxSTD istream& stream, const wxString& filename);
+#if wxUSE_STD_IOSTREAM
+bool WXDLLIMPEXP_CORE
+wxTransferFileToStream(const wxString& filename, wxSTD ostream& stream);
+bool WXDLLIMPEXP_CORE
+wxTransferStreamToFile(wxSTD istream& stream, const wxString& filename);

 #else
 #else

-// For compatibility with existing file formats:
-// converts from/to a stream to/from a temporary file.
-bool WXDLLIMPEXP_CORE wxTransferFileToStream(const wxString& filename, wxOutputStream& stream);
-bool WXDLLIMPEXP_CORE wxTransferStreamToFile(wxInputStream& stream, const wxString& filename);
+bool WXDLLIMPEXP_CORE
+wxTransferFileToStream(const wxString& filename, wxOutputStream& stream);
+bool WXDLLIMPEXP_CORE
+wxTransferStreamToFile(wxInputStream& stream, const wxString& filename);

 #endif // wxUSE_STD_IOSTREAM
 
 
 // these flags are not used anywhere by wxWidgets and kept only for an unlikely
 // case of existing user code using them for its own purposes
 #endif // wxUSE_STD_IOSTREAM
 
 
 // these flags are not used anywhere by wxWidgets and kept only for an unlikely
 // case of existing user code using them for its own purposes

-#ifdef WXWIN_COMPATIBILITY_2_8
+#if WXWIN_COMPATIBILITY_2_8

 enum
 {
     wxDOC_SDI = 1,
 enum
 {
     wxDOC_SDI = 1,


@@ -663,6 +1020,23 @@ enum
 };
 #endif // WXWIN_COMPATIBILITY_2_8
 
 };
 #endif // WXWIN_COMPATIBILITY_2_8
 

+#ifndef __VISUALC6__
+inline wxViewVector wxDocument::GetViewsVector() const
+{
+    return m_documentViews.AsVector<wxView*>();
+}
+
+inline wxDocVector wxDocManager::GetDocumentsVector() const
+{
+    return m_docs.AsVector<wxDocument*>();
+}
+
+inline wxDocTemplateVector wxDocManager::GetTemplatesVector() const
+{
+    return m_templates.AsVector<wxDocTemplate*>();
+}
+#endif // !__VISUALC6__
+

 #endif // wxUSE_DOC_VIEW_ARCHITECTURE
 
 #endif // _WX_DOCH__
 #endif // wxUSE_DOC_VIEW_ARCHITECTURE
 
 #endif // _WX_DOCH__