Initial commit of wxAUI

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

diff --git a/include/wx/docview.h b/include/wx/docview.h
index 8c8bf6fa6f405a8b6773171ca5690480ec02aca8..36a9bd114e6fed09851383a4fd51d2610c5a9403 100644 (file)
--- a/include/wx/docview.h
+++ b/include/wx/docview.h
@@ -1,21 +1,17 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        docview.h
+// Name:        wx/docview.h

 // Purpose:     Doc/View classes
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Purpose:     Doc/View classes
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$

-// Copyright:   (c)
+// Copyright:   (c) Julian Smart

 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_DOCH__
 #define _WX_DOCH__
 
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_DOCH__
 #define _WX_DOCH__
 

-#if defined(__GNUG__) && !defined(__APPLE__)
-    #pragma interface "docview.h"
-#endif
-

 #include "wx/defs.h"
 
 #if wxUSE_DOC_VIEW_ARCHITECTURE
 #include "wx/defs.h"
 
 #if wxUSE_DOC_VIEW_ARCHITECTURE


@@ -72,7 +68,7 @@ public:
     ~wxDocument();
 
     // accessors
     ~wxDocument();
 
     // accessors

-    void SetFilename(const wxString& filename, bool notifyViews = FALSE);
+    void SetFilename(const wxString& filename, bool notifyViews = false);

     wxString GetFilename() const { return m_documentFile; }
 
     void SetTitle(const wxString& title) { m_documentTitle = title; };
     wxString GetFilename() const { return m_documentFile; }
 
     void SetTitle(const wxString& title) { m_documentTitle = title; };


@@ -82,7 +78,7 @@ public:
     wxString GetDocumentName() const { return m_documentTypeName; }
 
     bool GetDocumentSaved() const { return m_savedYet; }
     wxString GetDocumentName() const { return m_documentTypeName; }
 
     bool GetDocumentSaved() const { return m_savedYet; }

-    void SetDocumentSaved(bool saved = TRUE) { m_savedYet = saved; }
+    void SetDocumentSaved(bool saved = true) { m_savedYet = saved; }

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


@@ -97,15 +93,15 @@ public:
     virtual wxInputStream& LoadObject(wxInputStream& stream);
 #endif
 
     virtual wxInputStream& LoadObject(wxInputStream& stream);
 #endif
 

-    // Called by wxWindows
+    // Called by wxWidgets

     virtual bool OnSaveDocument(const wxString& filename);
     virtual bool OnOpenDocument(const wxString& filename);
     virtual bool OnNewDocument();
     virtual bool OnCloseDocument();
 
     virtual bool OnSaveDocument(const wxString& filename);
     virtual bool OnOpenDocument(const wxString& filename);
     virtual bool OnNewDocument();
     virtual bool OnCloseDocument();
 

-    // Prompts for saving if about to close a modified document. Returns TRUE
+    // Prompts for saving if about to close a modified document. Returns true

     // if ok to close the document (may have saved in the meantime, or set
     // if ok to close the document (may have saved in the meantime, or set

-    // modified to FALSE)
+    // modified to false)

     virtual bool OnSaveModified();
 
     // Called by framework if created automatically by the default document
     virtual bool OnSaveModified();
 
     // Called by framework if created automatically by the default document


@@ -130,7 +126,8 @@ public:
 
     virtual bool AddView(wxView *view);
     virtual bool RemoveView(wxView *view);
 
     virtual bool AddView(wxView *view);
     virtual bool RemoveView(wxView *view);

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

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


@@ -161,7 +158,13 @@ protected:
     wxDocument*           m_documentParent;
     wxCommandProcessor*   m_commandProcessor;
     bool                  m_savedYet;
     wxDocument*           m_documentParent;
     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.
+    virtual bool DoSaveDocument(const wxString& file);
+    virtual bool DoOpenDocument(const wxString& file);
+

 private:
     DECLARE_ABSTRACT_CLASS(wxDocument)
     DECLARE_NO_COPY_CLASS(wxDocument)
 private:
     DECLARE_ABSTRACT_CLASS(wxDocument)
     DECLARE_NO_COPY_CLASS(wxDocument)


@@ -187,26 +190,21 @@ public:
     virtual void OnDraw(wxDC *dc) = 0;
     virtual void OnPrint(wxDC *dc, wxObject *info);
     virtual void OnUpdate(wxView *sender, wxObject *hint = (wxObject *) NULL);
     virtual void OnDraw(wxDC *dc) = 0;
     virtual void OnPrint(wxDC *dc, wxObject *info);
     virtual void OnUpdate(wxView *sender, wxObject *hint = (wxObject *) NULL);

