Applied rowspan patch #15276 (dghart)

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

diff --git a/include/wx/docview.h b/include/wx/docview.h
index f8b7ea2cb72b31dd75b7e5118cbfc8c1421e1013..c8b034721501de66a2b0b7f8e143b9588f8d54ae 100644 (file)
--- a/include/wx/docview.h
+++ b/include/wx/docview.h
@@ -17,9 +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/filehistory.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"


@@ -59,6 +61,10 @@ enum
 
 #define wxMAX_FILE_HISTORY 9
 
 
 #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:


@@ -80,6 +86,9 @@ public:
     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)
     // 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)


@@ -129,6 +138,8 @@ public:
     // deletes the document if this is there are no more views.
     virtual void OnChangedViewList();
 
     // 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 DeleteContents();
 
     virtual bool Draw(wxDC&);


@@ -137,8 +148,14 @@ public:
 
     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);


@@ -170,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;


@@ -177,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);
 


@@ -191,6 +217,10 @@ 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)
     wxDECLARE_NO_COPY_CLASS(wxDocument);
 };
     DECLARE_ABSTRACT_CLASS(wxDocument)
     wxDECLARE_NO_COPY_CLASS(wxDocument);
 };


@@ -369,8 +399,12 @@ 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);
 
     void OnUndo(wxCommandEvent& event);
     void OnRedo(wxCommandEvent& event);
 


@@ -380,6 +414,7 @@ public:
     void OnUpdateFileRevert(wxUpdateUIEvent& event);
     void OnUpdateFileNew(wxUpdateUIEvent& event);
     void OnUpdateFileSave(wxUpdateUIEvent& event);
     void OnUpdateFileRevert(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);
 


@@ -408,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; }


@@ -431,6 +472,17 @@ public:
     virtual void ActivateView(wxView *view, bool activate = true);
     virtual wxView *GetCurrentView() const { return m_currentView; }
 
     virtual void ActivateView(wxView *view, bool activate = true);
     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; }
 


@@ -465,6 +517,13 @@ public:
     // Get the current document manager
     static wxDocManager* GetDocumentManager() { return sm_docManager; }
 
     // 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(


@@ -477,7 +536,15 @@ 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,
 #if wxUSE_PRINTING_ARCHITECTURE
     virtual wxPreviewFrame* CreatePreviewFrame(wxPrintPreviewBase* preview,
                                                wxWindow *parent,


@@ -490,12 +557,6 @@ protected:
     // return the command processor for the current document, if any
     wxCommandProcessor *GetCurrentCommandProcessor() const;
 
     // return the command processor for the current document, if any
     wxCommandProcessor *GetCurrentCommandProcessor() const;
 

-    // 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 *GetActiveView() const;
-
-

     int               m_defaultDocumentNameCounter;
     int               m_maxDocsOpen;
     wxList            m_docs;
     int               m_defaultDocumentNameCounter;
     int               m_maxDocsOpen;
     wxList            m_docs;


@@ -505,6 +566,10 @@ 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)
     wxDECLARE_NO_COPY_CLASS(wxDocManager);
     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxDocManager)
     wxDECLARE_NO_COPY_CLASS(wxDocManager);


@@ -578,10 +643,7 @@ protected:
     // 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
     // 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)
-    {
-        return m_childView && m_childView->ProcessEventLocally(event);
-    }
+    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
 
     // called from EVT_CLOSE handler in the frame: check if we can close and do
     // cleanup if so; veto the event otherwise


@@ -751,26 +813,61 @@ private:
     wxDECLARE_NO_COPY_CLASS(wxDocChildFrame);
 };
 
     wxDECLARE_NO_COPY_CLASS(wxDocChildFrame);
 };
 

-#ifdef __VISUALC6__
-    #pragma warning (pop)
-#endif
-

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

-// A default parent frame
+// wxDocParentFrame and related classes.
+//
+// As with wxDocChildFrame we define a template base class used by both normal
+// and MDI versions

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

-class WXDLLIMPEXP_CORE wxDocParentFrame : public wxFrame
+// 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:

-    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);
+    wxDocParentFrameAnyBase(wxWindow* frame)
+        : m_frame(frame)
+    {
+        m_docManager = NULL;
+    }
+
+    wxDocManager *GetDocumentManager() const { return m_docManager; }
+
+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);
+
+    wxWindow* const m_frame;
+    wxDocManager *m_docManager;
+
+    wxDECLARE_NO_COPY_CLASS(wxDocParentFrameAnyBase);
+};
+
+// 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,
 
     bool Create(wxDocManager *manager,
                 wxFrame *frame,


@@ -779,27 +876,96 @@ public:
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = wxDEFAULT_FRAME_STYLE,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
                 long style = wxDEFAULT_FRAME_STYLE,

-                const wxString& name = wxFrameNameStr);
+                const wxString& name = wxFrameNameStr)
+    {
+        m_docManager = manager;

 
 

-    wxDocManager *GetDocumentManager() const { return m_docManager; }
+        if ( !BaseFrame::Create(frame, id, title, pos, size, style, name) )
+            return false;

 
 

-    void OnExit(wxCommandEvent& event);
-    void OnMRUFile(wxCommandEvent& event);
-    void OnCloseWindow(wxCloseEvent& event);
+        this->Connect(wxID_EXIT, wxEVT_MENU,
+                      wxCommandEventHandler(wxDocParentFrameAny::OnExit));
+        this->Connect(wxEVT_CLOSE_WINDOW,
+                      wxCloseEventHandler(wxDocParentFrameAny::OnCloseWindow));
+
+        return true;
+    }

 
 protected:
     // hook the document manager into event handling chain here
 
 protected:
     // hook the document manager into event handling chain here

-    virtual bool TryBefore(wxEvent& event);
+    virtual bool TryBefore(wxEvent& event)
+    {
+        return TryProcessEvent(event) || BaseFrame::TryBefore(event);
+    }

 
 

-    wxDocManager *m_docManager;
+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);
+};
+
+typedef wxDocParentFrameAny<wxFrame> wxDocParentFrameBase;
+
+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);
+    }

 
 private:
 
 private:

-    typedef wxFrame base_type;

     DECLARE_CLASS(wxDocParentFrame)
     DECLARE_CLASS(wxDocParentFrame)

-    DECLARE_EVENT_TABLE()

     wxDECLARE_NO_COPY_CLASS(wxDocParentFrame);
 };
 
     wxDECLARE_NO_COPY_CLASS(wxDocParentFrame);
 };
 

+#ifdef __VISUALC6__
+    // reenable warning 4275
+    #pragma warning (pop)
+#endif
+

 // ----------------------------------------------------------------------------
 // Provide simple default printing facilities
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // Provide simple default printing facilities
 // ----------------------------------------------------------------------------


@@ -808,7 +974,7 @@ private:
 class WXDLLIMPEXP_CORE wxDocPrintout : public wxPrintout
 {
 public:
 class WXDLLIMPEXP_CORE wxDocPrintout : public wxPrintout
 {
 public:

-    wxDocPrintout(wxView *view = NULL, const wxString& title = wxT("Printout"));
+    wxDocPrintout(wxView *view = NULL, const wxString& title = wxString());

 
     // implement wxPrintout methods
     virtual bool OnPrintPage(int page);
 
     // implement wxPrintout methods
     virtual bool OnPrintPage(int page);


@@ -845,7 +1011,7 @@ wxTransferStreamToFile(wxInputStream& stream, const wxString& filename);
 
 // 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
 
 // 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,


@@ -854,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__