synchronize GTK2 minimum version in docs

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

diff --git a/include/wx/docview.h b/include/wx/docview.h
index 0c929524671d5d1143120d622c26e5bddda8c073..9b8cfa73544e10e9987090bd03d14270f7371cad 100644 (file)
--- a/include/wx/docview.h
+++ b/include/wx/docview.h
@@ -17,6 +17,7 @@
 #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"


@@ -172,6 +173,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;


@@ -179,13 +184,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);
 


@@ -193,6 +203,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);
 };


@@ -371,6 +385,7 @@ 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);
 #if wxUSE_PRINTING_ARCHITECTURE
     void OnPrint(wxCommandEvent& event);
     void OnPreview(wxCommandEvent& event);


@@ -385,6 +400,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);
 


@@ -413,6 +429,9 @@ 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);
+

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


@@ -470,6 +489,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(


@@ -484,6 +510,13 @@ public:
 
 
 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,


@@ -501,6 +534,9 @@ protected:
     // view and returns it then
     wxView *GetActiveView() const;
 
     // view and returns it then
     wxView *GetActiveView() const;
 

+    // activate the first view of the given document if any
+    void ActivateDocument(wxDocument *doc);
+

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


@@ -780,12 +816,6 @@ public:
     wxDocManager *GetDocumentManager() const { return m_docManager; }
 
 protected:
     wxDocManager *GetDocumentManager() const { return m_docManager; }
 
 protected:

-    // Open the MRU file with the given index in our associated file history.
-    //
-    // This is called from the derived class event handler for the MRU menu
-    // items.
-    void DoOpenMRUFile(unsigned n);
-

     wxDocManager *m_docManager;
 
     wxDECLARE_NO_COPY_CLASS(wxDocParentFrameAnyBase);
     wxDocManager *m_docManager;
 
     wxDECLARE_NO_COPY_CLASS(wxDocParentFrameAnyBase);


@@ -827,8 +857,6 @@ public:
 
         this->Connect(wxID_EXIT, wxEVT_COMMAND_MENU_SELECTED,
                       wxCommandEventHandler(wxDocParentFrameAny::OnExit));
 
         this->Connect(wxID_EXIT, wxEVT_COMMAND_MENU_SELECTED,
                       wxCommandEventHandler(wxDocParentFrameAny::OnExit));

-        this->Connect(wxID_FILE1, wxID_FILE9, wxEVT_COMMAND_MENU_SELECTED,
-                      wxCommandEventHandler(wxDocParentFrameAny::OnMRUFile));

         this->Connect(wxEVT_CLOSE_WINDOW,
                       wxCloseEventHandler(wxDocParentFrameAny::OnCloseWindow));
 
         this->Connect(wxEVT_CLOSE_WINDOW,
                       wxCloseEventHandler(wxDocParentFrameAny::OnCloseWindow));
 


@@ -851,11 +879,6 @@ private:
         this->Close();
     }
 
         this->Close();
     }
 

-    void OnMRUFile(wxCommandEvent& event)
-    {
-        DoOpenMRUFile(event.GetId() - wxID_FILE1);
-    }
-

     void OnCloseWindow(wxCloseEvent& event)
     {
         if ( m_docManager && !m_docManager->Clear(!event.CanVeto()) )
     void OnCloseWindow(wxCloseEvent& event)
     {
         if ( m_docManager && !m_docManager->Clear(!event.CanVeto()) )


@@ -926,7 +949,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);


@@ -963,7 +986,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,