-    virtual void OnClosingDocument() {};
+    virtual void OnClosingDocument() {}

     virtual void OnChangeFilename();
 
     // Called by framework if created automatically by the default document
     // manager class: gives view a chance to initialise
     virtual void OnChangeFilename();
 
     // Called by framework if created automatically by the default document
     // manager class: gives view a chance to initialise

-    virtual bool OnCreate(wxDocument *WXUNUSED(doc), long WXUNUSED(flags)) { return TRUE; };
+    virtual bool OnCreate(wxDocument *WXUNUSED(doc), long WXUNUSED(flags)) { return true; };

 
     // Checks if the view is the last one for the document; if so, asks user
     // to confirm save data (if modified). If ok, deletes itself and returns
 
     // Checks if the view is the last one for the document; if so, asks user
     // to confirm save data (if modified). If ok, deletes itself and returns

-    // TRUE.
-    virtual bool Close(bool deleteWindow = TRUE);
+    // true.
+    virtual bool Close(bool deleteWindow = true);

 
     // Override to do cleanup/veto close
     virtual bool OnClose(bool deleteWindow);
 
 
     // Override to do cleanup/veto close
     virtual bool OnClose(bool deleteWindow);
 

-#if WXWIN_COMPATIBILITY
-    // Defeat compiler warning
-    bool OnClose() { return wxEvtHandler::OnClose(); }
-#endif
-

     // Extend event processing to search the document's event table
     virtual bool ProcessEvent(wxEvent& event);
 
     // Extend event processing to search the document's event table
     virtual bool ProcessEvent(wxEvent& event);
 


@@ -259,6 +257,10 @@ public:
     virtual wxDocument *CreateDocument(const wxString& path, long flags = 0);
     virtual wxView *CreateView(wxDocument *doc, long flags = 0);
 
     virtual wxDocument *CreateDocument(const wxString& path, long flags = 0);
     virtual wxView *CreateView(wxDocument *doc, long flags = 0);
 

+    // Helper method for CreateDocument; also allows you to do your own document
+    // creation
+    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; };
     wxString GetDefaultExtension() const { return m_defaultExt; };
     wxString GetDescription() const { return m_description; }
     wxString GetDirectory() const { return m_directory; };


@@ -277,6 +279,9 @@ public:
 
     bool IsVisible() const { return ((m_flags & wxTEMPLATE_VISIBLE) == wxTEMPLATE_VISIBLE); }
 
 
     bool IsVisible() const { return ((m_flags & wxTEMPLATE_VISIBLE) == wxTEMPLATE_VISIBLE); }
 

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

     virtual bool FileMatchesTemplate(const wxString& path);
 
 protected:
     virtual bool FileMatchesTemplate(const wxString& path);
 
 protected:


@@ -292,7 +297,13 @@ protected:
     // For dynamic creation of appropriate instances.
     wxClassInfo*      m_docClassInfo;
     wxClassInfo*      m_viewClassInfo;
     // For dynamic creation of appropriate instances.
     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.
+    virtual wxDocument *DoCreateDocument();
+    virtual wxView *DoCreateView();
+

 private:
     DECLARE_CLASS(wxDocTemplate)
     DECLARE_NO_COPY_CLASS(wxDocTemplate)
 private:
     DECLARE_CLASS(wxDocTemplate)
     DECLARE_NO_COPY_CLASS(wxDocTemplate)


@@ -302,10 +313,8 @@ private:
 // the templates and documents.
 class WXDLLEXPORT wxDocManager: public wxEvtHandler
 {
 // the templates and documents.
 class WXDLLEXPORT wxDocManager: public wxEvtHandler
 {

-    DECLARE_DYNAMIC_CLASS(wxDocManager)
-

 public:
 public:

-    wxDocManager(long flags = wxDEFAULT_DOCMAN_FLAGS, bool initialize = TRUE);
+    wxDocManager(long flags = wxDEFAULT_DOCMAN_FLAGS, bool initialize = true);

     ~wxDocManager();
 
     virtual bool Initialize();
     ~wxDocManager();
 
     virtual bool Initialize();


@@ -319,7 +328,6 @@ public:
     void OnFileSave(wxCommandEvent& event);
     void OnFileSaveAs(wxCommandEvent& event);
     void OnPrint(wxCommandEvent& event);
     void OnFileSave(wxCommandEvent& event);
     void OnFileSaveAs(wxCommandEvent& event);
     void OnPrint(wxCommandEvent& event);

-    void OnPrintSetup(wxCommandEvent& event);

     void OnPreview(wxCommandEvent& event);
     void OnUndo(wxCommandEvent& event);
     void OnRedo(wxCommandEvent& event);
     void OnPreview(wxCommandEvent& event);
     void OnUndo(wxCommandEvent& event);
     void OnRedo(wxCommandEvent& event);


@@ -335,7 +343,6 @@ public:
     void OnUpdateRedo(wxUpdateUIEvent& event);
 
     void OnUpdatePrint(wxUpdateUIEvent& event);
     void OnUpdateRedo(wxUpdateUIEvent& event);
 
     void OnUpdatePrint(wxUpdateUIEvent& event);

-    void OnUpdatePrintSetup(wxUpdateUIEvent& event);

     void OnUpdatePreview(wxUpdateUIEvent& event);
 
     // Extend event processing to search the view's event table
     void OnUpdatePreview(wxUpdateUIEvent& event);
 
     // Extend event processing to search the view's event table


@@ -351,11 +358,11 @@ public:
     virtual bool FlushDoc(wxDocument *doc);
     virtual wxDocTemplate *MatchTemplate(const wxString& path);
     virtual wxDocTemplate *SelectDocumentPath(wxDocTemplate **templates,
     virtual bool FlushDoc(wxDocument *doc);
     virtual wxDocTemplate *MatchTemplate(const wxString& path);
     virtual wxDocTemplate *SelectDocumentPath(wxDocTemplate **templates,

-            int noTemplates, wxString& path, long flags, bool save = FALSE);
+            int noTemplates, wxString& path, long flags, bool save = false);

     virtual wxDocTemplate *SelectDocumentType(wxDocTemplate **templates,
     virtual wxDocTemplate *SelectDocumentType(wxDocTemplate **templates,

-            int noTemplates, bool sort = FALSE);
+            int noTemplates, bool sort = false);

     virtual wxDocTemplate *SelectViewType(wxDocTemplate **templates,
     virtual wxDocTemplate *SelectViewType(wxDocTemplate **templates,

-            int noTemplates, bool sort = FALSE);
+            int noTemplates, bool sort = false);

     virtual wxDocTemplate *FindTemplateForPath(const wxString& path);
 
     void AssociateTemplate(wxDocTemplate *temp);
     virtual wxDocTemplate *FindTemplateForPath(const wxString& path);
 
     void AssociateTemplate(wxDocTemplate *temp);


@@ -371,14 +378,17 @@ public:
     void RemoveDocument(wxDocument *doc);
 
     // closes all currently open documents
     void RemoveDocument(wxDocument *doc);
 
     // closes all currently open documents

-    bool CloseDocuments(bool force = TRUE);
+    bool CloseDocuments(bool force = true);
+
+    // closes the specified document
+    bool CloseDocument(wxDocument* doc, bool force = false);

 
     // Clear remaining documents and templates
 
     // Clear remaining documents and templates

-    bool Clear(bool force = TRUE);
+    bool Clear(bool force = true);

 
     // Views or windows should inform the document manager
     // when a view is going in or out of focus
 
     // 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, bool deleting = FALSE);
+    virtual void ActivateView(wxView *view, bool activate = true);

     virtual wxView *GetCurrentView() const;
 
     wxList& GetDocuments() { return m_docs; }
     virtual wxView *GetCurrentView() const;
 
     wxList& GetDocuments() { return m_docs; }


@@ -396,7 +406,7 @@ public:
     // File history management
     virtual void AddFileToHistory(const wxString& file);
     virtual void RemoveFileFromHistory(size_t i);
     // File history management
     virtual void AddFileToHistory(const wxString& file);
     virtual void RemoveFileFromHistory(size_t i);

-    virtual size_t GetNoHistoryFiles() const;
+    virtual size_t GetHistoryFilesCount() const;

     virtual wxString GetHistoryFile(size_t i) const;
     virtual void FileHistoryUseMenu(wxMenu *menu);
     virtual void FileHistoryRemoveMenu(wxMenu *menu);
     virtual wxString GetHistoryFile(size_t i) const;
     virtual void FileHistoryUseMenu(wxMenu *menu);
     virtual void FileHistoryRemoveMenu(wxMenu *menu);


@@ -408,12 +418,17 @@ public:
     virtual void FileHistoryAddFilesToMenu();
     virtual void FileHistoryAddFilesToMenu(wxMenu* menu);
 
     virtual void FileHistoryAddFilesToMenu();
     virtual void FileHistoryAddFilesToMenu(wxMenu* menu);
 

-    inline wxString GetLastDirectory() const { return m_lastDirectory; }
-    inline void SetLastDirectory(const wxString& dir) { m_lastDirectory = dir; }
+    wxString GetLastDirectory() const { return m_lastDirectory; }
+    void SetLastDirectory(const wxString& dir) { m_lastDirectory = dir; }

 
     // Get the current document manager
     static wxDocManager* GetDocumentManager() { return sm_docManager; }
 
 
     // Get the current document manager
     static wxDocManager* GetDocumentManager() { return sm_docManager; }
 

+#if WXWIN_COMPATIBILITY_2_6
+    // deprecated, use GetHistoryFilesCount() instead
+    wxDEPRECATED( size_t GetNoHistoryFiles() const );
+#endif // WXWIN_COMPATIBILITY_2_6
+

 protected:
     long              m_flags;
     int               m_defaultDocumentNameCounter;
 protected:
     long              m_flags;
     int               m_defaultDocumentNameCounter;


@@ -426,9 +441,17 @@ protected:
     static wxDocManager* sm_docManager;
 
     DECLARE_EVENT_TABLE()
     static wxDocManager* sm_docManager;
 
     DECLARE_EVENT_TABLE()

+    DECLARE_DYNAMIC_CLASS(wxDocManager)

     DECLARE_NO_COPY_CLASS(wxDocManager)
 };
 
     DECLARE_NO_COPY_CLASS(wxDocManager)
 };
 

+#if WXWIN_COMPATIBILITY_2_6
+inline size_t wxDocManager::GetNoHistoryFiles() const
+{
+    return GetHistoryFilesCount();
+}
+#endif // WXWIN_COMPATIBILITY_2_6
+

 // ----------------------------------------------------------------------------
 // A default child frame
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // A default child frame
 // ----------------------------------------------------------------------------


@@ -445,7 +468,7 @@ public:
                     const wxSize& size = wxDefaultSize,
                     long type = wxDEFAULT_FRAME_STYLE,
                     const wxString& name = wxT("frame"));
                     const wxSize& size = wxDefaultSize,
                     long type = wxDEFAULT_FRAME_STYLE,
                     const wxString& name = wxT("frame"));

-    ~wxDocChildFrame();
+    ~wxDocChildFrame(){}

 
     // Extend event processing to search the view's event table
     virtual bool ProcessEvent(wxEvent& event);
 
     // Extend event processing to search the view's event table
     virtual bool ProcessEvent(wxEvent& event);


@@ -541,7 +564,7 @@ public:
     // Operations
     virtual void AddFileToHistory(const wxString& file);
     virtual void RemoveFileFromHistory(size_t i);
     // Operations
     virtual void AddFileToHistory(const wxString& file);
     virtual void RemoveFileFromHistory(size_t i);

-    virtual int GetMaxFiles() const { return m_fileMaxFiles; }
+    virtual int GetMaxFiles() const { return (int)m_fileMaxFiles; }

     virtual void UseMenu(wxMenu *menu);
 
     // Remove menu from the list (MDI child may be closing)
     virtual void UseMenu(wxMenu *menu);
 
     // Remove menu from the list (MDI child may be closing)


@@ -557,12 +580,14 @@ public:
 
     // Accessors
     virtual wxString GetHistoryFile(size_t i) const;
 
     // Accessors
     virtual wxString GetHistoryFile(size_t i) const;

-
-    // A synonym for GetNoHistoryFiles

     virtual size_t GetCount() const { return m_fileHistoryN; }
     virtual size_t GetCount() const { return m_fileHistoryN; }

-    size_t GetNoHistoryFiles() const { return m_fileHistoryN; }

 
 

-    wxList& GetMenus() const { return (wxList&) m_fileMenus; }
+    const wxList& GetMenus() const { return m_fileMenus; }
+
+#if WXWIN_COMPATIBILITY_2_6
+    // deprecated, use GetCount() instead
+    wxDEPRECATED( size_t GetNoHistoryFiles() const );
+#endif // WXWIN_COMPATIBILITY_2_6

 
 protected:
     // Last n files
 
 protected:
     // Last n files


@@ -573,7 +598,7 @@ protected:
     wxList            m_fileMenus;
     // Max files to maintain
     size_t            m_fileMaxFiles;
     wxList            m_fileMenus;
     // Max files to maintain
     size_t            m_fileMaxFiles;

-    
+

 private:
     // The ID of the first history menu item (Doesn't have to be wxID_FILE1)
     wxWindowID m_idBase;
 private:
     // The ID of the first history menu item (Doesn't have to be wxID_FILE1)
     wxWindowID m_idBase;


@@ -582,6 +607,13 @@ private:
     DECLARE_NO_COPY_CLASS(wxFileHistory)
 };
 
     DECLARE_NO_COPY_CLASS(wxFileHistory)
 };
 

+#if WXWIN_COMPATIBILITY_2_6
+inline size_t wxFileHistory::GetNoHistoryFiles() const
+{
+    return m_fileHistoryN;
+}
+#endif // WXWIN_COMPATIBILITY_2_6
+

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